AsyncAPI for payment service 0.0.1 documentation

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

Operations

Operations

PUB `paymentConfig` Operation

Accepts one of the following messages:

Message `paymentProviderConfigCreated`

message is sent when payment provider config is created

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	-	-	-
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	-	-	-

{
  "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`

message is sent when payment provider config is updated

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	-	-	-
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	-	-	-

{
  "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`

message is sent when payment provider config is deleted

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	-	-	-
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	-	-	-

{
  "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`

message is sent when payment tax config is updated

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	-	-	-	-
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	-	-	-

{
  "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`

message is sent when adyen config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when stripe config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when xsolla config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when xsolla UI config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when paypal config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when ali pay config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when wx pay config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

message is sent when wx pay cert config is updated

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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

update 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	sanbox or not	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

payment order status will be AUTHORISED(it only occurs when adyen isAuthoriseAsCapture false)

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	-	-	-
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	-	-	-

{
  "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`

payment order status will be AUTHORISE_FAILED(it only occurs when adyen isAuthoriseAsCapture false)

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

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	-	-	-
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	-	-	-

{
  "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`

payment order status will be REFUNDING/REFUNDED/REFUND_FAILED after refund requested

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	-	-	-
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	-	-	-

{
  "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`

payment account deleted

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"`)	-	-
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	-	-	-

{
  "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	-	-

AsyncAPI for payment service 0.0.1 documentation

Table of Contents​

Operations​

PUB paymentConfig Operation​

Message paymentProviderConfigCreated​

Payload​

Message paymentProviderConfigUpdated​

Payload​

Message paymentProviderConfigDeleted​

Payload​

Message paymentTaxConfigUpdated​

Payload​

Message adyenConfigUpdated​

Payload​

Message stripeConfigUpdated​

Payload​

Message xsollaConfigUpdated​

Payload​

Message xsollaUIConfigUpdated​

Payload​

Message payPalConfigUpdated​

Payload​

Message aliPayConfigUpdated​

Payload​

Message wxPayConfigUpdated​

Payload​

Message wxPayCertUploaded​

Payload​

Message checkoutConfigUpdated​

Payload​

PUB paymentOrderProcessing Operation​

Message paymentOrderCreated​

Payload​

Message tags​

Message paymentOrderCharged​

Payload​

Message tags​

Message paymentOrderChargeFailed​

Payload​

Message tags​

Message paymentOrderRefunded​

Payload​

Message tags​

Message paymentOrderRefundFailed​

Payload​

Message tags​

Message paymentOrderAuthorised​

Payload​

Message tags​

Message paymentOrderAuthorisedFailed​

Payload​

Message tags​

Message paymentOrderNotificationOfChargeback​

Payload​

Message tags​

Message paymentOrderRequestForInformation​

Payload​

Message tags​

Message paymentOrderChargeback​

Payload​

Message tags​

Message paymentOrderChargebackReversed​

Payload​

Message tags​

Message paymentOrderRefundRequested​

Payload​

Message tags​

PUB paymentAccount Operation​

Message paymentAccountDeleted​

Payload​

Message tags​

On this page

Table of Contents

Operations

PUB `paymentConfig` Operation

Message `paymentProviderConfigCreated`

Payload

Message `paymentProviderConfigUpdated`

Payload

Message `paymentProviderConfigDeleted`

Payload

Message `paymentTaxConfigUpdated`

Payload

Message `adyenConfigUpdated`

Payload

Message `stripeConfigUpdated`

Payload

Message `xsollaConfigUpdated`

Payload

Message `xsollaUIConfigUpdated`

Payload

Message `payPalConfigUpdated`

Payload

Message `aliPayConfigUpdated`

Payload

Message `wxPayConfigUpdated`

Payload

Message `wxPayCertUploaded`

Payload

Message `checkoutConfigUpdated`

Payload

PUB `paymentOrderProcessing` Operation

Message `paymentOrderCreated`

Payload

Message tags

Message `paymentOrderCharged`

Payload

Message tags

Message `paymentOrderChargeFailed`

Payload

Message tags

Message `paymentOrderRefunded`

Payload

Message tags

Message `paymentOrderRefundFailed`

Payload

Message tags

Message `paymentOrderAuthorised`

Payload

Message tags

Message `paymentOrderAuthorisedFailed`

Payload

Message tags

Message `paymentOrderNotificationOfChargeback`

Payload

Message tags

Message `paymentOrderRequestForInformation`

Payload

Message tags

Message `paymentOrderChargeback`

Payload

Message tags

Message `paymentOrderChargebackReversed`

Payload

Message tags

Message `paymentOrderRefundRequested`

Payload

Message tags

PUB `paymentAccount` Operation

Message `paymentAccountDeleted`

Payload

Message tags