Transaction Status
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
Authorization required: client credentials
Request
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"
Field | Description |
---|
grant_type | Authorization type, client_credentials type is used for making a payment |
scope | Resource |
client_id | ID from system ePay can be issued during after registration and conclusion of the contract |
client_secret | Merchant's access key, can be obtained in the account issued upon registration |
terminal | ID from system ePay can be obtained in the account, issued during registration |
Response
{
"access_token": "DCEB8O_ZM5U7SO_T_U5EJQ",
"expires_in": 7200,
"refresh_token": "",
"scope": "webapi usermanagement email_send verification statement statistics payment",
"token_type": "Bearer"
}
Field | Description |
---|
access_token | Operation token |
expires_in | Token expiration time |
refresh_token | Not used for this type of authorization |
scope | Resource |
token_type | Authorization 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,
"secureDetails":"F",
"statusID": "5bbb7dd5-4691-41ee-a6a5-755a3d23a218",
"statusName": "REFUND",
"name": "Tester Petrov",
"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
}
Field | Description |
---|
resultCode | Operation result code |
| result Message |
transaction | Transaction data |
resultCode
Field | Description |
---|
100 | Success |
101 | Reject |
102 | Invoice not found, try again later or check transaction type (payment/p2p) |
103 | Error, try again or contact support |
104 | Field terminal absent in token |
107 | Try again later |
109 | Terminal does not belong to the client, check provided request |