Объекты API

Объекты одинаковы в ответах API и в поле data вебхуков. Пустые поля в ответ не включаются. Новые поля могут добавляться без смены версии — не полагайтесь на точный состав объекта. Машиночитаемое описание: OpenAPI 3 (JSON).

Платёж — payment

Статусы и переходы — в разделе Платежи. Пример:

{
  "id": "pay_3kZ1x9QmT0aBcDeFgHiJkL",
  "object": "payment",
  "shop_id": "723612",
  "mode": "live",
  "test": false,
  "status": "pending",
  "amount": 100000,
  "currency": "RUB",
  "captured_amount": 0,
  "refunded_amount": 0,
  "order_id": "1001",
  "description": "Заказ 1001",
  "capture_mode": "auto",
  "method": null,
  "confirmation": {
    "type": "hosted"
  },
  "payment_url": "https://platezhka.online/pay/pay_3kZ1x9QmT0aBcDeFgHiJkL",
  "return_url": "https://shop.example/orders/1001",
  "customer": {
    "id": "user-42",
    "email": "buyer@example.com"
  },
  "items": [
    {
      "itemId": 1,
      "text": "Товар",
      "price": 100000,
      "quantity": 1
    }
  ],
  "metadata": {},
  "source": "api",
  "receipt_status": null,
  "paygine_order_id": 3504676,
  "expires_at": "2026-09-22T13:00:00+03:00",
  "created_at": "2026-09-22T12:00:00+03:00"
}

Поле	Тип	Описание
id	string	Идентификатор платежа, pay_…
object	string	Всегда payment
shop_id	string	Номер магазина
mode	string	Контур магазина: test live
test	boolean	true для платежа тестового магазина
status	string	Статус платежа: pending authorized succeeded canceled expired refunded partially_refunded on_hold
amount	integer	Сумма в копейках
currency	string	Всегда RUB
captured_amount	integer	Списано, копейки
refunded_amount	integer	Возвращено, копейки
order_id	string	Номер заказа в вашей системе
description	string	Назначение платежа
capture_mode	string	auto — автосписание, manual — холд: auto manual
method	string	Способ оплаты; пусто, пока плательщик не выбрал: card sbp
confirmation	object	Сценарий подтверждения: {type: hosted \| redirect}
payment_url	url	Виджет на нашей странице — для ссылок и писем; на сайте используйте виджет с id платежа
return_url	url	Куда вернуть плательщика после оплаты
customer	object	Покупатель: id (в вашей системе), email, phone
items	array	Позиции чека
metadata	object	Произвольные данные магазина, возвращаются как есть
source	string	Канал создания: cabinet api link
save_payment_method	boolean	Платёж с сохранением способа оплаты для автосписаний
payment_method	object	Сохранённый способ оплаты: id, type, title. Появляется после привязки или при автосписании
decline	object	Отказ банка: reason_code, message. Только при status = canceled
cancel_reason	string	merchant_canceled — отменён магазином до оплаты; charge_failed — автосписание не прошло; register_failed — ПЦ не зарегистрировал заказ
receipt_url	url	Ссылка на чек в ОФД
receipt_status	string	Состояние чека
paygine_order_id	integer	Номер заказа в процессинговом центре
expires_at	datetime	Срок оплаты
paid_at	datetime	Время оплаты
created_at	datetime	Время создания

Возврат — refund

Поле	Тип	Описание
id	string	Идентификатор возврата, rf_…
object	string	Всегда refund
payment_id	string	Платёж, по которому сделан возврат
status	string	Статус возврата: pending succeeded failed
amount	integer	Сумма возврата, копейки
currency	string	Всегда RUB
reason	string	Причина возврата
items	array	Возвращаемые позиции чека
error	string	Причина ошибки при status = failed
created_at	datetime	Время создания

Чек — receipt

Поле	Тип	Описание
id	integer	Идентификатор чека
object	string	Всегда receipt
payment_id	string	Платёж
kind	string	Чек прихода или возврата: sale refund
status	string	Состояние чека: pending ready failed
url	url	Ссылка на чек в ОФД
refund_id	string	Возврат, для чека возврата
created_at	datetime	Время создания

Выплата — payout

Поле	Тип	Описание
id	string	Идентификатор выплаты, po_…
object	string	Всегда payout
status	string	Статус выплаты: pending awaiting_confirmation processing succeeded failed canceled
channel	string	Канал выплаты: bank_account sbp card
amount	integer	Сумма списания с баланса, копейки
fee	integer	Комиссия платформы, копейки
net_amount	integer	Сумма к получению, копейки
currency	string	Всегда RUB
recipient_mask	string	Маска реквизита получателя
error	string	Причина ошибки при status = failed
automatic	boolean	Выплата создана расписанием
executed_at	datetime	Время исполнения
created_at	datetime	Время создания

Счёт — invoice

Поле	Тип	Описание
id	string	Идентификатор счёта, pl_…
object	string	Всегда invoice
shop_id	string	Номер магазина
status	string	Статус счёта: issued sent paid canceled expired
amount	integer	Сумма, копейки
currency	string	Всегда RUB
description	string	Назначение
comment	string	Комментарий для покупателя
capture	string	Режим списания: auto manual
customer	object	Получатель счёта: email, phone
items	array	Позиции чека
url	url	Ссылка на оплату счёта
payment_id	string	Платёж, которым счёт оплачен
return_url	url	Куда вернуть плательщика после оплаты
sent_at	datetime	Когда отправлено письмо
expires_at	datetime	Срок оплаты
created_at	datetime	Время создания

Ссылка на оплату — payment_link

Поле	Тип	Описание
id	string	Идентификатор ссылки, pl_…
object	string	Всегда payment_link
shop_id	string	Номер магазина
title	string	Название
amount	integer	Сумма, копейки; пусто — сумму вводит плательщик
currency	string	Всегда RUB
description	string	Описание
active	boolean	Ссылка включена
url	url	Публичный адрес ссылки
payments_count	integer	Сколько платежей создано по ссылке
expires_at	datetime	Срок действия
created_at	datetime	Время создания

Сохранённый способ оплаты — payment_method

Поле	Тип	Описание
id	string	Идентификатор способа оплаты, pm_…
object	string	Всегда payment_method
type	string	Тип способа оплаты: sbp
status	string	active — можно списывать, inactive — отключён: active inactive
title	string	Название для показа покупателю
test	boolean	true для способа оплаты тестового магазина
customer_id	string	Покупатель в вашей системе (customer.id первого платежа)
first_payment_id	string	Платёж, при котором способ сохранён
last_used_at	datetime	Последнее списание
created_at	datetime	Время сохранения

Адрес вебхука — webhook_endpoint

Поле	Тип	Описание
id	integer	Идентификатор адреса
object	string	Всегда webhook_endpoint
url	url	Адрес (только https)
events	array	Подписка на события; пустой список — все события
active	boolean	Доставка включена
created_at	datetime	Время создания

Баланс — balance

Поле	Тип	Описание
object	string	Всегда balance
sd_ref	string	Идентификатор счёта магазина в ПЦ
currency	string	Всегда RUB
balance	integer	Баланс, копейки
available_balance	integer	Доступно к выводу, копейки
state	string	Состояние счёта в ПЦ
ledger_balance	integer	Баланс по нашему учёту, копейки

Магазины и ключи Виджет на сайте