Статус транзакции
Метод получения статуса и подробной информации о транзакции.
URL
Метод: GET
- Production:
https://api.pay.kvell.group/v1/orders/{transaction}
- Stage:
https://api.pay.stage.kvell.group/v1/orders/{transaction}
Параметры запроса
Название |
Тип данных |
Обязательно |
Описание |
transaction |
string |
Да |
Уникальный номер транзакции на стороне мерчанта |
Заголовки запроса
Название |
Тип данных |
Обязательно |
Описание |
X-Api-Key |
string |
Да |
Уникальный идентификатор магазина |
X-Signature |
string |
Да |
Подпись |
Формирование подписи
Подпись X-Signature
формируется конкатенацией X-Api-Key
, transaction
и secret_key
. Формируется sha256 от
полученной строки:
sha256({x-api-key}{transaction}{secret_key})
где secret_key
- секретный ключ, который находится в настройках магазина мерчанта.
Ответ запроса
Пример ответа
{
"id": "b13e1610-f26a-4c49-84e8-0edf1650a026",
"status": "completed",
"transaction": "436b4ed3-fc6d-431e-963e-a958a730119c",
"amount": 100,
"commission": 1000,
"inner_commission": 500,
"description": "TEST Invoice",
"success_url": "https://success.url",
"fail_url": "https://fail.url",
"redirect_url": "https://redirect.url",
"extra_data": {},
"fiscal_data": {},
"split_data": [],
"additional_data": {},
"error_code": null,
"error_message": null,
"created_at": "2024-05-20T12:55:00.951753+00:00",
"refund_amount": 0,
"reverse_amount": 0,
"confirm_amount": 0
}
{
"errors": [
{
"message": "string",
"code": 0
}
]
}
- Если получен ответ со статусом
5XX
, транзакцию необходимо оставить в обработке и отправить запрос повторно.
- Данные ошибки могут возникнуть по различным причинам: на стороне взаимодействия сети, технических сбоев сервера или ПО.
- В случае повторного возникновения данной проблемы рекомендуется обратиться в службу поддержки.
Параметры ответа
Название |
Тип данных |
Описание |
id |
string |
ID транзакции в системе |
status |
string |
Статус транзакции |
transaction |
string |
Уникальный номер транзакции на стороне мерчанта |
amount |
integer |
Сумма в копейках |
description |
string |
Описание к транзакции |
created_at |
string |
Дата создания транзакции по UTC |
error_code |
string |
Код ошибки |
error_message |
string |
Сообщение ошибки |
commission |
integer |
Внешняя комиссия в копейках |
inner_commission |
integer |
Внутренняя комиссия в копейках |
success_url |
string |
Ссылка при успешном статусе |
fail_url |
string |
Ссылка при неуспешном статусе |
redirect_url |
string |
Ссылка для редирект, если не указаны success_url и fail_url |
extra_data |
json |
Дополнительная информация |
fiscal_data |
json |
Фискализация чека |
split_data |
array |
Данные по сплитованию транзакции |
additional_data |
json |
Дополнительная информация о транзакции |
Список статусов
Название |
Описание |
new |
Новая транзакция |
processing |
Транзакция обрабатывается |
canceled |
Транзакция отклонена |
completed |
Транзакция выполнена |
refunded |
Транзакция возвращена |
part_refunded |
Транзакция частично возвращена |
reversed |
Транзакция отменена |
part_reversed |
Транзакция частично отменена |
Коды ошибок транзакции
Код |
Описание |
opkc-timeout |
Банк получателя не направил ответ НСПК в установленный тайм-аут |
transaction-could-not-be-found |
Не удалось найти транзакцию |
failed-to-get-transaction-status |
Не удалось получить статус транзакции |
failed-to-complete-the-transaction |
Не удалось провести транзакцию |
failed-to-get-status |
Не удалось получить статус |
failed-list-of-bank |
Не удалось получить список банков |
neresident-rejected |
Запрещены переводы на нерезидентов для данного клиента |
no-payment-attempts |
Не было попыток оплаты |
error-card-details |
Некорректно введены данные карты |
refusal-from-issuer |
Отказ от эмитента. Обратитесь в Банк |
3ds-error |
Ошибка 3-D Secure авторизации |
waiting-time-expired |
Истек срок ожидания ввода данных |
transaction-ban |
Транзакция запрещена |
description-exceeded |
Превышена разрешенная длина назначения платежа |
system-error-sbp |
Системная ошибка в СБП |
invalid-card |
Недействительная карта, отказ от эмитента |
issuer-unavailable |
Эмитент недоступен |
limit-exceeded |
Превышение установленных лимитов |
amount-exceeded |
Превышен лимит на сумму операции. Обратитесь в Банк |
insufficient-funds |
Недостаточно средств |
card-rejected |
Отказ от банка выпустившего карту |
system-error |
Системная ошибка |