Возврат платежа
PUT
/v2/payments/{id}/refundВозвращает покупателю полную сумму оплаченного платежа. Деньги поступят на счёт, с которого была оплата.
Авторизация. Передайте API-ключ в заголовке
Authorization: Bearer <API-ключ>. Подробнее — Авторизация и подпись.Параметры
| Параметр | Где | Тип | Обязательный | Описание |
|---|---|---|---|---|
id | path | integer | да | ID платежа |
Тело запроса не требуется.
Пример запроса
curl -X PUT https://api.zefirpay.com/api/v2/payments/1482093517/refund \
-H "Authorization: Bearer $ZEFIRPAY_API_KEY"
Ответы
| Код | Значение | Описание |
|---|---|---|
| 200 | OK | Возврат выполнен |
| 401 | Unauthorized | API-ключ не передан или неверен |
| 404 | Not Found | Платёж не найден |
| 422 | Unprocessable Entity | Платёж не оплачен или уже возвращён |
| 503 | Service Unavailable | Возврат временно невозможен. Повторите запрос позже — повтор не вернёт деньги дважды |
200
{"success": true}
422
{"error": "Вернуть можно только оплаченный платёж", "status": 422}
После возврата платёж получает статус
2, а status_name — refunded. Уведомление о возврате не отправляется: результат вы получаете в ответе на запрос.