Webhooks list
The type of notification is sent in the notification_type parameter.
| Notification type | Description |
|---|---|
| order_paid | Notification about getting the cart’s content when making a purchase. |
| order_canceled | Notification about payment cancellation. |
When the user confirms the cart’s content when making a purchase, Xsolla sends the order_paid notification to the webhook URL.
| Parameter | Type | Description |
|---|---|---|
| array | List of items purchased by a user. |
items.sku | string | Item’s unique ID. Items with the game_key type use the value in the sku_drm format. |
items.type | string | Items type. It can have the following values: virtual_good, virtual_currency, game_key, physical_good. |
items.quantity | integer | Quantity of items. |
items.amount | string | Total cost of items that considers their quantity. May differ from the item’s price due to changes of currency rates and commission. |
items.promotions | array | Applied promotions. If the promotion wasn’t applied, an empty array is written to the parameter. |
items.promotions.amount_without_discount | string | Total cost of items without a discount. |
items.promotions.amount_with_discount | string | Total cost of items with a discount. |
items.promotions.sequence | integer | ID of the applied promotion. |
items.is_pre_order | boolean | If true, the item is pre-order. |
notification_type | string | Notification type. Required. |
| object | Payment information. |
order.id | integer | The order’s unique identifier on Xsolla’s side, related to user purchase. |
order.mode | string | Payment type. It can have the following values: default or sandbox. |
order.currency_type | string | Payment type. It can have the following values: real for real currency or virtual for virtual currency. |
order.currency | string | Currency of order. Virtual currency uses the SKU and real currency uses a three-letter code per |
order.amount | string | The total cost of a cart that considers a chosen currency. |
order.status | string | Order status. |
order.platform | string | Payment platform. The xsolla value is used for payments via Xsolla. Other payments use the value that corresponds with the name of the integrated payment system. |
order.comment | string | User’s commentary to the order. |
order.invoice_id | string | Real currency payments invoice ID. Virtual currency payments or free items have a null value. |
order.promotions | array | Applied promotions. If the promotion wasn’t applied, an empty array is written to the parameter. |
order.promotions.amount_without_discount | string | Order total cost without a discount. |
order.promotions.amount_with_discount | string | Order total cost with a discount. |
order.promotions.sequence | string | ID of the applied promotion. |
order.coupons | array | Applied coupons. If the coupon isn’t applied, the array doesn’t return. |
order.coupons.code | string | The code of an applied coupon. |
order.coupons.external_id | string | External ID. |
order.promocodes | array | Applied promocodes. If the promocode isn’t applied, the array doesn’t return. |
order.promocodes.code | string | The code of an applied promocode. |
order.promocodes.external_id | string | External ID. |
| object | User information. |
user.external_id | string | User ID. |
user.email | string | User email address. |
custom_parameters | object | Additional information. |
When the user cancels the payment, Xsolla sends the order_canceled notification to the webhook URL.
| Parameter | Type | Description |
|---|---|---|
| array | List of items purchased by a user. |
items.sku | string | Item’s unique ID. Items with the game_key type use the value in the sku_drm format. |
items.type | string | Items type. It can have the following values: virtual_good, virtual_currency, game_key, physical_good. |
items.quantity | integer | Quantity of items. |
items.amount | string | Total cost of items that considers their quantity. May differ from the items price due to changes of currency rates and commission. |
items.promotions | array | Applied promotions. If the promotion wasn’t applied, an empty array is written to the parameter. |
items.promotions.amount_without_discount | string | Total cost of items without a discount. |
items.promotions.amount_with_discount | string | Total cost of items with a discount. |
items.promotions.sequence | integer | ID of the applied promotion. |
items.is_pre_order | boolean | If true, the item is pre-order. |
notification_type | string | Notification type. Required. |
| object | Payment information. |
order.id | integer | The order’s unique identifier on Xsolla’s side, related to user purchase. |
order.mode | string | Payment type. It can have the following values: default or sandbox. |
order.currency_type | string | Payment type. It can have the following values: real for real currency or virtual for virtual currency. |
order.currency | string | Currency of order. Virtual currency uses the SKU and real currency uses a three-letter code per |
order.amount | string | The total cost of a cart that considers a chosen currency. |
order.status | string | Order status. |
order.platform | string | Payment platform. The xsolla value is used for payments via Xsolla. Other payments use the value that corresponds with the name of the integrated payment system. |
order.comment | string | Users commentary to the order. |
order.invoice_id | string | Real currency payments invoice ID. Virtual currency payments use the null value. |
order.promotions | array | Applied promotions. If the promotion wasn’t applied, an empty array is written to the parameter. |
order.promotions.amount_without_discount | string | Order total cost without a discount. |
order.promotions.amount_with_discount | string | Order total cost with a discount. |
order.promotions.sequence | string | ID of the applied promotion. |
| object | User information. |
user.external_id | string | User ID. |
user.email | string | User email address. |
custom_parameters | object | Additional information. |
Was this article helpful?
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.Rate this page
Rate this page
Don’t want to answer
Thank you for your feedback!
Found a typo or other text error? Select the text and press Ctrl+Enter.
