Актуальный endpoint: GET /payment/v1/refunds/{refundId}; старое обозначение ${refundId} следует понимать как path placeholder. Ответ использует актуальные поля RefundResponse со страницы возврата.

URL

Ниже приведена информация о endpoint и методе http, использованном для запроса на возврат средств:

HTTP Metod URL
GET /payment/v1/refunds/{refundId}

Параметры запроса

ID возврата запрашивается для исследования текущей транзакции возврата.

Название параметра Тип Обязательный Объяснение
id number Да ID отмены

Параметры возврата

Название параметра Тип Объяснение
id number ID возврата, созданный для транзакции возврата.
conversationId string Значение conversationId, отправленное вместе с запросом.
createdDate date Дата и время возврата.
status string Возвращает SUCCESS в случае удачных процессов и FAILURE в случае неудачных процессов.
refundPrice decimal Возвращенная сумма, в связи с распределением.
refundBankPrice decimal Сумма платежа банка, возвращенная в связи с распределением.
refundWalletPrice decimal Сумма платежа кошелька, возвращенная в связи с распределением.
refundType string Для отмененного процесса возвращается CANCEL, а для возвращенного REFUND.
refundDestinationType string Сумма отмененного платежа кошелька.
paymentId number ID возвращенного платежа.
currency string Валюта возвращенного платежа.
paymentTransactionRefunds PaymentTransactionRefundResponse[] См. информацию, связанное с распределением возврата платежа: Информация распределения возврата

Информация распределения возврата

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

Название параметра Тип Объяснение
id number ID возврата, созданный для транзакции возврата.
conversationId string Значение conversationId, отправленное вместе с запросом.
createdDate date Дата и время возврата.
status string Возвращает SUCCESS в случае удачных процессов и FAILURE в случае неудачных процессов.
isAfterSettlement boolean Значение возвращаемого распределения имеет значение true, если возврат средств осуществляется после отправки денег, и значение false, если возврат осуществляется до отправки денег.
refundPrice decimal Сумма, возвращенная в связи с распределением.
refundBankPrice decimal Сумма платежа банка, возвращенная в связи с распределением.
refundWalletPrice decimal Сумма платежа кошелька, возвращенная в связи с распределением.
paymentTransactionId number ID распределения возврата.
paymentId number Значение ID возвращенного платежа.
currency string Валюта возвращенного платежа.
refundDestinationType string Когда возврат денег осуществляется на карту, то он включается в поле CARD, а если в кошелек, то он включается в поле WALLET. Значение defolt CARD.

Примеры кодов

Вы можете просмотреть примеры кодов в Odero API client с открытым исходным кодом: