Подать заявку

С вами кто-то свяжется в ближайшее время

Оставьте заявку на подключение

Ваша заявка принята в обработку. Вам ответят на электронную почту в рабочем порядке.

Спасибо за обращение

Создать сайт

Tilda — это один из конструкторов, с помощью которого можно собрать свой сайт из готовых блоков

Создайте сайт на <a>Tilda</a>

Подробнее

Придите в филиал АО «Народного банка Казахстана» и менеджер поможет Вам подписать договор

Подпишите договор

Быстрый старт вашего интернет - магазина, без навыков программирования

Мы подготовили для вас подробную инструкцию

Видеоинструкция

Когда сайт готов и договор подписан, необходимо подключить модуль к Вашему сайту

Подключите модуль ePay

# API
## Oauth

>> URL test https://testoauth.homebank.kz/epay2  
>> URL prod https://epay-oauth.homebank.kz

[Получение токена](https://developer.homebank.kz/epay/api/poluchenie-tokena)  
[Обновление токена](https://developer.homebank.kz/epay/api/obnovlenie-tokena)  
[Отзыв токена](https://developer.homebank.kz/epay/api/otzyv-tokena)  

## API

>> URL test https://testepay.homebank.kz/api

>> URL prod https://epay-api.homebank.kz

* [Отмена платежа](https://developer.homebank.kz/epay/api/cancel)  
* [Подтверждение/Частичное подтверждение](https://developer.homebank.kz/epay/api/podtverzhdenie-chastichnoe-podtverzhdenie-operacii)  
* [Возврат/Частичный возврат](https://developer.homebank.kz/epay/api/vozvrat-chastichnyi-vozvrat)

# Описания работы сервиса P2P по API

__Для работы через API компании необходимо наличие сертификации PCI DSS__

При регистрации вам будут выданы данные, которые нужно будет использовать при проведении перевода:

|            |            |
| ---------- | ---------- |
| TerminalID       | Идентификатор магазина |
| ClientID       | Идентификатор клиента |
| ClientSecret       | Секретный ключ |

__Тестовый коммерсант__
|            |            |
| ---------- | ---------- |
| URL        | https://test-epay.homebank.kz/login |
| email      | epay@halykbank.kz |
| password   | XZG1E@Mm       |
| ClientID   | test       |
| ClientSecret      | yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG     |
| TerminalID    | c36b282f-6819-4d4f-85df-a4bdc8a8f703 |

### Тестовые карты

| PAN                  | Expire Date   | CVC  | Status |
| -------------------- | ------------- | ---- | ------ |
| 4405639704015096     | 01/25         | 815  | unlock |
| 5522042705066736     | 01/25         | 525  | unlock |
| 377514500004820      | 01/25         | 4169 | unlock |
| 4003032704547597     | 09/20         | 170  | lock   |
| 5578342710750560     | 09/20         | 254  | lock   |

__Получение токена для проведения перевода__
```
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:          "transfer"
invoiceID:      "12321312312"
amount:         "100"
currency        "KZT"
client_id:      "test"
client_secret:  "yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG"
terminal:       "c36b282f-6819-4d4f-85df-a4bdc8a8f703"

```

| Поле     | Описание     |
| ---------- | ---------- |
| grant_type       | тип авторизации, для проведения платежа используется тип авторизации: client_credentials  |
| invoiceID     | Номер заказа, генерируется коммерсантом, должен быть уникальный для каждого нового заказа,от 6 до 15 цифр. Если ваш номер заказа содержит более 6 символов, то дополнительно уникальность должна соблюдаться по последним 6ти символам    |
| amount     | сумма     |
| currency     | валюта     |
| scope       | ресурс      |
| client_id       | Идентификатор коммерсанта, можно получить в кабинете, выдается при регистрации     |
| client_secret       | Ключ доступа коммерсанта, можно получить в кабинете, выдается при регистрации       |
| terminal     | Идентификатор точки продаж, можно получит в кабинете, выдается при регистрации      |

__Ответ__
 ```
    {
      "access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
      "expires_in": 7200,
      "refresh_token":"",
      "scope":"transfer",
      "token_type":"Bearer"
    }

  ```

| Поле    | Описание     |
| ---------- | ---------- |
| access_token      | Токен для проведения операции       |
| expires_in       | Время истечения токена      |
| refresh_token     | Не используется при данном типе авторизации    |
| scope       | Ресурс, для проведения платежа используется ресурс transfer    |
| token_type      | Тип авторизации     |

После получения токена, необходимо передавать его в __Headers Bearer DCEB8O_ZM5U7SO_T_U5EJQ__ 

на эндпоинт: 
```
TEST URL https://testepay.homebank.kz/api/p2p/transfer
PROD URL https://epay-api.homebank.kz/p2p/transfer
```

метод POST, в теле запроса в формате JSON указывать след структуру: 

Body: raw

```
{
  "order": {
    "amount": 100,
    "currency": "KZT",
    "description": "TEST p2p",
    "merchantIdForSavingCards": "",
    "id": "123456787538",
    "senderIP": "",
    "senderEmail": "armanali@epay.kz",
    "foreign": false,
    "terminalId": "c36b282f-6819-4d4f-85df-a4bdc8a8f703",
    "backLink": "https://epay.homebank.kz/demo/success.html",
    "failureBackLink": "https://epay.homebank.kz/demo/failure.html",
    "postLink": "https://epay.homebank.kz/payform",
    "failurePostLink": "https://testmerchant/order/1123/fail"
  },
  "card": {
    "sender": {
      "save": false,
      "transferType": "TYPEPAN",
      "address": "",
      "cvc": "951",
      "cardCred": "4003039802969821",
      "expire": {
        "month": "09",
        "year": "23"
      },
      "name": "Sergey Frolov",
      "number": ""
    },
    "receiver": {
      "save": false,
      "id": "",
      "transferType": "TYPEPAN",
      "cardCred": "5578342728230613",

    }
  }
}

```

__Описание полей отправителя sender:__

| Поле     | Описание     |
| ---------- | ---------- |
| Amount       | Сумма заказа       |
| currency       | Валюта       |
| description       | Описание заказа       |
| merchantIdForSavingCards       | Cell       |
| Id       | Номер заказа, генерируется коммерсантом, должен быть уникальный для каждого нового заказа,от 6 до 15 цифр. Если ваш номер заказа содержит более 6 символов, то дополнительно уникальность должна соблюдаться по последним 6ти символам      |
| senderIP       | IP отправителя(не обязательно)     |
| senderEmail       | email клиента (не обязательно)      |
| Foreign       | false       |
| terminalId       | Идентификатор магазина       |
| backLink       | Ссылка для возврата в магазин при удачном платеже      |
| failureBackLink       | Ссылка для возврата в магазин при не удачном платеже      |
| postLink       | Уведомление о платеже      |
| failurePostLink       | Уведомление о неудачном платеже, если не заполнено, то информация будет отправлена на адрес указанный в postLink      |
| Save       | Сохранить карту – true, не сохранять - false      |
| transferType       | Тип проведения перевода, "TYPEPAN"  - по номеру карты, "TYPECARDID"  - по сохраненной карте epay|
| Address       | Адрес      |
| Cvc       | сvv      |
| Id       | cardid     |
| Month       | месяц      |
| Year       | год      |
| Name       | Имя      |
| cardCred       | Номер карты отправителя/ id карты    |

__Описание полей получателя receiver__

| Поле     | Описание     |
| ---------- | ---------- |
| save       | Сохранить карту – true, не сохранять - false      |
| id       | cardid       |
| cardCred       | Номер карты получателя      |
| firstName       | Имя - только для переводов зарубеж     |
| lastName       | Фамилия - только для переводов зарубеж       |
| countryCode       | Код страны - только для переводов зарубеж   |

__Ответ в случае успеха:__

```

{
    "id": "a9e1b986-be01-4763-9216-610cc63b963c",
    "amount": 200,
    "currency": "KZT",
    "email": "epay@halykbank.kz",
    "description": "TEST p2p",
    "reference": "204978430339",
    "orderID": "1234567893774576",
    "senderCardID": "88481433-595e-4c01-941f-34569db2426e",
    "senderCardPAN": "4003********9821",
    "receiverCardID": "86496cb0-bb5d-4791-bb49-cc27a0f660ce",
    "receiverCardPAN": "5578********0613",
    "intReference": "6BD1808D0FF129B0",
    "terminalID": "95555555"
}

```

__Ответ в случае неудачи:__

```
{
    "code": 487,
    "message": " Not permitted to merchant",
    "invoiceId": "8161284658525",
    "id": "",
    "reference": "",
    "accountId": "uuid000001"
}

```

Переводы по API

# Возврат/частичный возврат

__Возврат может быть осуществлён только в том случае если транзакция имеет статус Charge, то есть до этого она была полностью проведена__

__Минимальная сумма возврата 10 тенге__

Требуется Client credentials [авторизация](https://epayment.kz/ru/docs/poluchenie-tokena) 

__> Полный возврат__

```
TEST URL: POST  https://testepay.homebank.kz/api/operation/:id/refund
PROD URL: POST  https://epay-api.homebank.kz/operation/:id/refund

```

*Id указанный в URL это id транзакции который вы получили ранее в postlink после удачной оплаты или при запросе статуса транзакции*

__Частичный возврат__

```
TEST URL: POST  https://testepay.homebank.kz/api/operation/:id/refund?amount=300&externalID=1223123hfkdgk34508etf7
```

*опциональный параметр amount, если он не заполнен то подтверждение идет на полную сумму*

*externalID* - внутренний индентификатор возврата для коммерсанта. 

```
Headers
    Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
```

```
Responce

Http status 200
```

### Error

```
Http status 400
{
    "code": 100,
    "message": ""
}
```

Возврат\частичный возврат

Возврат/частичный возврат

# Обновление токена

> URL POST /oauth2/token

```
Request

Request Header
    device_id:         "69f3db46-8092-4094-8910-bb6e3d6ba969"
    ip:                "10.3.23.42"
    fingerprint:       "asdasdfr90a7889a7sdasd9"

Request Body:
    grant_type:        "refresh_token"
    scope:             "api"
    client_id:         "CLIENTID"
    client_secret:     "CLIENTSECRET"
    refresh_token:     "OYKAYN6HXLUOG520FDPJCW"
Response

{
    "access_token": "T0KO0PKDPG6WSUZNQMZR6W",
    "expires_in": 7200,
    "scope": "api",
    "token_type": "Bearer"
}
```

Обновление токена

# Операции
Получение данных по операциям массивом

```
TEST URL https://testepay.homebank.kz/api/operations
PROD URL https://epay-api.homebank.kz/operations
```

Требуется [авторизация](https://epayment.kz/ru/docs/poluchenie-tokena) 

**Тип авторизации: Password credentials**

**scope: webapi usermanagement email_send verification statement statistics payment**

Входные параметры передаются в виде JSON:
Модель представлена в следующем виде:
```
{
 "paging":{
 "page": ,
 "size": 
 },
 "searchParameters":[
 {
 "name":"",
 "method":"",
 "searchParameter":["","",...]
 }
 ],
 "orderParameters":[
 {
 "field":"",
 "typeOrder":"ASC/DESC"
 }
 ]
}
```

В блок "paging" , необходимо передавать два параметра:
"page" - количество записей которые необходимо пропустить;
"size" - количество записей которые необходимо вывести на странице.

В блок "searchParameters", необходимо передавать три параметра, так же можно производить поиск по множеству полей (в примере запроса показано как)
"name" - наименование поля(фильтра) по которому будет происходить поиск в БД, список представлен ниже ;
"method" - метод поиска (указывать в следующем виде : between, in, like , = , < , > , <= , >= ) ; 
"searchParameter" - параметры поиска.При использование метода поиска between необходимо передавать 2 параметра, при использование like, передавать один параметр который содержит знак %, при методе поиска in необходимо использовать минимум 1 параметр.
В случае не корректно переданных параметров , будет возвращаться ошибка.
В запросе необходимо указывать период транзакций. Данный параметр поиска является обязательным.

В блок "orderParameters", можно передавать два параметра:
"field" - наименование поля по которому будет происходить сортировка;
"typeOrder" - тип сортировки ASC/DESC.
Данный блок можно можно оставить пустым если нет необходимости в сортировке или производить сортировку по нескольким полям (представлено в примере ниже).

**Внимание! Метод поиска по created_date обязательный**

Фильтры:

 Описание | Название |
 ----------------------------- | -------- |
 Дата транзакции | created_date | 
 Магазин | shop_id |
 №Заказа | invoice_id |
 ID клиента в магазине клиента | account_id |
 Телефон | payer_phone |
 Email | payer_email |
 РРН | reference |
 PostLink | post_link(bool) |
 Сумма | amount |
 Карта | card_mask | 
 Плательщик | client |
 Рассрочка | installment_id |
 Тип транзакции | transaction_type_id |
 Возврат дата | payout_date |
 Возврат сумма | payout_amount | 

Пример запроса, JSON: 
```json
{
 "paging":{
 "page": 0,
 "size": 2
 },
 "searchParameters":[
 {
 "name":"created_date",
 "method":"between",
 "searchParameter":["2017-11-19T00:00:00Z", "2018-11-20T00:00:00Z"]
 },
 {
 "name":"description",
 "method":"in",
 "searchParameter":["description"]
 },
 {
 "name":"payer_email",
 "method":"like",
 "searchParameter":["danatugumbayeva%"]
 }
 ],
 "orderParameters":[
 {
 "field":"payer_email",
 "typeOrder":"ASC"
 },
 {
 "field":"description",
 "typeOrder":"DESC"
 }
 ]
}
```
Ответ возвращается в виде JSON:
```json
{
 "totalCount": 2,
 "records": [
 {
 "id": "b9d46313-264e-41ec-814c-728dd51eb97f",
 "amount": 1000,
 "orgAmount: 1000,
 "currency": "KZT",
 "amountBonus": 80,
 "invoiceId": "",
 "accountId": "",
 "payerIp": "10.6.50.57",
 "payerName": "Dana Tugumbayeva",
 "payerPhone": "77029085001",
 "payerEmail": "dana@gmail.com",
 "description": "description",
 "data": "",
 "createdDate": "2018-10-27T15:08:14+06:00",
 "authDate": "2018-10-27T15:08:14+06:00",
 "confirmDate": "2018-10-27T15:08:14+06:00",
 "payoutDate": "2018-12-29T00:01:01.374084+06:00",
 "payoutAmount": 1000,
 "ipCountry": "",
 "ipCity": "",
 "ipRegion": "",
 "ipDistrict": "",
 "ipLatitude": 0,
 "ipLongitude": 0,
 "cardType":"MasterCard",
 "issuer":"Казкоммерцбанк",
 "issuerBankCountry":"",
 		"status":"AUTH",
 		"reference":"034580951245",
 		"client":"polisonline",
 		"language":"RU",
 		"failureLink":"https://page.site.kz/failureLink",
 		"postLink":"https://page.site.kz/postLink",
 		"postLinkStatus":true,
 		"merchant":"merchantName",
 		"shop":"merchantShop",
 		"secure3D":false,
 		"cardMask":"5483...0413",
 		"installment":null,
 		"resultCode":"00",
 		"resultMessage":""
 },
 {
 "id": "b9d46313-264e-41ec-814c-728dd525877f",
 "amount": 500,
 "orgAmount: 1000,
 "currency": "KZT",
 "amountBonus": 80,
 "invoiceId": "",
 "accountId": "",
 "payerIp": "10.6.50.57",
 "payerName": "Dana Tugumbayeva",
 "payerPhone": "77029085001",
 "payerEmail": "eldar@gmail.com",
 "description": "description",
 "data": "",
 "createdDate": "2018-10-27T15:08:14+06:00",
 "authDate": "2018-10-27T15:08:14+06:00",
 "confirmDate": "2018-10-27T15:08:14+06:00",
 "payoutDate": "2018-12-29T00:01:01.374084+06:00",
 "payoutAmount": 0,
 "ipCountry": "",
 "ipCity": "",
 "ipRegion": "",
 "ipDistrict": "",
 "ipLatitude": 0,
 "ipLongitude": 0,
 "cardType":"MasterCard",
 "issuer":"Казкоммерцбанк",
 "issuerBankCountry":"",
 		"status":"CHARGE",
 		"reference":"034580958547",
 		"client":"polisonline",
 		"language":"RU",
 		"failureLink":"https://page.site.kz/failureLink",
 		"postLink":"https://page.site.kz/postLink",
 		"postLinkStatus":true,
 		"merchant":"merchantName",
 		"shop":"merchantShop",
 		"secure3D":false,
 		"cardMask":"5483...0413",
 		"installment":null,
 		"resultCode":"00",
 		"resultMessage":""
 }
 ]
}
```
Ответ об ошибке возвращается в виде JSON:
```json
{
 "code": 232,
 "message": "Метод поиска отсутствует"
}
```

Операции

Запрос операций по оплатам списком

# Отзыв токена

> URL DELETE /connect/token

```
Request

Headers
    Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
Responce

HTTP CODE 200
```

Отзыв токена

# Отмена

> URL: POST /operation/:id/cancel  

Требуется Client credentials [авторизация](https://epayment.kz/ru/docs/poluchenie-tokena) 

__Полная отмена__

```
URL TEST POST https://testepay.homebank.kz/api/operation/:id/cancel 
URL PROD POST https://epay-api.homebank.kz//operation/:id/cancel
```

*Id указанный в URL это id транзакции который вы получаете после успешного заполнения клиентом платёжной формы, приходящий в postlink. Либо узнать id транзакции можно запросив статус.
Разблокировку средств на карте можно произвести только в том случае если транзакция находится в статусе Auth*

```
Headers
    Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
```

```
Response

Http status 200
```

### Error

```
{
    "code": 100,
    "message": ""
}
```

Отмена оплаты

# Тестовые данные
## Данные для проведения тестовых платежей: 
|            |         | 
| ---------- | ---------- |
| url       | https://test-epay.homebank.kz   |
| email       | epay@halykbank.kz     |
| password       | XZG1E@Mm       |
| ClientID       | test       |
| ClientSecret       | yF587AV9Ms94qN2QShFzVR3vFnWkhjbAK3sG     |
| TerminalID       | 67e34d63-102f-4bd1-898e-370781d0074d       |

### Карты для тестирования:

| PAN                  | Expire Date   | CVC  | Status |
| -------------------- | ------------- | ---- | ------ |
| 4405639704015096     | 01/25         | 815  | unlock |
| 5522042705066736     | 01/25         | 525  | unlock |
| 377514500004820      | 01/25         | 4169 | lock |
| 4003032704547597     | 09/20         | 170  | lock   |
| 5578342710750560     | 09/20         | 254  | lock   |

Тестовые данные

# Списание/частичное списание

> Полное списание

Требуется Client credentials [авторизация](https://epayment.kz/ru/docs/poluchenie-tokena) 

```
URL TEST POST https://testepay.homebank.kz/api/operation/:id/charge
URL PROD POST https://epay-api.homebank.kz/operation/:id/charge
```

*Для полного или частичного подтверждения оплаты необходимо чтобы транзакция находилась в статусе Auth.*

> Частичное списание 

```
TEST URL: POST  https://testepay.homebank.kz/api/operation/:id/charge?amount=300
PROD URL: POST  https://epay-api.homebank.kz/operation/:id/charge?amount=300
```

*опциональный параметр amount, если он не заполнен то списание идет на полную сумму, также можно указывать полную сумму в параметре*

или в json body

```
{
    "amount": 2400
}
```
допустимо передавать значения в обоих параметрах, в таком случае значения должны быть идентичными
```

Headers
    Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
```

```
Response

Http status 200
```

### Error 
```
Http status 400.x

{
    "code": 100,
    "message": ""
}
```

Подтверждение/частичное подтверждение оплаты

# Получение списка сохраненных карт
```
URL TEST GET https://testepay.homebank.kz/api/cards/:accountId
URL PROD GET https://epay-api.homebank.kz/cards/:accountId
```

```
Headers
    Authorization: Bearer dGVzdGNsaWVudDpzZWNyZXQ=
```

```
Response

Http status 200

Responce Body:

[
    {
        "ID": "6845e5d5-35cc-428e-bd95-e85f78cb59d1",
        "TransactionId": "a4b8c500-ddbf-4475-b512-60cd5a9189f7",
        "MerchantID": "1a8ca610-73eb-4996-a2ef-5ec1d57bf573",
        "CardHash": "ac2d26319b1910692db0e357e88a3d02cd9e7867d72e6d2c6f4f48e61a46201e",
        "CardMask": "4405...2283",
        "PayerName": "TEST",
        "Reference": "034680043232",
        "IntReference": "005224F86969006E",
        "Token": "A5011A20B136418774169BC24030C63B",
        "Terminal": "98458031",
        "CreatedDate": "2020-12-11T15:47:58.828909+06:00",
        "PaymentAvailable": false,
        "AccountID": "testuser1"
    },
    {
        "ID": "a436211c-ede4-479f-a9db-2db2d392e34b",
        "TransactionId": "97bac35c-8bf3-496a-be77-8e9eb449783d",
        "MerchantID": "1a8ca610-73eb-4996-a2ef-5ec1d57bf573",
        "CardHash": "1b2aea5eb284955c4e18c8d6289e5eb59c091199fd5f9861d09dbd26b1862119",
        "CardMask": "4405...3681",
        "PayerName": "TEST",
        "Reference": "101478049099",
        "IntReference": "C5006F368549CC7C",
        "Token": "FBDA466B628544D294750DA9B211D3CC",
        "Terminal": "98458031",
        "CreatedDate": "2021-01-14T10:28:22.418199+06:00",
        "PaymentAvailable": false,
        "AccountID": "testuser1"
    },
    {
        "ID": "73cfea54-984d-48a5-b7d4-5af5473b2361",
        "TransactionId": "73f13bf6-1d3c-4234-9d57-94a0cb64784f",
        "MerchantID": "1a8ca610-73eb-4996-a2ef-5ec1d57bf573",
        "CardHash": "8894abac4bd183781b580a4e814295773a497822eeefdfb130f7c8414842ed32",
        "CardMask": "4405...2817",
        "PayerName": "TEST",
        "Reference": "101481049101",
        "IntReference": "DF9641E3F0AED452",
        "Token": "79DEF615A266413C68F9710315B082AF",
        "Terminal": "98458031",
        "CreatedDate": "2021-01-14T10:51:22.491067+06:00",
        "PaymentAvailable": false,
        "AccountID": "testuser1"
    },
    {
        "ID": "89fe31cb-4e64-4171-ad80-a364108e61e5",
        "TransactionId": "2df0160b-607c-4227-ab70-2f6a93ab828b",
        "MerchantID": "1a8ca610-73eb-4996-a2ef-5ec1d57bf573",
        "CardHash": "6257ce459bc48fa5205c025181da7cf2e7568cb07428b127544e0d4043d92296",
        "CardMask": "4405...1206",
        "PayerName": "TEST",
        "Reference": "101481049104",
        "IntReference": "6A50F85C03040E83",
        "Token": "62D54B1F3B22498FBBBB31CC4A7BAA81",
        "Terminal": "98458031",
        "CreatedDate": "2021-01-14T11:36:20.721898+06:00",
        "PaymentAvailable": false,
        "AccountID": "testuser1"
    },
    {
        "ID": "60bf3ecc-58af-4b1d-b081-b7f3485b1f5c",
        "TransactionId": "5ee29078-e17e-49f0-aba5-3c6ad7953113",
        "MerchantID": "1a8ca610-73eb-4996-a2ef-5ec1d57bf573",
        "CardHash": "f934e44abc31e19441f80ebed5c8e2c2fe3215185919bc50273cbff60d928499",
        "CardMask": "4405...2206",
        "PayerName": "TEST",
        "Reference": "101481049105",
        "IntReference": "3154F37D704BD9F0",
        "Token": "F0BD5BAEC2174BD24E8773975E2EC648",
        "Terminal": "98458031",
        "CreatedDate": "2021-01-14T11:45:29.235698+06:00",
        "PaymentAvailable": false,
        "AccountID": "testuser1"
    }
]
```

Если нет сохранных карт по указанному accountId:

```
Response

Http status 200

Responce Body:
{
    "code": 1373,
    "message": "Запись не найдена!"
} 
```

### Error(если запрос некорректный) 
```
{
    "code": 100,
    "message": ""
}
```


Получение списка сохраненных карт

# Получение токена

> URL POST /oauth2/token

```
URL test https://testoauth.homebank.kz/epay2
URL prod https://epay-oauth.homebank.kz
```

## Client credentials

```
Request

Request Body:
    grant_type:         "client_credentials"
    scope:              "webapi usermanagement email_send verification statement statistics payment"
    client_id:          "CLIENTID"
    client_secret:      "CLIENTSECRET"

Responce

{
    "access_token": "DCEB8O_ZM5U7SO_T_U5EJQ",
    "expires_in": 7200,
    "scope": "webapi",
    "token_type": "Bearer"
}
```

## Error

```
HTTP code 4XX.X 
```

## Password credentials
```
Request

Request Header
    deviceid:          "69f3db46-8092-4094-8910-bb6e3d6ba969"	//не обязательное
    ip:                "10.3.23.42"								//не обязательное
    fingerprint:       "asdasdfr90a7889a7sdasd9"				//не обязательное

Request Body:
    grant_type:        "password"
    username:          "USERNAME"
    password:          "USERPASSWORD"
    scope:             "api"
    client_id:         "CLIENTID"
    client_secret:     "CLIENTSECRET"

Responce

{
    "access_token":"f2288c2b-1d08-4aac-a210-d62c0901f915",
    "token_type":"bearer",
    "refresh_token":"3f94522d-5a5a-4a22-bc85-f5f5a56920b4",
    "expires_in":43199
}
```

## Error

```
HTTP code 4XX.X 
```

Получение токена


# Статус транзакции

```
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
```

**Требуется авторизации: client credentials**

### Запрос

__Получение токена__
```
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** | Идентификатор точки продаж, можно получит в кабинете, выдается при регистрации |

### Ответ
```json
{
  "access_token":"DCEB8O_ZM5U7SO_T_U5EJQ",
  "expires_in": 7200,
  "refresh_token":"",
  "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",
        "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

|Поле|Описание||
|-------------|-------------|-------------|
| **100** |	success  |   успех выполнения запроса, в каком состоянии находиться платеж необходимо смотреть по statusName|
| **101** |	reject   | транзакция неуспешная |
| **102** |	invoice not found, try again later or check transaction type (payment/p2p)        | номер invoiceId не найден в системе, возможно ваша трназакция проходила по сервису p2p |
| **103** |	error, try again or contact support | необходимо повторить запрос либо обратиться в службу поддержки | 
| **104** |	field terminal absent in token | отстусвует параметр TerminalID при запросе токена|
| **107** |	IN PROGRESS | операция в процессе выполнения, запросите статус позже|

### statusName

Поле|Описание
-------------|-------------|
| **REFUND** |	был осуществлён возврат списанной суммы|
| **AUTH** |	сумма в блоке |
| **CANCEL** |	сумма разблокирована|
| **CHARGE** |	сумма списана |
| **FAILED** |	транзакция неуспешная | 
| **3D** |	ошибка на стадии проверки 3D|
| **NEW** |	операция создалась но пока находится в промежуточном состоянии (если вы получили этот статус при запросе статуса транзакции вручную, то примите во внимание что он может быть изменён)|
| **REJECT** |	неуспешная попытка оплаты|
