Актуальный контракт: Запрос также поддерживает refundDestinationType (по умолчанию CARD), hostReference, authCode и transId. Возврат с комиссией выполняется через POST /payment/v1/refunds/withCommission, ручной кредитный возврат — через POST /payment/v1/refunds/manual. В ответ добавлены актуальные поля point, money-box, loyalty, cashback, destination, host-reference и auth-code.

URL

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

HTTP Metod URL
POST /payment/v1/refunds

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

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

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

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

Название параметра Тип Объяснение
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 Сумма платежа кошелька, возвращенная в связи с распределением.
currency string Валюта возвращенного платежа.
paymentTransactionId number ID возвращенного платежа.
paymentId number ID отмененного платежа.
currency string Валюта возвращенного платежа.
refundDestinationType string Когда возврат денег осуществляется на карту, то он включается в поле CARD, а если в кошелек, то он включается в поле WALLET. Значение defolt CARD.

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

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