Errors & Limits
Ошибки приходят в том же конверте, что и успешные ответы: ok: false, описание в error и машинный код в error_key.
Responses
{
"ok": false,
"error": "Сумма возврата должна быть положительным числом",
"error_key": "machine_readable_code"
}
HTTP-коды
Что означает код
200
ok
optional
Запрос выполнен. Смотрите статус операции внутри — успешный HTTP не означает успешную операцию.
403
error
optional
Операция недоступна для аккаунта. Запросы на чтение при этом работают.
422
error
optional
Данные не приняты. Текст в error объясняет, какое поле не устроило.
429
error
optional
Слишком часто. Повторите с растущей паузой.
502
error
optional
Канал временно не отвечает. Для операций создания это НЕИЗВЕСТНЫЙ исход — см. ниже.
503
error
optional
Канал временно недоступен. Повторите позже; операции создания — только после проверки статуса.
| Name | Type | Required | Description |
|---|---|---|---|
200
|
ok
|
optional | Запрос выполнен. Смотрите статус операции внутри — успешный HTTP не означает успешную операцию. |
403
|
error
|
optional | Операция недоступна для аккаунта. Запросы на чтение при этом работают. |
422
|
error
|
optional | Данные не приняты. Текст в error объясняет, какое поле не устроило. |
429
|
error
|
optional | Слишком часто. Повторите с растущей паузой. |
502
|
error
|
optional | Канал временно не отвечает. Для операций создания это НЕИЗВЕСТНЫЙ исход — см. ниже. |
503
|
error
|
optional | Канал временно недоступен. Повторите позже; операции создания — только после проверки статуса. |
⊘
502 и 503 на создании операции — не отказ
Таймаут при создании платежа или возврата означает, что операция могла состояться. Не повторяйте запрос: сначала выясните исход запросом статуса по своему order_id.
Как обрабатывать
Правила
Ветвление логики
error_key
optional
Только по error_key и HTTP-коду. Текст error предназначен человеку и может измениться.
Повтор запроса
retry
optional
Безопасно повторять чтение (статусы, списки, справочники). Создание платных операций — никогда без проверки статуса.
Незнакомые поля
forward-compat
optional
Игнорируйте поля, которых нет в вашей модели: состав data может расширяться.
Незнакомые статусы
forward-compat
optional
Считайте неизвестный статус НЕконечным и не проводите по нему деньги.
| Name | Type | Required | Description |
|---|---|---|---|
Ветвление логики
|
error_key
|
optional | Только по error_key и HTTP-коду. Текст error предназначен человеку и может измениться. |
Повтор запроса
|
retry
|
optional | Безопасно повторять чтение (статусы, списки, справочники). Создание платных операций — никогда без проверки статуса. |
Незнакомые поля
|
forward-compat
|
optional | Игнорируйте поля, которых нет в вашей модели: состав data может расширяться. |
Незнакомые статусы
|
forward-compat
|
optional | Считайте неизвестный статус НЕконечным и не проводите по нему деньги. |
Лимиты
Ограничения
Частота вызовов
throttle
optional
Операции создания ограничены по частоте. При превышении — 429.
Размер страницы
integer
optional
Параметр per_page у списков. Пагинация постраничная.
Суммы операций
decimal
optional
Минимальные и максимальные суммы определяются договором по аккаунту. Превышение возвращается как 422.
Валюты и способы оплаты
enum
optional
Набор доступных способов оплаты зависит от подключения аккаунта.
| Name | Type | Required | Description |
|---|---|---|---|
Частота вызовов
|
throttle
|
optional | Операции создания ограничены по частоте. При превышении — 429. |
Размер страницы
|
integer
|
optional | Параметр per_page у списков. Пагинация постраничная. |
Суммы операций
|
decimal
|
optional | Минимальные и максимальные суммы определяются договором по аккаунту. Превышение возвращается как 422. |
Валюты и способы оплаты
|
enum
|
optional | Набор доступных способов оплаты зависит от подключения аккаунта. |
✦
Общие правила платформы
Аутентификация, версионирование и общие лимиты Finance OS — в разделах Authentication, Rate Limiting и Errors.