Saving a payment card
Upon registration, you will be given the data that you will need to use when making the payment:
| |
|---|
| TerminalID | Store ID |
| ClientID | Client ID |
| ClientSecret | Secret key |
Test merchant
| |
|---|
| url | https://test-epay.homebank.kz |
| email | epay@halykbank.kz |
| password | XZG1E@Mm |
| ClientID | test |
| ClientSecret | yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG |
| TerminalID | 67e34d63-102f-4bd1-898e-370781d0074d |
Test payment card
| PAN | Expire Date | CVC | Status |
|---|
| 4405639704015096 | 01/27 | 321 | unlock |
| 5522042705066736 | 01/27 | 775 | unlock |
| 377514500004820 | 01/28 | 0198 | unlock |
| 4003032704547597 | 09/20 | 170 | lock |
| 5578342710750560 | 09/20 | 254 | lock |
Getting a token to make a payment (for each operation, you must receive and use the original token)
TEST URL POST https://testoauth.homebank.kz/epay2/oauth2/token PROD URL POST https://epay-oauth.homebank.kz/oauth2/token
Request
Body: form-data
grant_type: "client_credentials"
scope: "webapi usermanagement email_send verification statement statistics payment"
client_id: "test"
client_secret: "yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG"
invoiceID: "000000001"
amount: 0
currency: "USD"
terminal: "67e34d63-102f-4bd1-898e-370781d0074d"
postLink: ""
failurePostLink: ""
| Field | Description |
|---|
| grant_type | Authorization type, the client_credentials type is used for making a payment |
| scope | Resource |
| client_id | Merchant's ID, which can be obtained in the cabinet, is issued upon registration |
| client_secret | The merchant's access key, which can be obtained in the cabinet, is issued upon registration |
| invoiceID | The order number generated by the merchant must be unique for each new order, from 6 to 15 digits. If your order number contains more than 6 characters, then additionally uniqueness must be observed for the last 6 characters |
| amount | Order amount |
| currency | Currency |
| terminal | The ID of the point of sale, which can be obtained in the cabinet, is issued during registration |
| postLink | Required parameters, sending a postlink if successful |
| failurePostLink | Optional parameters, sending a postlink in case of failure |
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 | The token for the operation |
| expires_in | Token Expiration Time |
| refresh_token | It is not used for this type of authorization |
| scope | Resource, the payment resource is used to make the payment |
| token_type | Authorization type |
Making a payment
On the page, you need to connect the JS-library and call the halyk.cardverification() method in it.
Production version
URL TEST: https://test-epay.homebank.kz/payform/payment-api.js
URL PROD: https://epay.homebank.kz/payform/payment-api.js
The following parameters must be passed to the halyk.cardverification() method.
var createPaymentObject = function(auth, invoiceId, amount) {
var paymentObject = {
InvoiceID: "000000001",
backLink: "https://example.kz/success.html ",
failureBackLink: "https://example.kz/failure.html ",
postLink: "https://example.kz /",
language: "rus",
description: "Card registration",
AccountId: "testuser1",
terminal: "67e34d63-102f-4bd1-898e-370781d0074d",
amount: 0,
currency: "USD",
cardSave: true,
PaymentType: "cardVerification"
};
paymentObject.auth = auth;
return paymentObject;
};
halyk.pay(createPaymentObject(auth, invoiceId, amount));
| Field | Description |
|---|
| invoiceID | The order number generated by the merchant must be unique for each new order, from 6 to 15 digits. If your order number contains more than 6 digits, then additionally uniqueness must be observed for the last 6 digits |
| backLink | Link to return to the store upon successful payment |
| failureBackLink | Link to return to the store in case of a failed payment |
| postLink | Payment Notification |
| language | Language rus/kaz/eng |
| description | Order description, the allowed number of characters is 125 bytes |
| AccountId | Field for specifying the store's customer ID, required field when saving the card (cardSave: true) |
| terminal | The store ID, which can be obtained in the cabinet, is issued upon registration |
| amount | The amount to save the card is always 0 |
| currency | Currency, always USD to save the card |
| cardSave | Required parameter for saving the map, passed as boolean |
| paymentType | Operation type - card verification |
Post link
A message will be sent to the specified URL specified in the postLink field. If you have not received a postlink, we recommend using the [Transaction Status service] (https://epayment.kz/docs/check-status-payment)
Response in an event of success:
{
"accountId": "sad12eqsda",
"amount": 100,
"approvalCode": "157911",
"cardId": "11f1111b-f151-6f11-e161-1111010a2111",
"cardMask": "440043...2222",
"cardType": "VISA",
"code": "ok",
"currency": "KZT",
"dateTime": "2024-07-29T10:50:56.765674319+05:00",
"description": "Arman Alimguzhinov",
"email": "",
"id": "1d1a11f1-1111-111c-1113b-e8340ce51111",
"invoiceId": "191111111",
"ip": "213.148.6.204",
"ipCity": "",
"ipCountry": "",
"ipDistrict": "",
"ipLatitude": 0,
"ipLongitude": 0,
"ipRegion": "",
"issuer": "JSC KASPI BANK",
"language": "RUS",
"name": "STANDARD CARDHOLDER",
"phone": "",
"reason": "success",
"reasonCode": 0,
"reference": "411111111117",
"secure": "no",
"secureDetails":"F",
"terminal": "67e34d63-102f-4bd1-898e-370781d0074d"
}
Error codes
Response in case of failure:
{
"id": "ffffffff-0000-000f-f000-00f0000f000f",
"dateTime": "2020-01-01T00:00:00.00000+06:00",
"invoiceId": "10000000001",
"amount": 0,
"currency": "USD",
"terminal": "999999999",
"accountId": "1",
"description": "Регистрация карты",
"language": "RU",
"cardMask": "4444...4444",
"cardType": "",
"issuer": "Halyk bank",
"reference": "",
"secure": "no",
"secureDetails":"F",
"tokenRecipient": "",
"code": "error",
"reason": "описание ошибки",
"reasonCode": -498,
"name": "CARD HOLDER",
"email": "ch@example.kz",
"phone": "77777777777",
"ip": "5.188.155.135",
"ipCountry": "Kazakhstan",
"ipCity": "Almaty",
"ipRegion": "",
"ipDistrict": "",
"ipLongitude": 76.9293,
"ipLatitude": 43.2638
}