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

Сведения о платеже

GET
/payments/{payment_id}
curl --request GET \
--url 'https://app.mybi.ru/api/v2/payments/1?token=<token>'

Возвращает сведения о платеже по идентификатору: сумма, тип, категория, агент и статус операции.

payment_id
обязательный
integer
>= 1

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

Пример

1

Платеж успешно получен

MIME-типapplication/json

Платеж

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

Пример

{
"type": "Перевод физ. лица",
"category": "Простой",
"agent": "Не определен"
}

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

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

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

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

Платеж не найден

MIME-типapplication/json
object
status

Код ошибки

integer
error

Текст ошибки

string

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

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