API Response Codes

Koshelek Pay API

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

HTTP response codes

Successful API response will return data as described in API specification, along with HTTP response code: 200.

Code	Description
200	Indicates successful processing of API request.
422	Indicates API request processing error. The response will contain JSON object with error description. In particular, this object contains a string message describing reason for occurred error in Russian.

Error description object structure:

Field	Type	Mandatory	Description
code	String	Yes	Error code (see below).
details	String	No	Error description.

Error codes

Code	Description	Tip for cash desk operator
EXTERNAL_PROVIDER_ERROR	General error code for payment provider.	Попробуйте ещё раз или выберите другой способ оплаты
UNKNOWN_SESSION_ID	cardSession not found or invalid.	Повторно отсканируйте карту лояльности и повторите
UNKNOWN_TRANSACTION_ID	transactionId not found.	Попробуйте ещё раз или выберите другой способ оплаты
UNKNOWN_PARTNER_ID	merchant not found.	Техническая ошибка. Обратитесь к администратору, т.к. магазин не найден.
WRONG_TRANSACTION_STATE_CHANGE	Requested transaction status transit is not possible.	Попробуйте ещё раз или выберите другой способ оплаты
PAYMENT_TRANSACTION_IS_NOT_PAID	There is no fulfilled payment for this payment transaction.	Попробуйте ещё раз через<X> (configurable parameter) минут или обратитесь к администратору.
CANCEL_REFUNDING_BY_BANK	Refund was canceled by bank.	Refund cancelled by bank
TRANSACTION_FOR_SESSION_ID_ALREADY_EXISTS	Transaction for this session already exists.	Техническая ошибка. обратитесь к системному администратору.
TRANSACTION_FOR_SESSION_ID_ALREADY_PAYED	Transaction already processed.	Техническая ошибка. обратитесь к системному администратору.
TRANSACTION_IN_PROCESSING	Transaction in progress.	Оплата уже проведена
NOT_ENOUGH_LIMIT_TO_PAY	Transaction limit is exceeded.	Слишком большая сумма чека оплаты Долями. Попробуйте оплату СБП или смешанную оплату.
TOTAL_AMOUNT_IS_TOO_SMALL	Transaction amount is below the limit (equals 4 rubles).	Сумма чека слишком маленькая.
SUBSCRIPTION_IS_NOT_FOUND	No subscribed account found (applicable to SBP transactions from the subscribed account).	Привязка счёта СБП не найдена. Попробуйте оплату Долями.
PAYMENT_DECLINED_BY_EXTERNAL_PROVIDER	Payment declined by bank (applicable to SBP transactions from the subscribed account).	Проверьте достаточность средств или попробуйте оплату Долями.
PAYMENT_TRANSACTION_IS_NOT_PAID	Refund rejected as transaction with this transactionId is not completed (and amount was not written off).	Покупка не найдена. Обратитесь к администратору.
TERMINAL_STATE_OF_PAYMENT_TRANSACTION	Refund rejected due to one of the following reasons: Transaction has been canceled before (debiting was not performed). Transaction has been rejected earlier by the payment provider (debiting was not performed). Full refund has already been performed.	Возврат уже выполнен.
PAYMENT_TRANSACTION_IS_BEING_REFUNDED_ALREADY	Refund rejected as there is an ongoing refund already. Wait until the previous refund transaction with this refTransactionId is completed.	Дождитесь результата возврата.
REQUESTED_REFUND_AMOUNT_IS_GREATER_THAN_AVAILABLE	Refund rejected as the requested refund amount exceeds the one declared in payment transaction with this transactionId.	Сумма возврата превышает сумму оплаты.
UNEXPECTED_REFUND_AMOUNT_LEFT_FROM_EXTERNAL_PROVIDER	Refund rejected due to payment transaction with this transactionId was not completed and debiting was not performed.	Возврат отклонён, покупка не завершена.
PAYMENT_ORDER_IS_NOT_FOUND	No bank transfer order found in merchant's bank upon refund (applicable to SBP transactions).	Возврат отклонён, т.к. магазин не поддерживает возвраты. Обратитесь к администратору.