AsyncAPI for payment service 0.0.1 documentation
The service publishes one of these messages below.
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"
}
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"
}
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"
}
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"
}
Name | Type | Description |
---|
paymentTaxConfig | object | - |
Name | Type | Description |
---|
configId | string | payment configuration ID |
taxJarEnable | boolean | - |
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
The service publishes one of these messages below.
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
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"
}
The service publishes one of these messages below.
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"
}
Name | Type | Description |
---|
paymentAccount | object | - |
Name | Type | Description |
---|
namespace | string | namespace |
userId | string | user id |
type | string | payment account type |
id | string | payment account id |
paymentProvider | string | payment provider |
Name | Type | Description |
---|
id | string | payment provider config id |
namespace | string | namespace |
region | string | region, * indicates all region |
paymentMerchantConfigId | string | payment merchant config id |
Name | Type | Description |
---|
id | string | payment merchant config id |
sandbox | boolean | sandbox or not |
Name | Type | Description |
---|
paymentOrderNo | string | Payment order number |
namespace | string | Payment order namespace |
userId | string | User id |
targetNamespace | string | The game namespace if it's an external in-game-purchase that resides in publisher namespace |
targetUserId | string | The user id in game namespace if it's an external in-game-purchase that resides in publisher namespace |
extOrderNo | string | External order number |
sku | string | optional, unique identity for the item |
extUserId | string | optional, external user id, can be the character id |
sandbox | boolean | isSandbox, indicate if order is sandbox |
price | integer (int32) | Payment order price |
paymentProvider | string | Payment provider |
region | string | Payment user region |
language | string | Payment user language |
currency | object | Payment order currency info |
status | string | Payment order status |
statusReason | string | Payment order status reason |
channel | string | Payment order channel: EXTERNAL or INTERNAL |
previousStatus | string | Payment order status before change |
Name | Type | Description |
---|
currencyCode | string | currency code |
currencySymbol | string | currency symbol |
currencyType | string | currency type |
namespace | string | namespace |
decimals | integer (int32) | decimals |
Name | Type | Description |
---|
id | string | event id |
version | integer | - |
name | string | event name |
namespace | string | event namespace |
parentNamespace | string | - |
timestamp | string (date-time) | - |
clientId | string | client id |
userId | string | the operator id |
traceId | string | trace id |
sessionId | string | session id |