EPay электрондық төлемдер жүйесінде шоттарды құру API-интерфейсіне арналған құжаттама:
Тестілеуге арналған деректер:
ClientID | halykfinanceUSD |
ClientSecret | U01gQZVL##lJ$NhJ |
TerminalID | d9d7978c-d6ee-4ec0-8cda-165251a4bf16 |
Shop_ID | 04f25a4b-d2bd-4dd8-b3a7-9390be4774c4 |
halykfinanceUSD@halykbank.nb | |
password | XVp36qar |
Токенді алу:
Әдісі: POST
TEST URL POST https://testoauth.homebank.kz/epay2/oauth2/token PROD URL POST https://epay-oauth.homebank.kz/oauth2/token
Request OAuth 2.0
Body: form-data
grant_type: "password" username: "halykfinanceUSD@halykbank.nb" password: "XVp36qar" scope: "api" client_id: "halykfinanceUSD" client_secret: "U01gQZVL##lJ$NhJ"
Responce
{ "access_token":"f2288c2b-1d08-4aac-a210-d62c0901f915", "token_type":"bearer", "refresh_token":"3f94522d-5a5a-4a22-bc85-f5f5a56920b4", "expires_in":43199 }
URL:
URL prod https://epay-api.homebank.kz/invoice URL test https://testepay.homebank.kz/api/invoice
тестілеуге арналған деректер:
shop_id prod: e16cfde-f3e9-49c6-8cf9-2d3f080f739c shop_id test: 04f25a4b-d2bd-4dd8-b3a7-9390be4774c4
Кіру параметрлері: Әдісі: JSON
{
"shop_id": "04f25a4b-d2bd-4dd8-b3a7-9390be4774c4",
"account_id": "0003413423",
"invoice_id": "25458124232312321",
"amount": 100,
"language": "rus",
"description": "asdasdasdas",
"expire_period": "1d",
"recipient_contact": "EXAMPLE@halykbank.kz",
"recipient_contact_sms": "+777711111111",
"notifier_contact_sms": "",
"currency": "KZT",
"post_link": "https//mail.ru",
"failure_post_link": "https//mail.ru",
"back_link":"https//mail.ru",
"failure_back_link":"https//mail.ru"
}
Жолы | Сипаттамасы |
---|---|
shop_id (жолы) | Дүкен ID-і, жүйе дүкенді тіркеу кезінде береді, міндетті |
account_id (жолы) | epay жүйесіндегі дүкен шотының нөмірін коммерсант жасайды, міндетті |
invoice_id (Жолы) | дүкен жүйесіндегі бірегей нөмір сәйкестендіргіші, коммерсант жасайды, міндетті |
amount (сан) | шот сомасы, міндетті |
language (жолы) | шот туралы ақпарат ұсынылуы тиіс тіл (рұқсат етілген мәндер: "rus", "kaz", "eng"), міндетті |
description (жолы) | шоттың сипаттамасы, рұқсат етілген таңбалар саны 125, міндетті |
expire_period (жолы) | шоттың қолданылу кезеңі. Форматы: «[сан] [уақыт бірлігі]», мұнда уақыт бірлігі «d» (күндер) мәні. Мысалы, «2d» - шот екі күн ішінде жарамды, міндетті |
recipient_contact (жолы) | шот алушының электрондық мекенжайы, міндетті |
recipient_contact_sms (жолы) | шот алушының «+7XXXXXXXXXX» форматындағы ұялы телефон нөмірі, міндетті |
notifier_contact_sms (толтыруға міндетті емес жол) | төлем туралы хабарламаларды жіберуге арналған «+7XXXXXXXXXX» форматындағы ұялы телефон нөмірі. |
currency (жолы) | шот валютасы (рұқсат етілген мәндер: "KZT"), міндетті |
post_link (толтыруға міндетті емес жол) | шотты сәтті төлегеннен кейін POST-сұрау салуға жіберілетін URL-мекенжайы. |
failure_post_link (толтыруға міндетті емес жол) | шотты төлеу сәтсіз болған жағдайда POST-сұрау салуға жіберілетін URL-мекенжайы. |
Жауап:
{ "id": "afc1ce64-da89-41f7-afbf-2748ddaf3501", "shop_id": "4e16cfde-f3e9-49c6-8cf9-2d3f080f739c", "amount": 100, "invoice_id": "25458124232312321", "language": "rus", "currency": "KZT", "description": "asdasdasdas", "account_id": "0003413423", "recipient_contact": "EXAMPLE@halykbank.kz", "recipient_contact_sms": "+777711111111", "notifier_contact": "", "notifier_contact_sms": "+777711111111", "expire_period": "2d", "post_link": "", "failure_post_link": "", "created_date": "2023-03-28T10:04:10.997074088+06:00", "expire_date": "2023-03-30T10:04:10.997074088+06:00", "status": "ACTIVE", "updated_date": "0001-01-01T00:00:00Z", "invoice_url": "https://epay-api.homebank.kz/redirect/invoice-link/afc1ce64-da89-41f7-afbf-2748ddaf3501", "merchant_id": "65b0d0b8-9a95-45fc-ad58-725e45b093a0", "terminal_id": "d9d7978c-d6ee-4ec0-8cda-165251a4bf16" }
Жолы | Сипаттамасы |
---|---|
id (жол) | ePay жүйесіндегі шоттың бірегей сәйкестендіргіші |
shop_id (жол) | ePay жүйесінде тіркелген дүкен сәйкестендіргіші |
amount (сан) | шот сомасы |
invoice_id (жол) | дүкен жүйесіндегі шоттың бірегей сәйкестендіргіші, 6-дан 15 цифрға дейін |
language (жол) | шот туралы ақпарат берілген тіл |
currency (жол) | шот валютасы |
description (жол) | шоттың сипаттамасы |
account_id (жол) | дүкен шотының сәйкестендіргіші |
recipient_contact (жол) | шот алушының электрондық мекенжайы |
recipient_contact_sms (жол) | ұялы телефон нөмірі |
expire_period (жол) | шоттың қолданылу кезеңі |
terminal_id (GUID) | ePay жүйесіндегі виртуалды терминал нөмірі |