AsyncAPI for payment service 0.0.1 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

• Specification ID: urn:net:accelbyte:platform:payment
• Protobuf File Spec: payment.proto
• Default content type: application/json

Table of Contents

• Operations
  • PUB paymentConfig
  • PUB paymentOrderProcessing
  • PUB paymentAccount

Operations

PUB paymentConfig Operation

Accepts one of the following messages:

Message paymentProviderConfigCreated

The event is triggered by creating payment provider configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig.id	string	payment provider config id	-	-	-
payload.paymentProviderConfig.namespace	string	namespace	-	-	-
payload.paymentProviderConfig.region	string	region, * indicates all region	-	-	-
payload.paymentProviderConfig.paymentMerchantConfigId	string	payment merchant config id	-	-	-
payload.x-uid0	-	-	"AnonymousSchema1"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentProviderConfig": {
      "id": "string",
      "namespace": "string",
      "region": "string",
      "paymentMerchantConfigId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message paymentProviderConfigUpdated

The event is triggered by updating payment provider configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig.id	string	payment provider config id	-	-	-
payload.paymentProviderConfig.namespace	string	namespace	-	-	-
payload.paymentProviderConfig.region	string	region, * indicates all region	-	-	-
payload.paymentProviderConfig.paymentMerchantConfigId	string	payment merchant config id	-	-	-
payload.x-uid0	-	-	"AnonymousSchema2"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentProviderConfig": {
      "id": "string",
      "namespace": "string",
      "region": "string",
      "paymentMerchantConfigId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message paymentProviderConfigDeleted

The event is triggered by deleting payment provider configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig	object	-	-	-	additional properties are allowed
payload.paymentProviderConfig.id	string	payment provider config id	-	-	-
payload.paymentProviderConfig.namespace	string	namespace	-	-	-
payload.paymentProviderConfig.region	string	region, * indicates all region	-	-	-
payload.paymentProviderConfig.paymentMerchantConfigId	string	payment merchant config id	-	-	-
payload.x-uid0	-	-	"AnonymousSchema3"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentProviderConfig": {
      "id": "string",
      "namespace": "string",
      "region": "string",
      "paymentMerchantConfigId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message paymentTaxConfigUpdated

