Skip to main content
Публичные структуры финансовых объектов: payment, invoice, invoiceProduct, acquiring. Полное дерево payment приходит в вебхуке PaymentCompleted.
Метод invoice/list/raw отдаёт компактную проекцию счёта (invoiceId, invoiceUuid, type, status, суммы, currency, user, products). Ниже — полные публичные схемы. Денежные поля — числа (decimal из БД приводится к number).

payment

id
integer
required
ID платежа.
uuid
string
required
UUID платежа.
type
enum
required
Тип: OneTime, RecurrentPay, RecurrentInit.
status
enum | null
Статус: Created, WaitingPay, WaitingForBinding, Processing, Completed, BindingCompleted, Canceled.
released
boolean
required
Средства разблокированы (выплачены продавцу).
checkoutPaymentId
string | null
ID платежа в платёжной системе.
checkoutUrl
string | null
URL оплаты.
paidAt
string | null
Дата оплаты (ISO 8601).
expireAt
string | null
Дата истечения (ISO 8601).
isCompleted
boolean | null
Платёж завершён.
isCanceled
boolean | null
Платёж отменён.
meta
object | null
Служебные метаданные.
webhookLogs
object[] | null
Логи вебхуков платёжной системы.
chargeLogs
object[] | null
Логи списаний.
statusHistoryLogs
object[] | null
История статусов: { timestamp, status }.
acquiring
object | null
Эквайринг (см. ниже).
invoice
object | null
Счёт (см. ниже).
createdAt
string
required
Дата создания (ISO 8601).
updatedAt
string
required
Дата обновления (ISO 8601).
archivedAt
string | null
Дата архивации или null.

invoice

id
integer
required
ID счёта.
uuid
string
required
UUID счёта.
humanId
integer | null
Человекочитаемый номер счёта.
type
enum
required
Тип: Regular, InstallmentPay, InstallmentInit, SubscriptionPay, SubscriptionInit.
status
enum | null
Статус: Active, Canceled.
totalAmount
number
required
Итоговая сумма.
discountAmount
number
required
Сумма скидки.
currency
enum
required
Валюта: Free, Exes, Rub, Uzs, Kzt, Usd, Eur.
expireAt
string | null
Дата истечения (ISO 8601).
isActive
boolean | null
Счёт активен.
user
object | null
Покупатель — объект пользователя с профилем; дополнительно может содержать school.
products
object[] | null
Позиции счёта (см. invoiceProduct).
createdAt
string
required
Дата создания (ISO 8601).
updatedAt
string
required
Дата обновления (ISO 8601).

invoiceProduct

id
integer
required
ID позиции.
originalPrice
number
required
Первоначальная цена.
totalPrice
number
required
Итоговая цена.
discountAmount
number
required
Сумма скидки по позиции.
price
object | null
Цена продукта — объект productPrice.
discount
object | null
Скидка — объект discount.
product
object | null
Продукт — объект product; дополнительно может содержать course.

acquiring

id
integer
required
ID эквайринга.
uuid
string
required
UUID эквайринга.
active
boolean | null
Активен.
name
string | null
Название.
description
string | null
Описание.
hasProviderCommission
boolean | null
Есть комиссия провайдера.
provider
object | null
Провайдер: { id, type, active }.
Секреты провайдера (apiKey, конфигурация) и платёжный метод/номер карты в публичной схеме не возвращаются.