Перейти к содержимому

Список платежей

GET
/payments
curl --request GET \
--url 'https://app.mybi.ru/api/v2/payments?page=1&length=10&id=1%2C2%2C3&created_from=2026-01-01%2000%3A00%3A00&created_to=2026-01-01%2023%3A59%3A59&modified_from=2026-01-01%2000%3A00%3A00&modified_to=2026-01-01%2023%3A59%3A59&token=<token>'

Возвращает операции с балансом пользователя — как успешно проведенные платежи, так и запланированные, но не завершенные. Результат разбит на страницы (поле pagination), доступны фильтры по идентификаторам и датам. как по успешно проведенным, так и запланированным, но не завершенным

page
integer
по умолчанию: 1 >= 1

Текущая страница

Пример

1
length
integer
по умолчанию: 100 >= 1 <= 500

Количество записей на странице

Пример

10
id
Array<integer>
>= 1 элементов <= 500 элементов уникальные элементы

Идентификаторы записей через запятую, не более 500

Пример

?id=1%2C2%2C3
created_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата создания с, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 00:00:00
created_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата создания по, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 23:59:59
modified_from
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата изменения с, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 00:00:00
modified_to
string
/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

Дата изменения по, формат YYYY-MM-DD HH:MM:SS

Пример

2026-01-01 23:59:59

Список платежей успешно получен

MIME-типapplication/json
object
payments

Список платежей

Array<object>

Платеж

object
id

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

integer
amount

Сумма

number формат: double
succeeded

Успешный

boolean
type

Тип

string
Допустимые значения: Перевод физ. лица Оплата на расчетный счет Бонус по партнерской программе Комиссия по партнерской программе Продажа шаблонов на маркетплейсе Вывод средств на счет пользователя Бонус по рекламной акции Бонус за прохождение курса
category

Категория

string
Допустимые значения: Простой Начальный Периодический
agent

Агент

string
Допустимые значения: Не определен Robokassa ЮKassa mybi connect
comment

Комментарий

string
invoice_id

Идентификатор счета

integer
created_date

Дата создания

string формат: date-time
modified_date

Дата изменения

string формат: date-time
pagination

Параметры постраничной выдачи

object
page
обязательный

Номер текущей страницы (нумерация с 1)

integer
has_next

Есть ли следующая страница

boolean
has_prev

Есть ли предыдущая страница

boolean
fact_length

Сколько записей возвращено на этой странице

integer
length
обязательный

Запрошенный размер страницы

integer
total
обязательный

Всего записей по заданному фильтру

integer

Пример

{
"payments": [
{
"type": "Перевод физ. лица",
"category": "Простой",
"agent": "Не определен"
}
],
"pagination": {
"page": 1,
"has_next": true,
"has_prev": true,
"fact_length": 10,
"length": 10,
"total": 5000
}
}

Ошибка авторизации

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

Пример сгенерировано

{
"status": 1,
"error": "example"
}