Создание платежа

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

Описание

Чтобы принять оплату, необходимо создать объект платежа — Payment. Он содержит всю необходимую информацию для проведения оплаты. У платежа линейный жизненный цикл, он последовательно переходит из статуса в статус.

Авторизация

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

Запрос

ПАРАМЕТР

ОПИСАНИЕ

amountobject, required

Сумма платежа.

confirmationobject, required

Способ подтверждение платежа.

order_idstring, required

Номер заказа в системе магазина. Ограничение: до 36 символов.

payment_method_dataobject, required

Данные для оплаты конкретным способом. Доступные способы оплаты согласовываются с менеджером и указаны в разделе Настройки — Способы оплаты.

descriptionstring, optional

Краткое описание платежа (не более 128 символов), которое вы увидите в личном кабинете, а пользователь — при оплате. Например: «Оплата заказа №123».

expires_atstring, optional

Срок действия счета — дата и время, до которых можно оплатить выставленный счет. Указывается по UTC и передается в формате ISO 8601.

metadataobject, optional

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

webhook_urlstring, optional

URL, на который будут отправляться уведомления. Подробная информация по уведомлениям.

Ответ

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

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

curl https://api.paypear.ru/v1/payment/ \
  -X POST \
  -u <ID магазина>:<Секретный ключ> \
  -H 'Idempotency-Key: <Ключ идемпотентности>' \
  -H 'Content-Type: application/json' \
  -d '{
      "order_id": "223b8c26-16be-442c-8590-163a524609ab",
      "description": "Оплата заказа №123",
      "amount": {
        "value": "10.00",
        "currency": "RUB"
      },
      "payment_method_data": {
        "type": "sbp"
      },
      "confirmation": {
        "type": "redirect",
        "return_url": "https://example.com/"
      },
      "expires_at": "2026-06-07T18:45:04.380Z"
    }'

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

{
  "success": true,
  "result": {
    "id": "0ea32d04-8640-424d-a227-ee5b2330f55c",
    "shop_id": 33661,
    "order_id": "223b8c26-16be-442c-8590-163a524609ab",
    "status": "CONFIRMED",
    "description": "Оплата заказа №123",
    "amount": {
      "value": 1000.99,
      "currency": "RUB"
    },
    "credited_amount": {
      "value": 990.98,
      "currency": "RUB"
    },
    "confirmation": {
      "type": "redirect",
      "confirmation_url": "https://paypear.ru/p/Aq91c7d",
      "return_url": "https://example.com/success"
    },
    "created_at": "2025-02-27T15:55:05.600Z",
    "expires_at": "2025-02-27T19:55:05.600Z",
    "paid": true,
    "refunded_amount": {
      "value": 0,
      "currency": "RUB"
    },
    "metadata": {
      "key": "value"
    },
    "webhook_url": "https://example.com/webhook"
  }
}