Описания работы сервиса P2P по API
Для работы через API компании необходимо наличие сертификации PCI DSS
При регистрации вам будут выданы данные, которые нужно будет использовать при проведении перевода:
TerminalID | Идентификатор магазина |
ClientID | Идентификатор клиента |
ClientSecret | Секретный ключ |
Тестовый коммерсант
URL | https://test-epay.homebank.kz/login |
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"
}