Sent whenever a payment is canceled. Includes payment details. Learn more about a refund process in the instruction.
Refund codes:
Code | Reason | Description |
---|---|---|
1 | Cancellation by the user request / the game request | Cancellation initiated from Publisher Account. |
2 | Chargeback | Transaction chargeback requested. |
3 | Integration error | Issues in integration between Xsolla and the game. Recommendation: Do not add the user to blocklist. |
4 | Potential fraud | Fraud suspected. Recommendation: Add the user to blocklist. |
5 | Test payment | Test transaction followed by cancellation. Recommendation: Do not add the user to blocklist. |
6 | User invoice expired | Invoice overdue (used for postpaid model). |
7 | Fraud notification from PS | Payment refused by payment system. Potential fraud detected by PS. Recommendation: Add the user to blocklist. |
8 | Cancellation by the PS request | Cancellation requested by payment system. Recommendation: Do not add the user to blocklist. |
9 | Cancellation by the user request | The user was not satisfied with the game or the purchase for any reason. Recommendation: Do not add the user to blocklist. |
10 | Cancellation by the game request | Cancellation requested by the game. Recommendation: Do not add the user to blocklist. |
11 | Account holder called to report fraud | The account owner states that they didn’t make the transaction. |
12 | Friendly fraud | Friendly fraud reported. |
13 | Duplicate | Duplicate transaction for the same invoice. |
notification_type required | string Type of notification. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object Transaction details (object). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object Payment details (object). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Custom project settings (object). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object User details (object). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Purchase details (object). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Refund details (object). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
custom_parameters | object Your custom parameters. |
Return to indicate successful processing.
Return in case of an error in the provided information (e.g., a required parameter missing, failed authorization, etc.).
Return to indicate temporary errors with your servers.
{- "notification_type": "string",
- "settings": {
- "project_id": 0,
- "merchant_id": 0
}, - "user": {
- "ip": "string",
- "phone": "string",
- "email": "string",
- "id": "string",
- "name": "string",
- "country": "string",
- "zip": "string"
}, - "purchase": {
- "virtual_currency": {
- "name": "string",
- "quantity": 0,
- "currency": "string",
- "amount": 0
}, - "checkout": {
- "currency": "string",
- "amount": 0
}, - "subscription": {
- "plan_id": "string",
- "subscription_id": 0,
- "tags": [
- "string"
], - "date_create": "string",
- "currency": "string",
- "amount": 0
}, - "virtual_items": {
- "items": [
- {
- "sku": "string",
- "amount": 0
}
], - "currency": "string",
- "amount": 0
}, - "pin_codes": {
- "upgrade": {
- "digital_content_from": {
- "digital_content": "string",
- "DRM": "string"
}, - "digital_content_to": {
- "digital_content": "string",
- "DRM": "string"
}, - "currency": "string",
- "amount": 0
}
}, - "total": {
- "currency": "string",
- "amount": 0
}
}, - "transaction": {
- "id": 0,
- "external_id": "string",
- "payment_method_order_id": "string",
- "dry_run": 0,
- "agreement": 0
}, - "refund_details": {
- "code": 0,
- "reason": "string",
- "author": "string"
}, - "payment_details": {
- "payment": {
- "currency": "string",
- "amount": 0
}, - "payment_method_sum": {
- "currency": "string",
- "amount": 0
}, - "xsolla_balance_sum": {
- "currency": "string",
- "amount": 0
}, - "payout": {
- "currency": "string",
- "amount": 0
}, - "vat": {
- "currency": "string",
- "amount": 0,
- "percent": 0
}, - "payout_currency_rate": 0,
- "xsolla_fee": {
- "currency": "string",
- "amount": 0
}, - "payment_method_fee": {
- "currency": "string",
- "amount": 0
}, - "sales_tax": {
- "currency": "string",
- "amount": 0,
- "percent": 0
}, - "direct_wht": {
- "currency": "string",
- "amount": 0,
- "percent": 0
}, - "repatriation_commission": {
- "currency": "string",
- "amount": 0
}
}, - "custom_parameters": { }
}
{- "error": {
- "code": "INVALID_USER",
- "message": "Invalid user"
}
}