Шифрланған деректермен Google Pay арқылы төлем сұрауын жіберуге арналған құжаттама (PAYMENT_GATEWAY):

Төлем жүргізу үшін токен алу (әрбір операция үшін түпнұсқа токен алу және пайдалану қажет)

TEST URL POST https://testoauth.homebank.kz/epay2/oauth2/token
PROD URL POST https://epay-oauth.homebank.kz/oauth2/token


Сұрау салу:

grant_type: "client_credentials" scope: "webapi usermanagement email_send verification statement statistics payment" client_id: "ClientID" client_secret: "clientSecret" InvoiceID: "Order number" amount: 100 currency: "KZT" terminal: "67e34d63-102f-4bd1-898e-370781d0074d"

Жауап:

{
"access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
"expires_in": 7200,
"scope":"webapi usermanagement email_send verification statement statistics payment",
"token_type":"Bearer"
}

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

Жол атауысипаттамаМіндетті/міндетті емес
amountтөлем сомасыміндетті
currencyвалютаміндетті
nameкарта ұстаушының атыміндетті
cryptogramТөлем картасының криптограммаланған параметрлеріміндетті
InvoiceIDТапсырыс нөмірін коммерсант береді, ол әрбір жаңа тапсырыс үшін бірегей болуы тиіс, 6 саннан 15 санға дейін. Егер сіздің тапсырыс нөміріңіздің саны 6 таңбадан асатын болса, онда бірегейлік соңғы 6 таңба бойынша қосымша сақталуы тиісміндетті
invoiceIdAltТапсырыс нөмірін коммерсант береді, ол әрбір жаңа тапсырыс үшін бірегей болуы тиіс, 6 саннан 15 санға дейін.міндетті емес
descriptionБұл жолда төлем жасалатын тауарлар немесе қызметтер туралы ақпарат беріледіміндетті
AccountIdКоммерсант жүйесіндегі клиенттің идентификаторы немесе коммерсанттың қарауы бойынша басқа қосымша параметрміндетті емес
emailклиенттің emailміндетті емес
phoneклиенттің телефоныміндетті емес
postLinkАвторизация нәтижесін дүкенге жіберуге арналған линк.міндетті
failurePostLinkСәтсіз авторизация нәтижесін немесе қате туралы ақпаратты дүкенге жіберуге арналған линк.міндетті емес
cardSaveкартаны сақтау параметрі, true – картаны сақтау, false - сақтамау, boolean typeміндетті
dataҚосымша жол толтырылған кезде есепте таратыладыміндетті емес

Төлем жүргізу

URL: https://epay-api.homebank.kz/payment/cryptopay

Әдіс: POST

Сұрау салу денесі:

json

{
    "amount": 10,
    "currency": "KZT",
    "name": "Test test",
    "terminalId": "b861ab50-8387-46c3-be6e-f439d4492c3c",
    "invoiceId": "80000148",
    "description": "Оплата",
    "accountId": "",
    "email": "nemesis_311@gmail.com",
    "phone": "+77078071180",
    "backLink": "http://example/backLink",
    "failureBackLink": "http://example/failureBackLink",
    "postLink": "http://example/postLink",
    "failurePostLink": "http://example/failurePostLink",
    "cardSave": false,
    "useBonus": false,
    "paymentType": "googlePay",
    "googlePay": {
        "apiVersionMinor": 0,
        "apiVersion": 2,
        "paymentMethodData": {
            "description": "Visa •••• 1111",
            "tokenizationData": {
                "type": "PAYMENT_GATEWAY",
               "token": "{\"signature\":\"MEQCIG0Pt0VSb8/W00fzbPLtO5z3DYNrG1IrU94YI0U3VZw3AiAekJRW2Bcq1+hPbcbBniw9vRNSH2w3+qFX5EcQwkJo1w\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwIIrniC3/DfJjejVaHVsBGZLO9LW9ggLXWaoEVnpZuFgLSH4qEanNlHvZkr6A04aVq/7HgYaxLkotk6ZKSr3qQ\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1695271732552\\\"}\",\"signatures\":[\"MEQCIFurLZqmGGY9jZ+ZL+8iHtdxFRY3VMdKwcxrO0tunvuoAiBywEKS7Q2qwh4SmjY99tNaVYrfr8/Cygd8c/0XoP2K4Q\\u003d\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"5XrIV3etzcSBdH8fgO+eCIxH3jWrGSUPPVXci3s22nD5Ab+9EtihPz/Zc3ODVwINNWOtkqfJxiu3UUaz1LbICfM1I2rhqyANCc35fK+Fd/JZNQv7eFNVVNxVdt2eBiQxPod+2K5v4jCJJkGevdbqQUW1OncL1QXpt8e/dNj1o7CTGCxxV6iN+8DjAo4xyvZJqKsjA3PzzKDhfNdM6zohKcgNqtPP30uI8EGK1PdGQDFCuPYFRYpKCVOx3qibRuI5x46pHV86GLUmMDbETSNOIYnwpOu0RVcMLdb74xQ9awoiXILSSM/IGhQUJnxeUbckzYsqwbZ88Ks6kmbHmCs3oHcgL4Lblt7hE07vW1Y1VJQ05/oTcT98R9WWzKeOTSvA8ru7o3oUxdwww1QIb9VytOz2IbGiI+ZepGehImTxsOUJkG3QwoFevDVDV67cf6KfTxUd97OarcE6Nk3crwO+GIASJw/U5lycj74HRd/h25Fme8TFf6BMmcOHUezy6Tx+iHO5j3P0QMDT0a4bVb8wuUPa0CE1DQH75E+EVSUb2tmRURkqDrDKCN6GP2VCvxqsSzV26zZbl8Xv\\\",\\\"ephemeralPublicKey\\\":\\\"BOmDg7vgShCeyoYT5EgzyV8NGdh3AbDe1yHmf2WRv+tKYlfjd8bhGJnc1hkLVjY80VKFBxUw2eDhqd1bGzXoxQ0\\\\u003d\\\",\\\"tag\\\":\\\"I9P/hCUvJTg+cVO7H+snaOAtACB9J0gySh/LEih0yH8\\\\u003d\\\"}\"}"
               },
            "type": "CARD",
            "info": {
                "cardNetwork": "VISA",
                "cardDetails": "1111"
            }
        }
    }
}


