Skip to main content

Объект платежа

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

ПАРАМЕТР
ОПИСАНИЕ
idstring, required

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

shop_idnumber, required

Идентификатор магазина.

order_idstring, required

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

statusstring, required

Статус платежа на момент запроса. Подробнее о статусах платежа

descriptionstring, optional

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

amountobject, required

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

credited_amountboolean, optional

Сумма платежа, которую получит магазин, — значение amount за вычетом комиссии Pear.

confirmationobject, required

Способ подтверждение платежа. Присутствует при статусе платежа = NEW, PROCESS. Подробнее о статусах платежа.

created_atstring, required

Дата и время создания платежа. Указывается по UTC и передается в формате ISO 8601.

expires_atstring, optional

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

paidboolean, required

Признак оплаты заказа.

refunded_amountboolean, optional

Сумма, которая вернулась пользователю. Присутствует, если у этого платежа есть успешные возвраты.

metadataobject, optional

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

webhook_urlstring, optional

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

Пример объекта
{
  "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"
}