The event is triggered by updating payment tax configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentTaxConfig	object	-	-	-	additional properties are allowed
payload.paymentTaxConfig.configId	string	payment configuration ID	-	-	-
payload.paymentTaxConfig.taxJarEnable	boolean	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema4"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentTaxConfig": {
      "configId": "string",
      "taxJarEnable": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message adyenConfigUpdated

The event is triggered by updating Adyen configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema10"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message stripeConfigUpdated

The event is triggered by updating Stripe configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema11"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message xsollaConfigUpdated

The event is triggered by updating Xsolla configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema5"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message xsollaUIConfigUpdated

The event is triggered by updating Xsolla UI configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema6"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message payPalConfigUpdated

The event is triggered by updating PayPal configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema12"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message aliPayConfigUpdated

The event is triggered by updating Alipay configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema7"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message wxPayConfigUpdated

The event is triggered by updating WxPay configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema8"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message wxPayCertUploaded

The event is triggered by updating WxPay certificate configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema9"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message checkoutConfigUpdated

The event is triggered by updating checkout configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema26"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message neonPayConfigUpdated

The event is triggered by updating the Neon Pay Configuration.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig	object	-	-	-	additional properties are allowed
payload.paymentMerchantConfig.id	string	payment merchant config id	-	-	-
payload.paymentMerchantConfig.sandbox	boolean	sandbox or not	-	-	-
payload.x-uid0	-	-	"AnonymousSchema27"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentMerchantConfig": {
      "id": "string",
      "sandbox": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

PUB paymentOrderProcessing Operation

Accepts one of the following messages:

Message paymentOrderCreated

The event is triggered by creating payment order. Payment order status will be INIT.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema13"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
WALLET	-	-
XSOLLA	-	-
ADYEN	-	-
ALIPAY	-	-
WXPAY	-	-
PAYPAL	-	-

Message paymentOrderCharged

The event is triggered when payment order was paid/charged. Payment order status will be CHARGED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema14"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
WALLET	-	-
XSOLLA	-	-
ADYEN	-	-
ALIPAY	-	-
WXPAY	-	-
PAYPAL	-	-

Message paymentOrderChargeFailed

The event is triggered when payment process has failed. Payment order status will be CHARGE_FAILED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema15"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-
WXPAY	-	-
PAYPAL	-	-

Message paymentOrderRefunded

The event is triggered when payment was refunded. Payment order status will be REFUNDED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema16"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
WALLET	-	-
XSOLLA	-	-
ADYEN	-	-
ALIPAY	-	-
WXPAY	-	-
PAYPAL	-	-

Message paymentOrderRefundFailed

The event is triggered when payment refund process was failed. Payment order status will be REFUND_FAILED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema17"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-
WXPAY	-	-

Message paymentOrderAuthorised

The event is triggered when Adyen isAuthoriseAsCapture was set to false and payment order was authorised. Payment order status will be AUTHORISED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema18"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-

Message paymentOrderAuthorisedFailed

The event is triggered when Adyen isAuthoriseAsCapture was set to false and payment order failed to authorise. Payment order status will be AUTHORISE_FAILED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema19"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-

Message paymentOrderNotificationOfChargeback

The event is triggered when notifying user of chargeback. Payment order status will be NOTIFICATION_OF_CHARGEBACK.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema20"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-

Message paymentOrderRequestForInformation

The event is triggered when requesting for payment order information notification. Payment order status will be REQUEST_FOR_INFORMATION

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema21"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-

Message paymentOrderChargeback

The event is triggered when payment chargeback process was successfull. Payment order status will be CHARGEBACK.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema22"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
XSOLLA	-	-
ADYEN	-	-
PAYPAL	-	-

Message paymentOrderChargebackReversed

The event is triggered when reverse chargeback process was successfull. Payment order status will be CHARGEBACK_REVERSED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema23"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
ADYEN	-	-

Message paymentOrderRefundRequested

The event is triggered when user is requesting for refund. Payment order status will be REFUNDING/REFUNDED/REFUND_FAILED.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentOrder	object	-	-	-	additional properties are allowed
payload.paymentOrder.paymentOrderNo	string	Payment order number	-	-	-
payload.paymentOrder.namespace	string	Payment order namespace	-	-	-
payload.paymentOrder.userId	string	User id	-	-	-
payload.paymentOrder.targetNamespace	string	The game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.targetUserId	string	The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace	-	-	-
payload.paymentOrder.extOrderNo	string	External order number	-	-	-
payload.paymentOrder.sku	string	optional, unique identity for the item	-	-	-
payload.paymentOrder.extUserId	string	optional, external user id, can be the character id	-	-	-
payload.paymentOrder.sandbox	boolean	isSandbox, indicate if order is sandbox	-	-	-
payload.paymentOrder.price	integer	Payment order price	-	format (int32)	-
payload.paymentOrder.paymentProvider	string	Payment provider	-	-	-
payload.paymentOrder.region	string	Payment user region	-	-	-
payload.paymentOrder.language	string	Payment user language	-	-	-
payload.paymentOrder.currency	object	Payment order currency info	-	-	additional properties are allowed
payload.paymentOrder.currency.currencyCode	string	currency code	-	-	-
payload.paymentOrder.currency.currencySymbol	string	currency symbol	-	-	-
payload.paymentOrder.currency.currencyType	string	currency type	allowed ("REAL", "VIRTUAL")	-	-
payload.paymentOrder.currency.namespace	string	namespace	-	-	-
payload.paymentOrder.currency.decimals	integer	decimals	-	format (int32)	-
payload.paymentOrder.status	string	Payment order status	-	-	-
payload.paymentOrder.statusReason	string	Payment order status reason	-	-	-
payload.paymentOrder.channel	string	Payment order channel: EXTERNAL or INTERNAL	-	-	-
payload.paymentOrder.previousStatus	string	Payment order status before change	-	-	-
payload.x-uid0	-	-	"AnonymousSchema24"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentOrder": {
      "paymentOrderNo": "string",
      "namespace": "string",
      "userId": "string",
      "targetNamespace": "string",
      "targetUserId": "string",
      "extOrderNo": "string",
      "sku": "string",
      "extUserId": "string",
      "sandbox": true,
      "price": 0,
      "paymentProvider": "string",
      "region": "string",
      "language": "string",
      "currency": {
        "currencyCode": "string",
        "currencySymbol": "string",
        "currencyType": "REAL",
        "namespace": "string",
        "decimals": 0
      },
      "status": "string",
      "statusReason": "string",
      "channel": "string",
      "previousStatus": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
WALLET	-	-
XSOLLA	-	-
ADYEN	-	-
ALIPAY	-	-
WXPAY	-	-
PAYPAL	-	-

PUB paymentAccount Operation

Message paymentAccountDeleted

The event is triggered by deleting payment account.

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.paymentAccount	object	-	-	-	additional properties are allowed
payload.paymentAccount.namespace	string	namespace	-	-	-
payload.paymentAccount.userId	string	user id	-	-	-
payload.paymentAccount.type	string	payment account type	allowed ("card", "paypal")	-	-
payload.paymentAccount.id	string	payment account id	-	-	-
payload.paymentAccount.paymentProvider	string	payment provider	allowed ("WALLET", "XSOLLA", "ADYEN", "STRIPE", "CHECKOUT", "ALIPAY", "WXPAY", "PAYPAL", "NEONPAY")	-	-
payload.x-uid0	-	-	"AnonymousSchema25"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	event id	-	-	-
version	integer	-	-	-	-
name	string	event name	-	-	-
namespace	string	event namespace	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	client id	-	-	-
userId	string	the operator id	-	-	-
traceId	string	trace id	-	-	-
sessionId	string	session id	-	-	-

Examples of payload (generated)

{
  "payload": {
    "paymentAccount": {
      "namespace": "string",
      "userId": "string",
      "type": "card",
      "id": "string",
      "paymentProvider": "WALLET"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message tags

Name	Description	Documentation
XSOLLA	-	-
ADYEN	-	-