Создание выплаты

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

Описание

Используйте этот запрос, чтобы создать объект выплаты. В запросе необходимо передать сумму выплаты, данные о способе получения выплаты (например, номер банковской карты), описание выплаты и при необходимости дополнительные параметры, связанные с той функциональностью, которую вы хотите использовать.

Авторизация

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

Запрос

ПАРАМЕТР

ОПИСАНИЕ

amountobject, required

Сумма выплаты.

payout_destination_dataobject, required

Данные платежного средства, на которое нужно сделать выплату.

descriptionstring, optional

Описание транзакции (не более 128 символов). Например: «Выплата по заказу №123».

metadataobject, optional

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

Ответ

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

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

curl https://api.paypear.ru/v1/payout/ \
  -X POST \
  -u <ID магазина>:<Секретный ключ> \
  -H 'Idempotency-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
      "description": "Выплата по заказу №123",
      "amount": {
        "value": "10.00",
        "currency": "RUB"
      },
      "payout_destination_data": {
        "type": "bank_card",
        "card": {
          "number": "4111111111111111"
        }
      },
    }'

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

{
  "success": true,
  "result": {
    "id": "0ea32d04-8640-424d-a227-ee5b2330f55c",
    "shop_id": 33661,
    "status": "DONE",
    "description": "Выплата по заказу №123",
    "amount": {
      "value": 1000,
      "currency": "RUB"
    },
    "final_amount": {
      "value": 1015,
      "currency": "RUB"
    },
    "payout_destination": {
      "type": "bank_card",
      "card": {
        "firsrt6": "411111",
        "last4": "1111"
      }
    },
    "created_at": "2025-02-27T15:55:05.600Z",
    "metadata": {}
  }
}