Коды ошибок
Полный справочник кодов ошибок API АТОЛ Pay Ecom - общие ошибки, регистрация, отмена, вторая стадия и фискализация.
Ошибки возвращаются в едином формате:
{
"errorCode": "PAYMENT_NOT_FOUND",
"errorMessage": "Платеж не найден",
"status": "error"
}Общие
| Код ошибки | Значение |
|---|---|
USER_NOT_FOUND | Пользователь не найден |
PERMISSION_DENIED | Нет доступа |
BANK_SETTINGS_NOT_FOUND | Банковские настройки не найдены |
CARD_NOT_FOUND | Карта пользователя не найдена |
INVALID_ORDER_ID | Не указан идентификатор платежа |
PAYMENT_NOT_FOUND | Платеж не найден |
ORDER_NOT_FOUND | Заказ не найден - так эту же ситуацию называет само API (см. Callout ниже) |
PAYMENT_PROCESSED | Платеж с таким номером уже обработан |
AUTH_ERROR | Ошибка авторизации. Неверный токен (HTTP 403) |
NO_AUTH_DATA | Отсутствуют данные для входа: заголовок Authorization не распознан - например, токен передан без префикса Bearer (HTTP 412) |
PAYMENT_SETTINGS_NOT_FOUND | Не заданы настройки оплаты в личном кабинете АТОЛ Pay (раздел Настройки > Настройки заказов) |
SERVER_ERROR | Ошибка обработки запроса на стороне сервиса (HTTP 400, из OpenAPI-спецификации) |
SERVICE_IS_UNAVAILABLE | Сервис временно недоступен (HTTP 500, из OpenAPI-спецификации) - повторите запрос позже |
API называет часть кодов иначе, чем документ-источник
Таблицы на этой странице собраны по документу «Интеграция c API АТОЛ Pay
Ecom». Проверка реальными запросами к тестовому контуру
croc-sandbox-api-mobile.atolpay.ru показала, что для тех же ситуаций API
возвращает другие названия кодов:
| Ситуация | Код в документе | Код от API (подтвержден запросом) |
|---|---|---|
| Заказ не найден | PAYMENT_NOT_FOUND | ORDER_NOT_FOUND |
| Заказ с таким номером уже существует | PAYMENT_EXISTS | ORDER_EXISTS |
| Токен не распознан | - | NO_AUTH_DATA |
Оба набора названий оставлены в таблицах намеренно: какой именно код придет,
зависит от контура и версии сервиса. Сравнивайте errorCode со списком
допустимых значений и предусматривайте ветку для неизвестного кода - не
рассчитывайте на одно ожидаемое название.
Регистрация платежа (POST /payments)
| Код ошибки | Значение |
|---|---|
PAYMENT_EXISTS | Такой заказ уже существует |
ORDER_EXISTS | Заказ с таким номером уже существует - так эту же ситуацию называет само API. Повторный POST /payments с занятым orderId отклоняется, дубль заказа не создается |
UNEXPECTED_REGISTER_PAYMENT_ERROR | Неизвестная ошибка регистрации заказа |
INVALID_RECEIPT_AMOUNT | Сумма платежа отличается от суммы по позициям |
Отмена/возврат (POST /cancel, callback отмены и возврата)
| Код ошибки | Значение |
|---|---|
INVALID_CANCEL_ACTION | Тип отмены не определен |
CANCEL_ALREADY_MADE | Платеж уже отменен |
CANCEL_IS_NOT_POSSIBLE | Отмена платежа невозможна |
FULL_REFUND_IS_NOT_POSSIBLE | Полный возврат невозможен: часть платежа уже была возвращена |
WRONG_REFUND_AMOUNT | Сумма возврата превышает сумму оплаты |
PARTIAL_REFUND_IS_NOT_POSSIBLE | Частичный возврат невозможен на первой стадии двухстадийного платежа |
UNEXPECTED_CANCEL_PAYMENT_ERROR | Неизвестная ошибка отмены платежа |
PARENT_RECEIPT_NOT_FOUND | Родительский чек не найден |
EMPTY_REFUND_RECEIPT_POSITIONS | Отсутствуют позиции возврата |
EMPTY_REFUND_RECEIPT_AMOUNT | Отсутствует сумма возврата |
INVALID_REFUND_RECEIPT_AMOUNT | Сумма возврата отличается от суммы по позициям |
INVALID_POSITION_PARENT_ITEM_ID | Некорректный родитель позиции |
INVALID_POSITION_AMOUNT | Некорректная сумма позиции |
INVALID_POSITION_QUANTITY | Количество товара позиции превышает остаток |
UNSUPPORTED_RECEIPT_TYPE | Некорректный тип чека |
DUPLICATE_POSITION_PARENT_ITEM_ID | Найдены одинаковые позиции возврата |
Callback оплаты
| Код ошибки | Значение |
|---|---|
UNEXPECTED_PAY_PAYMENT_ERROR | Неизвестная ошибка оплаты |
UNEXPECTED_PAY_PAYMENT_3DS2_ERROR | Неизвестная ошибка оплаты 3DS 2.0 |
UNEXPECTED_COMPLETE_PAYMENT_ERROR | Неизвестная ошибка завершения оплаты |
UNEXPECTED_COMPLETE_PAYMENT_3DS2_ERROR | Неизвестная ошибка завершения оплаты 3DS 2.0 |
PROCESSING_ERROR | Ошибка процессинга (например, errorMessage: "Ошибка 3-D Secure авторизации.") |
PAYMENT_DECLINED | Банк отклонил оплату; причина - текстом в errorMessage (например, «Недостаточно средств на карте») |
Коды PROCESSING_ERROR и PAYMENT_DECLINED встречаются в примерах callback
документа «Интеграция c API АТОЛ Pay Ecom», но отсутствуют в его сводной
таблице кодов ошибок. Обрабатывайте errorCode в callback устойчиво к
неизвестным значениям.
Вторая стадия (POST /deposit, callback второй стадии)
| Код ошибки | Значение |
|---|---|
DEPOSIT_IS_NOT_POSSIBLE | Списание средств невозможно |
UNEXPECTED_DEPOSIT_PAYMENT_ERROR | Неизвестная ошибка проведения второй стадии платежа |
Callback фискализации
| Код ошибки | Значение |
|---|---|
SEND_RECEIPT_ERROR | Ошибка отправки чека в провайдер фискализации |
SEND_REFUND_RECEIPT_ERROR | Ошибка отправки чека возврата в провайдер фискализации |
CHECK_RECEIPT_STATUS_RESPONSE_ERROR | Чек доставлен в провайдер фискализации, но провайдер ответил ошибочным статусом |
CHECK_RECEIPT_STATUS_WAIT_ERROR | Не удалось дождаться результата отправки чека |
CHECK_RECEIPT_STATUS_UNKNOWN_ERROR | Неожиданная ошибка получения статуса чека |