Создание возврата

POSThttps://api.paypear.ru/v1/refund/

Описание

Создает возврат успешного платежа на указанную сумму.

Авторизация

Для этого метода требуется авторизация.

Запрос

ПАРАМЕТР

ОПИСАНИЕ

amountobject, required

Сумма, которую нужно вернуть пользователю.

payment_idstring, required

Идентификатор платежа.

descriptionstring, optional

Комментарий к возврату. Например, основание для возврата денег пользователю.

metadataobject, optional

Любые дополнительные данные, которые нужны вам для работы (например, ваш внутренний идентификатор заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от API. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

Ответ

В ответ на запрос придёт объект возврата.

Пример запроса

curl https://api.paypear.ru/v1/refund/ \
  -X POST \
  -u <ID магазина>:<Секретный ключ> \
  -H 'Idempotency-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
      "payment_id": "223b8c26-16be-442c-8590-163a524609ab",
      "amount": {
        "value": "10.00",
        "currency": "RUB"
      }
    }'

Пример ответа

{
  "success": true,
  "result": {
    "id": "d69468b3-c434-4a8f-bbfa-356cbb8afa71",
    "payment_id": "79bacb54-ee40-4d33-85c9-8191c55727d7",
    "status": "NEW",
    "amount": {
      "currency": "RUB",
      "value": 1000
    },
    "metadata": {},
    "description": "Клиент передумал покупать товар",
    "created_at": "2024-01-01T12:00:00Z"
  }
}