Endpoint одной записи: GET /payment/v1/refund-transactions/{refundTxId}. Кроме того, коллекцию можно искать через GET /payment/v1/refund-transactions с фильтрами paymentId, conversationId и paymentTransactionId.

URL

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

HTTP Metod URL
GET /payment/v1/refund-transactions/{refundTxId}

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

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

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

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

Название параметра Тип Объяснение
id number ID возврата, созданный для транзакции возврата.
conversationId string Значение conversationId, отправленное вместе с запросом.
createdDate date Дата и время возврата.
refundStatus string Возвращает SUCCESS в случае удачных процессов и FAILURE в случае неудачных процессов.
refundPrice decimal Возвращенная сумма.
refundBankPrice decimal Сумма платежа банка, возвращенная в связи с распределением.
refundWalletPrice decimal Сумма платежа кошелька, возвращенная в связи с распределением.
refundDestinationType string Возвращенная сумма кошелька.
currency 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 с открытым исходным кодом: