Статус транзакции
TEST URL: GET https://testepay.homebank.kz/api/check-status/payment/transaction/:invoiceid
PROD URL: GET https://epay-api.homebank.kz/check-status/payment/transaction/:invoiceid
Требуется авторизации: client credentials
Запрос
Получение токена
TEST URL POST https://testoauth.homebank.kz/epay2/oauth2/token
PROD URL POST https://epay-oauth.homebank.kz/oauth2/token
Body: form-data
grant_type:"client_credentials"
scope:"webapi usermanagement email_send verification statement statistics payment"
client_id:"test"
client_secret:"yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG"
terminal:"67e34d63-102f-4bd1-898e-370781d0074d"
Поле | Описание |
---|
grant_type | Тип авторизации, для проведения платежа используется тип client_credentials |
scope | Ресурс |
client_id | Идентификатор коммерсанта, можно получить в кабинете, выдается при регистрации |
client_secret | Ключ доступа коммерсанта, можно получить в кабинете, выдается при регистрации |
terminal | Идентификатор точки продаж, можно получит в кабинете, выдается при регистрации |
Ответ
{
"access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
"expires_in": 7200,
"refresh_token":"",
"scope":" webapi usermanagement email_send verification statement statistics payment",
"token_type":"Bearer"
}
Поле | Описание |
---|
access_token | Токен для проведения операции |
expires_in | Время истечения токена |
refresh_token | Не используется при данном типе авторизации |
scope | Ресурс, для проведения платежа используется ресурс |
token_type | Тип авторизации |
Headers
Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
HTTP CODE 200
Responce Body JSON:
{
"resultCode": "100",
"resultMessage": "SUCCESS",
"transaction": {
"id": "af2089fe-43b1-47eb-a61f-c78dd196e18d",
"createdDate": "2022-11-15T03:52:17.289853+06:00",
"invoiceID": "205218074",
"amount": 12.22,
"amountBonus": 0,
"payoutAmount": 10,
"orgAmount":22.22,
"approvalCode": "170243",
"data": "{\"custom_id\":\"2023.03.10-15:03:58\",\"email\":\"epay@halykbank.kz\",\"deal_number\":\"1111111\",\"offer_code\":\"1111111\",\"sum\":33900}",
"currency": "KZT",
"terminal": "98120001",
"terminalID":"67e34d63-102f-4bd1-898e-370781d0074d",
"accountID": "",
"description": "order 205218074",
"language": "RU",
"cardMask": "400303...9821",
"cardType": "VISA",
"issuer": "Казкоммерцбанк",
"reference": "231951411351",
"reason": "Successfully",
"reasonCode": "00",
"intReference": "67140D7DE97139A7",
"secure": false,
"statusID": "5bbb7dd5-4691-41ee-a6a5-755a3d23a218",
"statusName": "REFUND",
"name": "ARMAN ALI",
"email": "epay@halykbank.kz",
"phone": "",
"cardID": "e8a09f98-04b4-71a6-e053-1d1a000aa0d2",
"xlsRRN": "",
"ip": "46.148.239.182",
"ipCountry": "Kazakhstan",
"ipCity": "",
"ipRegion": "",
"ipDistrict": "",
"ipLatitude": 55.7386,
"ipLongitude": 37.6068
}
}
Error
{
"resultCode": "101",
"resultMessage": "reject",
"transaction": null
}
resultCode
Поле | Описание | |
---|
100 | Success | Успех выполнения запроса, в каком состоянии находиться платеж необходимо смотреть по statusName |
101 | Reject | Tранзакция неуспешная |
102 | Invoice not found, try again later or check transaction type (payment/p2p) | Hомер invoiceId не найден в системе, возможно ваша траhзакция проходила по сервису p2p |
103 | Error, try again or contact support | Hеобходимо повторить запрос либо обратиться в службу поддержки |
104 | Field terminal absent in token | Oтстусвует параметр TerminalID при запросе токена |
106 | Error, incorrect terminalID | Hекорректный TerminalID при запросе токена |
107 | In progress | Операция в процессе выполнения, запросите статус позже |
109 | Terminal does not belong to the client, check provided request | Терминал не принадлежит клиенту, проверьте предоставленный запрос |
statusName
Поле | Описание |
---|
REFUND | Был осуществлён возврат списанной суммы |
AUTH | Сумма в блоке |
CANCEL | Сумма разблокирована |
CHARGE | Сумма списана |
VERIFIED | Проверено (Этот статус оплаты возвращается при транзакции на сумму 0 USD для сервиса проверки карты и означает, что карта успешно верифицирована.) |
CANCEL_OLD | Отмена авторизации на стороне Эмитента происходит в случае истечения срока действия операции CHARGE/CANCEL |
FAILED | Транзакция неуспешная |
FINGERPRINT | это не финальный статус транзакции, он означает, что в данный момент осуществляется проверка сбора данных перед 3D-аутентификацией. |
3D | Ошибка на стадии проверки 3D |
NEW | Операция создалась но пока находится в промежуточном состоянии (если вы получили этот статус при запросе статуса транзакции вручную, то примите во внимание что он может быть изменён) |
REJECT | Неуспешная попытка оплаты |