Xsolla sends the order_canceled
webhook to the specified URL when the following conditions are fulfilled:
refund
webhook.The order_canceled
webhook contains information about returned items and details of the canceled transaction.
The order_canceled
webhook will not be sent if:
refund
webhook has not been received.It is recommended that the processing speed of the order_canceled
webhook is less than 3 seconds.
notification_type required | string Type of notification. | ||||||||||||||||||||||||||||||||||||||
required | Array of objects List of items purchased by the user. | ||||||||||||||||||||||||||||||||||||||
Array | |||||||||||||||||||||||||||||||||||||||
required | object Information about the order. | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
required | object User information. | ||||||||||||||||||||||||||||||||||||||
custom_parameters | object Additional information. |
Return to indicate successful processing.
Return in case of an error in the provided information (e.g., a required parameter missing, failed authorization, etc.).
{- "notification_type": "string",
- "items": [
- {
- "sku": "string",
- "type": "virtual_good",
- "quantity": 0,
- "amount": "string",
- "promotions": [
- {
- "amount_without_discount": "string",
- "amount_with_discount": "string",
- "sequence": 0
}
], - "is_pre_order": true,
- "custom_attributes": null
}
], - "order": {
- "id": 0,
- "mode": "default",
- "currency_type": "real",
- "currency": "string",
- "amount": "string",
- "status": "string",
- "platform": "xsolla",
- "comment": "string",
- "invoice_id": "string",
- "promotions": [
- {
- "amount_without_discount": "string",
- "amount_with_discount": "string",
- "sequence": 0
}
], - "coupons": [
- {
- "code": "string",
- "external_id": "string"
}
], - "promocodes": [
- {
- "code": "string",
- "external_id": "string"
}
]
}, - "user": {
- "external_id": "string",
- "email": "string"
}, - "custom_parameters": { }
}