Частичный возврат платежа

Частичный возврат платежаWebhook POST

При частичном возврате платежа Иксолла присылает детали отмененной транзакции на URL-адрес вебхука. Подробная информация о процессе частичного возврата платежа приведена в инструкции.

Коды отмены:

Код	Причина отмены	Описание
1	Cancellation by the user request / the game request	Используется, если отмена произошла из Личного кабинета.
3	Integration error	Используется в случае проблем с интеграцией между Иксоллой и игрой. В этом случае мы не рекомендуем заносить пользователя в черный список.
5	Test payment	Используется в случае совершения тестового платежа с последующей отменой. В этом случае мы не рекомендуем заносить пользователя в черный список.
7	Fraud notification from PS	Используется, если платежная система не произвела выплату по транзакции из-за потенциального фрода. В этом случае мы рекомендуем добавить пользователя в черный список.
9	Cancellation by the user request	Используется, если игра или заказ не удовлетворяют требованиям пользователя по каким-либо причинам. В этом случае мы не рекомендуем заносить пользователя в черный список.
10	Cancellation by the game request	Используется, когда игра просит отменить транзакцию. В этом случае мы не рекомендуем заносить пользователя в черный список.

Request

Request Body schema: application/json

notification_type

required

string

Тип оповещения.

required

object

Объект с информацией о транзакции, связанной с этой операцией.

agreement	integer ID соглашения.
date	string Дата транзакции.
dry_run	integer Признак тестовой транзакции. Значение параметра равно 1 для тестового платежа, для реального платежа параметр не передается.
external_id	string Внешний ID транзакции.
id	integer ID транзакции.

required

object

Объект с финансовыми данными платежа.

object

Налог, удерживаемый у источника выплаты.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
percent	integer <float> Процент налога, удерживаемого у источника выплаты.

object

Объект с данными о сумме, которую оплатил пользователь.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Размер комиссии платежной системы.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Объект с данными о сумме, которая была оплачена из платежной системы.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Объект с данными о сумме выплаты.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

payout_currency_rate

integer <float>

Курс валюты платежа к валюте выплаты.

object

Объект с информацией о затратах на репатриацию, возлагаемых на Иксоллу третьими сторонами.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Размер налога (только для США и Канады).

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
percent	integer <float> Процент налога.

object

Размер VAT (только для Евросоюза).

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
percent	integer <float> Процент VAT.

object

Объект с данными о сумме, которая была оплачена с Иксолла-баланса.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Размер комиссии Иксоллы.

amount	integer <float> Сумма.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

custom_parameters

object

Ваши дополнительные параметры.

object

Объект с информацией о заказе.

required

object

Объект с данными об общей стоимости покупки.

amount	integer <float> Сумма частичного возврата платежа.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Объект с информацией о заказе.

amount	integer <float> Сумма заказа.
currency	string Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Deprecated

Массив с данными о ключах.

object

Объект с информацией об апгрейде.

amount

integer <float>

Deprecated

Сумма покупки.

currency

string

Deprecated

Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

object

Deprecated

Объект с информацией о пакете пользователя, с которого был произведен апгрейд.

DRM	string Deprecated DRM-платформа игры.
digital_content	string Deprecated Артикул игры, настраивается в Личном кабинете.

object

Deprecated

Объект с информацией о пакете, на который пользователь перешел в рамках апгрейда.

DRM	string Deprecated DRM-платформа игры.
digital_content	string Deprecated Артикул игры, настраивается в Личном кабинете.

object

Deprecated

Объект с данными о приобретенной виртуальной валюте.

amount	integer <float> Deprecated Сумма покупки.
currency	string Deprecated Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.
name	string Deprecated Название виртуальной валюты.
quantity	integer <float> Deprecated Количество бонусного товара.

object

Deprecated

Объект с данными о предметах в покупке.

amount

integer <float>

Deprecated

Сумма заказа.

currency

string

Deprecated

Валюта. Используется трехбуквенное обозначение валюты согласно стандарту ISO 4217.

Array of objects

Deprecated

Array

amount	integer <float> Deprecated Количество этого предмета в заказе.
sku	string Deprecated ID предмета (артикул).

object

Объект с финансовыми данными рефанда.

author

string

Инициатор возврата платежа. Значение поля передается согласно таблице:

Инициатор возврата	Значение поля
Игра (через API).	API
Пользователь Личного кабинета (автоматический возврат).	Email-адрес пользователя
Пользователь Личного кабинета (при участии службы поддержки Иксоллы).	support@xsolla.com
Xsolla (при участии службы поддержки Иксоллы).	support@xsolla.com

code

integer

ID кода.

date

string

Дата возврата платежа.

reason

string

Причина отмены.

object

Объект, содержащий настройки проекта.

merchant_id	integer ID продавца.
project_id	integer ID игры в Иксолле. Вы можете найти этот параметр в Личном кабинете.

object

Объект с информацией о пользователе.

id required	string ID пользователя.
country	string Страна пользователя. Используется двухбуквенное обозначение страны согласно стандарту ISO 3166-1 alpha-2.
email	string Email пользователя.
ip	string IP адрес пользователя.
name	string Имя пользователя
phone	string Номер телефона пользователя (в международном формате).
zip	string Почтовый индекс.

Responses

204

Верните, чтобы сообщить об успешной обработке вехбука.

400

Верните в случае ошибки в предоставленной информации (например, обязательный параметр не передан, или авторизация не прошла).

500

Верните, чтобы сообщить о временных ошибках на ваших серверах.

Request samples

Payload
CURL
PHP
HTTP

application/json

{"custom_parameters": { },
"notification_type": "string",
"payment_details": {"direct_wht": {"amount": 0,
"currency": "string",
"percent": 0
},
"payment": {"amount": 0,
"currency": "string"
},
"payment_method_fee": {"amount": 0,
"currency": "string"
},
"payment_method_sum": {"amount": 0,
"currency": "string"
},
"payout": {"amount": 0,
"currency": "string"
},
"payout_currency_rate": 0,
"repatriation_commission": {"amount": 0,
"currency": "string"
},
"sales_tax": {"amount": 0,
"currency": "string",
"percent": 0
},
"vat": {"amount": 0,
"currency": "string",
"percent": 0
},
"xsolla_balance_sum": {"amount": 0,
"currency": "string"
},
"xsolla_fee": {"amount": 0,
"currency": "string"
}
},
"purchase": {"checkout": {"amount": 0,
"currency": "string"
},
"pin_codes": {"upgrade": {"amount": 0,
"currency": "string",
"digital_content_from": {"DRM": "string",
"digital_content": "string"
},
"digital_content_to": {"DRM": "string",
"digital_content": "string"
}
}
},
"total": {"amount": 0,
"currency": "string"
},
"virtual_currency": {"amount": 0,
"currency": "string",
"name": "string",
"quantity": 0
},
"virtual_items": {"amount": 0,
"currency": "string",
"items": [{"amount": 0,
"sku": "string"
}
]
}
},
"refund_details": {"author": "string",
"code": 0,
"date": "string",
"reason": "string"
},
"settings": {"merchant_id": 0,
"project_id": 0
},
"transaction": {"agreement": 0,
"date": "string",
"dry_run": 0,
"external_id": "string",
"id": 0
},
"user": {"country": "string",
"email": "string",
"id": "string",
"ip": "string",
"name": "string",
"phone": "string",
"zip": "string"
}
}

Response samples

application/json

{"error": {"code": "INCORRECT_AMOUNT",
"message": "Incorrect amount"
}
}