Коды ответов API

Кошелёк Pay API

Документация перемещена

Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:

https://developers.koshelek.app

Коды HTTP

В случае успешного выполнения запроса со стороны узла Cardsmobile будет возвращен тип данных, описанный в документации запроса, и HTTP-код 200.

КодНазначение

200

Возвращается в случае успешного выполнения запроса API.

422

В случае ошибки обработки запроса будет возвращен HTTP-ответ с кодом 422, содержащий JSON-объект, описывающий возникшую ошибку. В частности, этот объект содержит строковое сообщение с описанием причины ошибки на русском языке.

Структура объекта, описывающего ошибку:

ПолеТипНазначение

code

String

Код ошибки.

details

String

Описание ошибки (необязательное поле, может отсутствовать).

Коды ошибок

КодОписаниеРекомендации кассиру

EXTERNAL_PROVIDER_ERROR

Общий код ошибки провайдера платежей.

Попробуйте ещё раз или выберите другой способ оплаты.

UNKNOWN_SESSION_ID

cardSession не существует/не прошёл валидацию.

Повторно отсканируйте карту лояльности и повторите.

UNKNOWN_TRANSACTION_ID

transactionId не найден.

Попробуйте ещё раз или выберите другой способ оплаты.

UNKNOWN_PARTNER_ID

merchant не найден.

Техническая ошибка. Обратитесь к администратору, т.к. магазин не найден.

WRONG_TRANSACTION_STATE_CHANGE

Невозможен перевод транзакции в ожидаемое состояние.

Попробуйте ещё раз или выберите другой способ оплаты.

PAYMENT_TRANSACTION_IS_NOT_PAID

Нет оплаты по транзакции оплаты.

Попробуйте ещё раз через X (конфигурируемый параметр) минут или обратитесь к администратору.

CANCEL_REFUNDING_BY_BANK

Возврат отменен банком.

Возврат отменён банком.

TRANSACTION_FOR_SESSION_ID_ALREADY_EXISTS

Транзакция уже существует для сессии.

Техническая ошибка. обратитесь к системному администратору.

TRANSACTION_FOR_SESSION_ID_ALREADY_PAYED

Транзакция уже обработана.

Техническая ошибка. обратитесь к системному администратору.

TRANSACTION_IN_PROCESSING

Транзакция в обработке.

Оплата уже проведена.

NOT_ENOUGH_LIMIT_TO_PAY

Превышен лимит для совершения операции.

Слишком большая сумма чека оплаты Долями. Попробуйте оплату СБП или смешанную оплату.

TOTAL_AMOUNT_IS_TOO_SMALL

Сумма покупки ниже установленного лимита.

Сумма чека слишком маленькая.

SUBSCRIPTION_IS_NOT_FOUND

Привязанный счёт пользователя не найден (платеж через СБП с привязанного счета пользователя).

Привязка счёта СБП не найдена. Попробуйте оплату Долями.

PAYMENT_DECLINED_BY_EXTERNAL_PROVIDER

Платёж отклонён банком (платёж через СБП с привязанного счета пользователя).

Проверьте достаточность средств или попробуйте оплату Долями.

PAYMENT_TRANSACTION_IS_NOT_PAID

Возврат отклонён, т. к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.

Покупка не найдена. Обратитесь к администратору.

TERMINAL_STATE_OF_PAYMENT_TRANSACTION

Возврат отклонён, т. к. транзакция:

  • была отменена ранее до списания средств;

  • уже была отклонена провайдером платежей до списания средств;

  • уже был выполнен полный возврат оплаченных средств.

Возврат уже выполнен.

PAYMENT_TRANSACTION_IS_BEING_REFUNDED_ALREADY

Возврат отклонён, т.к. уже есть незавершенная транзакция отмены. Дождитесь завершения процесса возврата по транзакции отмены с refTransactionId незавершенной предыдущей транзакции отмены.

Дождитесь результата возврата.

REQUESTED_REFUND_AMOUNT_IS_GREATER_THAN_AVAILABLE

Возврат отклонён, т.к. запрошенная сумма к возврату превышает сумму оплаты по транзакции оплаты с данным transactionId.

Сумма возврата превышает сумму оплаты.

UNEXPECTED_REFUND_AMOUNT_LEFT_FROM_EXTERNAL_PROVIDER

Возврат отклонён, т.к. транзакция оплаты с данным transactionId не была завершена, списание средств не выполнялось.

Возврат отклонён, покупка не завершена.

PAYMENT_ORDER_IS_NOT_FOUND

Только для транзакций СБП. Не найдено платежное поручение в банке ТСП при выполнении операции возврата.

Возврат отклонён, т.к. магазин не поддерживает возвраты. Обратитесь к администратору.

Last updated