Формат уведомления REFUND
- Signature: XXX
- Accept: application/json
- Content-type: application/json
Параметры тела уведомления
Поле |
Описание |
Тип |
В каких случаях используется |
type |
Тип уведомления — только REFUND |
string |
Всегда |
version |
Notification version |
string |
Всегда |
refund |
Описание возврата |
object |
Всегда |
Формат объекта refund
Поле |
Описание |
Тип |
В каких случаях используется |
type |
Тип операции — только REFUND |
string(200) |
Всегда |
paymentId |
Идентификатор платежа в системе ТСП |
string(200) |
Всегда |
refundId |
Идентификатор возврата в системе ТСП |
string(200) |
Всегда |
createdDateTime |
Дата создания операции |
URL-закодированная строкаГГГГ-ММ-ДДTчч:мм:ссZ |
Всегда |
amount |
Информация о сумме операции |
object |
Всегда |
billId |
Идентификатор счёта, соответствующего операции |
string(200) |
Всегда |
status |
Информация о статусе операции |
object |
Всегда |
paymentMethod |
Информация о средстве платежа |
object |
Всегда |
merchantSiteUid |
Строковый идентификатор сайта ТСП в QIWI Кассе |
string |
Всегда |
customer |
Информация о покупателе |
object |
Всегда |
customFields |
Поля с произвольной информацией, дополняющей данные по операции |
object |
Всегда |
flags |
Дополнительные команды, переданные в API |
Массив. Возможные элементы: SALE , REVERSAL |
Всегда |
settlementAmount |
Сведения о сумме расчёта с мерчантом |
object |
Если валюта платежа и расчёта с мерчантом различаются |
Формат объекта amount
Поле |
Описание |
Тип |
В каких случаях используется |
value |
Сумма операции, округленная до двух десятичных знаков в меньшую сторону |
Number(6.2) |
Всегда |
currency |
Идентификатор валюты операции (Alpha-3 ISO 4217 код) |
string(3) |
Всегда |
Формат объекта status
Поле |
Описание |
Тип |
В каких случаях используется |
value |
Строковое значение статуса |
string |
Всегда |
changedDateTime |
Дата обновления статуса |
URL-закодированная строкаГГГГ-ММ-ДДTчч:мм:ссZ |
Всегда |
reasonCode |
Код причины отклонения |
string(200) |
В случае отклонения операции |
reasonMessage |
Описание причины отклонения |
string(200) |
В случае отклонения операции |
errorCode |
Код ошибки |
Number |
В случае ошибки |
Формат объекта paymentMethod
Поле |
Описание |
Тип |
В каких случаях используется |
type |
Тип метода оплаты |
string |
Всегда |
paymentToken |
Платёжный токен карты |
string |
При оплате платёжным токеном |
maskedPan |
Маскированный PAN карты |
string |
При оплате платёжным токеном или картой |
rrn |
RRN платежа (по ISO 8583) |
number |
При оплате платёжным токеном или картой |
authCode |
Auth-code платежа |
number |
При оплате платёжным токеном или картой |
Формат объекта customer
Поле |
Описание |
Тип |
В каких случаях используется |
phone |
Номер телефона покупателя |
string |
Всегда |
email |
E-mail покупателя |
string |
Всегда |
account |
Идентификатор покупателя в системе ТСП |
string |
Всегда |
ip |
IP адрес покупателя |
string |
Всегда |
country |
Страна адреса покупателя |
string |
Всегда |
bic |
БИК банка, выпустившего карту |
string |
Только для платежей через СБП |
lastName |
Фамилия покупателя |
string |
Только для платежей через СБП |
firstName |
Имя покупателя |
string |
Только для платежей через СБП |
middleName |
Отчество покупателя |
string |
Только для платежей через СБП |
simpleAddress |
Адрес покупателя |
string |
Только для платежей через СБП |
inn |
ИНН покупателя |
string |
Только для платежей через СБП |
bankMemberId |
Идентификатор банка покупателя |
string |
Только для платежей через СБП |
Формат объекта customFields
Поле |
Описание |
Тип |
В каких случаях используется |
cf1 |
Поле с произвольной информацией, дополняющей данные по операции |
string(256) |
Всегда |
cf2 |
Поле с произвольной информацией, дополняющей данные по операции |
string(256) |
Всегда |
cf3 |
Поле с произвольной информацией, дополняющей данные по операции |
string(256) |
Всегда |
cf4 |
Поле с произвольной информацией, дополняющей данные по операции |
string(256) |
Всегда |
cf5 |
Поле с произвольной информацией, дополняющей данные по операции |
string(256) |
Всегда |
Формат объекта settlementAmount
Поле |
Описание |
Тип |
В каких случаях используется |
value |
Сумма расчёта с мерчантом |
number(6.2) |
Если валюта платежа и расчёта с мерчантом различаются |
currency |
Идентификатор валюты расчёта с мерчантом (Alpha-3 ISO 4217 код) |
string(3) |
Если валюта платежа и расчёта с мерчантом различаются |
Пример тела уведомления
Пример тела уведомления REFUND{
"refund": {
"refundId": "4ad8c332-f4ab-426c-baac-f1a2e0f16nvuth»,
"createdDateTime": "2025-07-08T10:12:42+03:00",
"status": {
"value": "SUCCESS",
"changedDateTime": "2025-07-08T10:12:42+03:00"
},
"amount": {
"value": 2.00,
"currency": "RUB"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "220220******1111»,
"cardHolder": null,
"cardExpireDate": "6/2027"
},
"merchantSiteUid": "test-01",
"customer": {
"phone": "0"
},
"gatewayData": {
"type": "ACQUIRING"
},
"billId": "autogenerated-fd319d87-162c-4da6-86c2-f67320f1832c",
"flags": [],
"refundSplits": [],
"paymentId": "aabbddd0-5ae1-41b9-888f-a25ea961f48b",
"type": "REFUND"
},
"type": "REFUND",
"version": "1"
}