Ответы и ошибки

API использует стандартные HTTP-коды. Код дублируется в поле status тела ответа, поэтому его можно проверять любым удобным способом.

Формат ошибки

При ошибке data равно null, status_check — false, а в поле error передаётся понятное описание причины.

  1. 1.{
  2. 2. "data": null,
  3. 3. "error": "Поле x-api-key обязательно для заполнения.",
  4. 4. "status": 422,
  5. 5. "status_check": false
  6. 6.}

HTTP-коды

КодЗначениеЧто делать
200УспешноЗапрос выполнен, данные в поле data
401Ошибка авторизацииНеверный shop_id / user_id или секретный ключ. Проверьте ключи
403Доступ запрещёнКасса или пользователь неактивны, выплаты отключены, либо сумма вне лимитов тарифа
404Не найденоПлатёж, выплата или подходящий тариф не найдены (или тариф выключен)
422Ошибка валидацииИсправьте параметры запроса — причина указана в поле error
500Внутренняя ошибкаПовторите запрос позже
Значение
Успешно
Что делать
Запрос выполнен, данные в поле data
Значение
Ошибка авторизации
Что делать
Неверный shop_id / user_id или секретный ключ. Проверьте ключи
Значение
Доступ запрещён
Что делать
Касса или пользователь неактивны, выплаты отключены, либо сумма вне лимитов тарифа
Значение
Не найдено
Что делать
Платёж, выплата или подходящий тариф не найдены (или тариф выключен)
Значение
Ошибка валидации
Что делать
Исправьте параметры запроса — причина указана в поле error
Значение
Внутренняя ошибка
Что делать
Повторите запрос позже

Повторные запросы

  • Запросы на получение информации (GET) можно безопасно повторять.
  • Если при создании выплаты не пришёл ответ (например, из-за сетевой ошибки), не создавайте её повторно. Сначала проверьте её через информацию о выплате по order_id.
  • Передавайте уникальный order_id — так вы всегда сможете найти операцию по идентификатору из своей системы.