Актуальный контракт: Запрос поддерживает refundDestinationType (по умолчанию CARD). Для возврата транзакций по ID платежа используется POST /payment/v1/refund-transactions/byPaymentId. В ответ добавлены актуальные isAfterSettlement, gift-card, point, money-box, loyalty, cashback, destination, host-reference и auth-code.

URL

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

HTTP Metod URL
POST /payment/v1/refund-transactions

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

Ожидаемые параметры, которые будут отправлены в запросах для возврата платежа, перечислены в таблице и подзаголовках ниже.

Название параметра Тип Обязательный Объяснение
paymentTransactionId number Да ID возврата, созданный для транзакции возврата.
conversationId string Нет Значение «бумеранг», которое можно отправить с запросом и получить с ответом. Его можно использовать для связывания разных запросов друг с другом. Обычно используется номер заказа субмерчанта, связанный с платежом.
refundPrice number Нет Возвращенная сумма.
refundDestinationType string Нет Когда возврат денег осуществляется на карту, то он включается в поле CARD, а если в кошелек, то он включается в поле WALLET. Значение defolt CARD.

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

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

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

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