Дисклеймер

QR коды жасалғаннан кейін 20 минуттан кейін, егер QR кодқа соңғы мәртебе берілмесе (PAID, REJECTED), онда QR коды жойылады және оны төлеу мүмкін емес және транзакция бас тартылған (REJECTED)деп белгіленеді

1. Токен генерациясы

Request

TEST URL POST https://test-epay-oauth.epayment.kz/oauth2/token 
PROD URL POST https://epay-oauth.homebank.kz/oauth2/token

Body: form-data

grant_type: "client_credentials"
client_id: "CLIENTID"
client_secret: "CLIENTSECRET"
scope: "webapi usermanagement email_send verification statement statistics payment"
terminal: "TERMINALID"
invoiceID: "invoiceID"
amount: "100"
currency: KZT

Кіріс параметрлері

Response

{
    "access_token": "access token",
    "expires_in": "1200",
    "refresh_token": "",
    "scope": "payment",
    "token_type": "Bearer"
}

Жауап деректері:

2. QR генерациясы

Request

TEST URL POST https://test-epay-api.epayment.kz/payment/qr/generate  
PROD URL POST https://epay-api.homebank.kz/payment/qr/generate 
Авторизация: Алдыңғы қадамда қол жетімділік белгісі бар Bearer тақырыбы.
Payload:
Payload түрі: JSON

Body: form-data

{
  "accountId": "your account id",
  "payerEmail": "payer@mail.com",
  "payerPhone": "87777777777",
  "postLink": "https://example.com/postlink",
  "failurePostLink": "https://example.com/failurepostlink",
  "description": "payment purpose",
  "data": "",
  "language": "ru"
}

Кіріс параметрлері

Response

{
  "qrcode": "qr code",
  "homebankLink": "homebank deeplink",
  "onlinebankLink": "online bank deeplink",
  "status": "NEW",
  "billNumber": 123456
}

Жауап деректері:

Ықтимал қате кодтары

– қате коды-217. HTTP коды-400: Terminal параметрі таңбалауышты жасау кезінде берілмейді

– қате коды-218. HTTP коды-400: Таңбалауыш пайда болған кезде invoiceID параметрі берілмейді

– қате коды-563. HTTP коды-400: Таңбалауышта берілген терминал идентификаторы арқылы терминал деректерін алу қатесі

– қате коды-219. HTTP коды-400: Терминалда pay_qr_local параметрі өшірілген

– қате коды-1531. HTTP коды-400: Payload қа жіберілген құрылымды талдау қатесі

– қате коды-220. HTTP коды-400: QR генерациялау кезіндегі қате

3. Төлем мәртебесін алу

Request

TEST URL GET https://test-epay-api.epayment.kz/qr  
PROD URL GET https://epay-api.homebank.kz/qr 
Authorization: QR генерациясында қолданылатын кіру таңбалауышы бар Bearer тақырыбы.
Payload: Бос.

Response

{
    "qrcode": "00020101021227400012KZ.HALYKBANK0108HSBKKZKX02089830130028660011477859186730120KZ8160101310001554340208983013000301N0501006010520447845303398540420005802KZ5907KINO.KZ6006ALMATY62380111477859186730803191101204074000842363046CA2",
    "status": "NEW",
    "reference": "",
    "cardId": "",
    "cardType": "",
    "cardMask": "",
    "trType": "LOCALQR",
    "secure3D": false,
    "openwayId": "",
    "issuer": "HSBKKZKX",
    "issuerBankCountry": "KZ",
    "fee": 0,
    "amount": 2000,
    "currency": "KZT",
    "paymentChannel": "",
    "errDescription": "",
    "retCode": ""
}

Жауап деректері:

QR төлемін қайтару

1. Токен генерациясы

TEST URL POST https://test-epay-oauth.epayment.kz/oauth2/token 
PROD URL POST https://epay-oauth.homebank.kz/oauth2/token

Body: form-data

grant_type: "client_credentials"
client_id: "CLIENTID"
client_secret: "CLIENTSECRET"
scope: "webapi usermanagement email_send verification statement statistics payment"
terminal: "TERMINALID"
invoiceID: "invoiceID"
amount: "100"
currency: KZT

Кіріс параметрлері

Response

{

    "access_token": "access token",
    "expires_in": "1200",
    "refresh_token": "",
    "scope": "payment",
    "token_type": "Bearer"
}

Жауап деректері:

2. Қайтару жүргізу

Толығырақ: https://epayment.kz/docs/vozvrat-chastichnyi-vozvrat

TEST URL POST https://test-epay-api.epayment.kz/operations/:id/refund 
PROD URL POST https://epay-api.homebank.kz/operation/:id/refund
Id указl мекенжайында көрсетілген бұл транзакция идентификаторы сіз сәтті төлем жасағаннан кейін немесе транзакция күйін сұраған кезде postlink-те бұрын алған.

Body: form-data

{
  "amount": 100,
  "purpose": "refund purpose"
}

Кіріс параметрлері

Response

{
  "code": 3225,
  "externalID": "",
  "message": "in progress"
}

Жауап деректері:

Қосымша: Қайтару туралы сұраныс жіберілген кезде, қайтару тек басталады, бірақ бірден жүргізілмейді. Сәтті қайтару сұрауына жауап ретінде сіз "in_progress" хабарламасын аласыз, қайтару күйін check status арқылы алуға болады.

Check status QR төлем сипаттамасы

https://epayment.kz/docs/check-status-payment

Төлем немесе қайтару туралы ақпаратты алу жауаптағы бір өрісті қоспағанда, құжаттамадағыдай болады. Транзакция объектісінде QR транзакциялары үшін қосымша "paymentType" өрісі беріледі: "QR".