GetRefunds
https://{Environment}.payture.com/api/GetRefundsКоманда GetRefunds используется для получения списка возвратов по заказу.
Запрос
curl https://sandbox3.payture.com/api/GetRefunds \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \В запросах наименования параметров чувствительны к регистру
| Параметр | Описание | Формат |
|---|---|---|
| Key | Наименование платежного Терминала Предоставляется с параметрами тестового/рабочего доступа | String Mandatory |
| OrderId | Уникальный идентификатор платежа в системе Продавца Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов. | String [1..50] Mandatory |
Ответ
XML строка с элементом GetRefunds
Примеры ответов
<GetRefunds Success="True" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" Forwarded="True" MerchantContract="Merchant"
FinalTerminal="Merchant" State="Charged" Amount="300000" NewAmount="100000">
<Item RefundDateTime="2023.08.17 18:22:07" RefundAmount="150000" RefundNewAmount="150000"/>
</Item>
<Item RefundDateTime="2023.10.19 19:12:07" RefundAmount="50000" RefundNewAmount="100000"/>
</Item>
<GetRefunds/>| Параметр | Описание | Формат |
|---|---|---|
| Success | Признак успешности операции. Принимает значения:True — операция успешнаFalse — операция неуспешна | String Mandatory |
| OrderId | Идентификатор платежа в системе Продавца Соответствует переданному в запросе | String [1..50] Mandatory |
| Forwarded | Признак перенаправления платежа на другой Терминал | Boolean Mandatory |
| State | Статус платежа. См. статусы транзакций Передается, если «Success=True» | String Optional |
| MerchantContract | Наименование платежного Терминала Соответствует переданному в запросе. Передается, если «Success=True» | String [1..50] Optional |
| FinalTerminal | Конечный Терминал, на котором был выполнен платеж Передается, если «Forwarded=True» | String Optional |
| Amount | Сумма платежа в копейках (или другая минимальная единица валюты терминала) Передается, если «Success=True» | Integer Optional |
| NewAmount | Остаток списанной суммы после возврата в копейках Передается, если «Success=True» | Integer Optional |
| Item | Список возвратов по заказу Передается, если «Success=True» | Object Optional |
| ErrCode | Код ошибки. См. коды ошибок Передается, если «Success=False» | String Optional |
Атрибуты элемента Item
| Параметр | Описание | Формат |
|---|---|---|
| RefundDateTime | Дата и время возврата Передается, если «Success=False» и по заказу есть успешные возвраты | String Optional |
| RefundAmount | Сумма возврата в копейках Передается, если «Success=False» и по заказу есть успешные возвраты | Integer Optional |
| RefundNewAmount | Остаток списанной суммы после возврата в копейках Передается, если «Success=False» и по заказу есть успешные возвраты | Integer Optional |
