Документация для API-интерфейса создания счетов в системе электронных платежей ePay:
Получения токена:
Метод: 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": "2e975b11-a904-4b11-af5b-ccd834df47ef",
"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 (строка, необязательный) | - URL-адрес, на который будет отправлен POST-запрос после успешной оплаты счета. |
failure_post_link (строка, необязательный) | - URL-адрес, на который будет отправлен POST-запрос в случае неуспешной оплаты счета. |
Ответ:
{ "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": "0d4d345e-8566-43bd-b046-028b5aee6406" }
Поле | Описание |
---|---|
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 |