Webhooks list

The type of notification is sent in the notification_type parameter.

Notification TypeDescription
order_paidNotification about getting the cart’s content when making a purchase.
order_canceledNotification 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.

ParameterTypeDescription
items
arrayList of items purchased by a user.
items.sku
stringItem’s unique ID. Items with the game_key type use the value in the sku_drm format.
items.type
stringItems type. It can have the following values: virtual_good, virtual_currency, game_key, physical_good.
items.quantity
integerQuantity of items.
items.amount
stringTotal cost of items that considers their quantity. May differ from the item’s price due to changes of currency rates and commission.
items.promotions
arrayApplied promotions. If the promotion wasn’t applied, an empty array is written to the parameter.
items.promotions.amount_without_discount
stringTotal cost of items without a discount.
items.promotions.amount_with_discount
stringTotal cost of items with a discount.
items.promotions.sequence
integerID of the applied promotion.
items.is_pre_order
stringIf true, the item is pre-order.
notification_type
stringNotification type. Required.
order
objectPayment information.
order.id
integerTransaction ID.
order.mode
stringPayment type. It can have the following values: default or sandbox.
order.currency_type
stringPayment type. It can have the following values: real for real currency or virtual for virtual currency.
order.currency
stringCurrency of order. Virtual currency uses the SKU and real currency uses a three-letter code per ISO 4217.
order.amount
stringThe total cost of a cart that considers a chosen currency.
order.status
stringOrder status.
order.platform
stringPayment 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
stringUser’s commentary to the order.
order.invoice_id
stringReal currency payments invoice ID. Virtual currency payments use the null value.
order.promotions
arrayApplied promotions. If the promotion wasn’t applied, an empty array is written to the parameter.
order.promotions.amount_without_discount
stringOrder total cost without a discount.
order.promotions.amount_with_discount
stringOrder total cost with a discount.
order.promotions.sequence
stringID of the applied promotion.
order.coupons
arrayApplied coupons. If the coupon isn’t applied, the array doesn’t return.
order.coupons.code
stringThe code of an applied coupon.
order.coupons.external_id
stringExternal ID.
order.promocodes
arrayApplied promocodes. If the promocode isn’t applied, the array doesn’t return.
order.promocodes.code
stringThe code of an applied promocode.
order.promocodes.external_id
stringExternal ID.
user
objectUser information.
user.external_id
stringUser ID.
user.email
stringUser email address.
custom_parameters
objectAdditional information.

When the user cancels the payment, Xsolla sends the order_canceled notification to the webhook URL.

ParameterTypeDescription
items
arrayList of items purchased by a user.
items.sku
stringItem’s unique ID. Items with the game_key type use the value in the sku_drm format.
items.type
stringItems type. It can have the following values: virtual_good, virtual_currency, game_key, physical_good.
items.quantity
integerQuantity of items.
items.amount
stringTotal cost of items that considers their quantity. May differ from the items price due to changes of currency rates and commission.
items.promotions
arrayApplied promotions. If the promotion wasnt applied, an empty array is written to the parameter.
items.promotions.amount_without_discount
stringTotal cost of items without a discount.
items.promotions.amount_with_discount
stringTotal cost of items with a discount.
items.promotions.sequence
integerID of the applied promotion.
items.is_pre_order
booleanIf true, the item is pre-order.
notification_type
stringNotification type. Required.
order
objectPayment information.
order.id
integerTransaction ID.
order.mode
stringPayment type. It can have the following values: default or sandbox.
order.currency_type
stringPayment type. It can have the following values: real for real currency or virtual for virtual currency.
order.currency
stringCurrency of order. Virtual currency uses the SKU and real currency uses a three-letter code per ISO 4217.
order.amount
stringThe total cost of a cart that considers a chosen currency.
order.status
stringOrder status.
order.platform
stringPayment 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
stringUsers commentary to the order.
order.invoice_id
stringReal currency payments invoice ID. Virtual currency payments use the null value.
order.promotions
arrayApplied promotions. If the promotion wasnt applied, an empty array is written to the parameter.
order.promotions.amount_without_discount
stringOrder total cost without a discount.
order.promotions.amount_with_discount
stringOrder total cost with a discount.
order.promotions.sequence
stringID of the applied promotion.
user
objectUser information.
user.external_id
stringUser ID.
user.email
stringUser email address.
custom_parameters
objectAdditional information.
Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
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
Is there anything we can improve?

Don’t want to answer

Thank you for your feedback!
Last updated: August 20, 2021

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!