Сұрау салу жолы:

amountCurrency жолында көрсетілген валютамен төлем сомасы.
currencyISO 4217 форматындағы төлем валютасы (мысалы, қазақстандық теңге үшін «KZT»).
nameТөлеушінің аты.
terminalIdТөлемді өңдеуге арналған терминал немесе дүкен идентификаторы.
invoiceIdТөлемге байланысты шот немесе тапсырыс идентификаторы.
descriptionТөлемнің сипаттамасы.
accountIdТөлеуші аккаунтының идентификаторы (егер қолданылса).
emailТөлеушінің электрондық поштасының мекенжайы.
phoneТөлеушінің телефон нөмірі.
backLinkТөлем сәтті аяқталғаннан кейін пайдаланушыны қайта бағыттауға арналған URL.
FailureBacklinkТөлем сәтсіз аяқталған жағдайда пайдаланушыны қайта бағыттауға арналған URL.
postlinkТөлем провайдері сәтті аяқталғаннан кейін төлем мәртебесі туралы кері байланыс жіберетін URL.
failurePostlinkТөлем провайдері сәтсіз аяқталған жағдайда төлем мәртебесі туралы кері байланыс жіберетін URL.
cardSaveБолашақ төлемдер үшін төлеуші картасының деректерін сақтау қажет пе, жоқ па, соны көрсететін жалауша (бұл жағдайда false мәні орнатылған).
useBonusТөлем жасау үшін төлеушінің бонустық қаражатын пайдалану керек пе, жоқ па, соны көрсететін жалауша (бұл жағдайда false мәні орнатылған).
paymentTypeТөлем түрі, бұл жағдайда googlePay мәні орнатылған .
googlePayGoogle Pay пайдалану арқылы төлем туралы ақпаратты қамтитын объект.
apiVersionMinorAPI Google Pay нұсқасы (бұл жағдайда 0 мәні орнатылған).
apiVersionAPI Google Pay нұсқасы (бұл жағдайда 2 мәні орнатылған).
paymentMethodDataПайдаланылатын төлем тәсілі туралы ақпаратты қамтитын объект.
descrptionТөлем тәсілінің сипаттамасы (мысалы, «Visa •••• 1111»).
tokenizationDataТөлем деректерінің токенделуі туралы ақпаратты қамтитын объект.
typeТокендеу түрі (бұл жағдайда PAYMENT_GATEWAY мәні орнатылған).
tokenGoogle жүйесінен алынған токен мәні
typeТөлем тәсілінің түрі (бұл жағдайда CARD мәні белгіленген).
infoТөлем картасы туралы ақпаратты қамтитын объект.
cardNetworkТөлем картасының желісі (мысалы, «VISA»).
cardDetailsТөлем картасы нөмірінің соңғы төрт саны (мысалы, «1111»)

API төлемге сұрауды жібергеннен кейін, сіз төлем мәртебесі туралы ақпаратпен жауаптың алынуын күтесіз. Төлем мәрбтебесін тексеру сервисін пайдаланып жүйеде жауапты сәйкесінше өңдеңіз.

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

Авторизация қажет:

Сұрау салу Токен алу

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 idСату нүктесінің идентификаторы, кабинетте алуға болады, тіркеу кезінде беріледі

Жауап:

{
"access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
"expires_in": 7200,
"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

ЖолСипаттама
100successсұраудың сәтті орындалуы, төлемнің қандай күйде екенін statusName бойынша көру қажет
101rejectсәтсіз транзакция
102invoice not found, try again later or check transaction type (payment/p2p)invoiceId нөмірі жүйеде табылмады, сіздің транзакцияңыз p2p сервисі бойынша өтуі мүмкін
103try again or contact supportсұрауды қайталау немесе қолдау қызметіне жүгіну қажет
104field terminal absent in tokenТокенді сұраған кезде TerminalID параметрі жоқ
106error, incorrect terminalIDТокенді сұраған кездегі қате TerminalID
107IN PROGRESSоперация орындалу процесінде, мәртебені кейінірек сұратыңыз

status name

ЖолСипаттама
REFUNDесептен шығарылған соманы қайтару жүзеге асырылды
AUTHбұғатталған сома
CANCELсома блоктан алынды
CHARGEсома есептен шығарылды
CANCEL_OLDЭмитент жағында авторизацияның күшін жою CHARGE/CANCEL операциясының қолданыс мерзімі аяқталған жағдайда орын алады
FAILEDсәтсіз транзакция
3D3D тексеру кезеңіндегі қателік
NEWоперация құрылды, бірақ әзірге ол аралық күйде (егер сіз осы мәртебені транзакция мәртебесін сұрауды қолмен жүзеге асырған кезде алсаңыз, онда оны өзгертуге болатындығын ескеріңіз)
REJECTсәтсіз төлем әрекеті

Жүйені қайтаратын ықтимал reasonCode https://epayment.kz/kk/docs/kody-oshibok ресурсында орналасқан