Skip to main content

AsyncAPI for payment service 0.0.1 documentation

Published Messages (paymentConfig)

The service publishes one of these messages below.

paymentProviderConfigCreated

The event is triggered by creating payment provider configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentProviderConfigpaymentProviderConfig-

paymentProviderConfigUpdated

The event is triggered by updating payment provider configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentProviderConfigpaymentProviderConfig-

paymentProviderConfigDeleted

The event is triggered by deleting payment provider configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentProviderConfigpaymentProviderConfig-

paymentTaxConfigUpdated

The event is triggered by updating payment tax configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentTaxConfigobject-
payload.paymentTaxConfig
NameTypeDescription
configIdstringpayment configuration ID
taxJarEnableboolean-

adyenConfigUpdated

The event is triggered by updating Adyen configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

stripeConfigUpdated

The event is triggered by updating Stripe configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

xsollaConfigUpdated

The event is triggered by updating Xsolla configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

xsollaUIConfigUpdated

The event is triggered by updating Xsolla UI configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

payPalConfigUpdated

The event is triggered by updating PayPal configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

aliPayConfigUpdated

The event is triggered by updating Alipay configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

wxPayConfigUpdated

The event is triggered by updating WxPay configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

wxPayCertUploaded

The event is triggered by updating WxPay certificate configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

checkoutConfigUpdated

The event is triggered by updating checkout configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

neonPayConfigUpdated

The event is triggered by updating the Neon Pay Configuration. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentMerchantConfigpaymentMerchantConfig-

Published Messages (paymentOrderProcessing)

The service publishes one of these messages below.

paymentOrderCreated

The event is triggered by creating payment order. Payment order status will be INIT. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderCharged

The event is triggered when payment order was paid/charged. Payment order status will be CHARGED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderChargeFailed

The event is triggered when payment process has failed. Payment order status will be CHARGE_FAILED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderRefunded

The event is triggered when payment was refunded. Payment order status will be REFUNDED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderRefundFailed

The event is triggered when payment refund process was failed. Payment order status will be REFUND_FAILED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderAuthorised

The event is triggered when Adyen isAuthoriseAsCapture was set to false and payment order was authorised. Payment order status will be AUTHORISED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

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. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderNotificationOfChargeback

The event is triggered when notifying user of chargeback. Payment order status will be NOTIFICATION_OF_CHARGEBACK. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderRequestForInformation

The event is triggered when requesting for payment order information notification. Payment order status will be REQUEST_FOR_INFORMATION. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderChargeback

The event is triggered when payment chargeback process was successfull. Payment order status will be CHARGEBACK. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderChargebackReversed

The event is triggered when reverse chargeback process was successfull. Payment order status will be CHARGEBACK_REVERSED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

paymentOrderRefundRequested

The event is triggered when user is requesting for refund. Payment order status will be REFUNDING/REFUNDED/REFUND_FAILED. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentOrderpaymentOrder-

Published Messages (paymentAccount)

The service publishes one of these messages below.

paymentAccountDeleted

The event is triggered by deleting payment account. Contains fields from event and the following payload.

Example value
{
"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"
}

payload

NameTypeDescription
paymentAccountobject-
payload.paymentAccount
NameTypeDescription
namespacestringnamespace
userIdstringuser id
typestringpayment account type
idstringpayment account id
paymentProviderstringpayment provider

Schemas

paymentProviderConfig

NameTypeDescription
idstringpayment provider config id
namespacestringnamespace
regionstringregion, * indicates all region
paymentMerchantConfigIdstringpayment merchant config id

paymentMerchantConfig

NameTypeDescription
idstringpayment merchant config id
sandboxbooleansandbox or not

paymentOrder

NameTypeDescription
paymentOrderNostringPayment order number
namespacestringPayment order namespace
userIdstringUser id
targetNamespacestringThe game namespace if it's an external in-game-purchase that resides in publisher namespace
targetUserIdstringThe user id in game namespace if it's an external in-game-purchase that resides in publisher namespace
extOrderNostringExternal order number
skustringoptional, unique identity for the item
extUserIdstringoptional, external user id, can be the character id
sandboxbooleanisSandbox, indicate if order is sandbox
priceinteger (int32)Payment order price
paymentProviderstringPayment provider
regionstringPayment user region
languagestringPayment user language
currencyobjectPayment order currency info
statusstringPayment order status
statusReasonstringPayment order status reason
channelstringPayment order channel: EXTERNAL or INTERNAL
previousStatusstringPayment order status before change

currency

NameTypeDescription
currencyCodestringcurrency code
currencySymbolstringcurrency symbol
currencyTypestringcurrency type
namespacestringnamespace
decimalsinteger (int32)decimals

event

NameTypeDescription
idstringevent id
versioninteger-
namestringevent name
namespacestringevent namespace
parentNamespacestring-
timestampstring (date-time)-
clientIdstringclient id
userIdstringthe operator id
traceIdstringtrace id
sessionIdstringsession id