Refund
https://{Environment}.payture.com/apim/RefundЭта команда используется для возврата денежных средств, списанных при одностадийном или двухстадийном платеже.
Результатом обработки запроса является полный или частичный возврат списанных денежных средств на карту Покупателя.
Внимание! Для успешного возврата необходимо, чтобы на момент исполнения запроса платеж имел статус Charged.
Запрос
curl https://sandbox3.payture.com/apim/Refund \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d Key=Merchant \
-d Password=123 \
-d OrderId=5f63838d-fb03-00c6-c890-c67cfc1c54ea \
-d Amount=12480 \В запросах наименования параметров чувствительны к регистру
| Параметр | Описание | Формат |
|---|---|---|
| Key | Наименование платежного Терминала Предоставляется с параметрами тестового/рабочего доступа | String Mandatory |
| Password | Пароль платежного Терминала Предоставляется с параметрами тестового/рабочего доступа | String Mandatory |
| OrderId | Уникальный идентификатор платежа в системе Продавца Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов. | String [1..50] Mandatory |
| Amount | Сумма, которую следует вернуть, в копейках. В случае отсутствия параметра в запросе выполняется полный возврат Цифры, не содержащие десятичных или других разделителей | Integer Optional |
| Cheque | Информация о чеке в формате JSON, закодированная в Base64 | String Optional |
Ответ
XML строка с элементом Refund
Примеры ответов
<Refund Success="True" OrderId="5f63838d-fb03-00c6-c890-c67cfc1c54ea" NewAmount="2000"/>| Параметр | Описание | Формат |
|---|---|---|
| Success | Признак успешности операции. Принимает значения:True — операция успешнаFalse — операция неуспешна | String Mandatory |
| OrderId | Идентификатор платежа в системе Продавца Соответствует переданному в запросе | String [1..50] Mandatory |
| NewAmount | Остаток списанной суммы после возврата в копейках Передается, если «Success=True» | Integer Optional |
| ErrCode | Код ошибки. См. коды ошибок Передается, если «Success=False» | String Optional |
