Запит дозволяє отримувати Кредитним організаціям дані Bankid по позичальниках, власникам карт ПриватБанку і Абанк.
Параметри запиту
Запит c необхідними параметрами формується на стороні продавця та передається методом POST по протоколу HTTP на URL https://api.wayforpay.com/api
З метою підтвердження валідності даних повинно бути згенеровано і передано в запиті HMAC_MD5 контрольний підпис з використанням SecretKey торговця.
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів merchantAccount, card (merchantAccount, recToken) розділених ";" (крапка з комою) в кодуванні UTF-8
| Параметр | Опис | Обов'язкове |
|---|---|---|
| apiVersion | Версія протоколу. Значення за замовчуванням: 1 | так |
| transactionType | GET_CLIENT | так |
| merchantAccount | Ідентифікатор продавця. Дане значення присвоюється Вам з боку WayForPay | так |
| merchantSignature | Підпис запиту | так |
| card | Номер карти 16 цифр | ні |
| recToken | Токен карти - для повторного списання без участі клієнта (без передачі реквізитів картки) | ні |
Увага! Повинен бути обов'язково переданий один з параметрів card або recToken.
Параметри відповіді:
| Параметр | Опис | Приклад |
|---|---|---|
| lastName | Прізвище власника карти | Іванов |
| firstName | Ім'я власника карти | Іван |
| middleName | По батькові власника картки | Іванович |
| | email власника карти | |
| phone | Номер телефону власника карти | +380633333333 |
| birthDay | Дата народження | 21.12.1980 |
| inn | ІПН власника карти | 123456789 |
| sex | Стать | M |
| resident | Країна власника карти | UA |
| processedDate | Час отримання запиту. Формат utc timestamp | 1507294262 |
| modifiedDate | Час обробки. Формат utc timestamp | 1505692800 |
| addresses | Масив даних адрес клієнтів | |
| documents | Масив документів по клієнту | |
| reason | Причина відмови | Ok |
| reasonCode | Код відмови | 1100 |
| merchantSignature | hash_hmac |
Аутентифікація запитів
З метою підтвердження валідності даних повинно бути згенеровано і передано в запиті HMAC_MD5 контрольний підпис з використанням SecretKey торговця.
Рядок, що підлягає HMAC_MD5, генерується шляхом конкатенації параметрів reasonCode; processingDate розділених ";" (крапка з комою) в кодуванні UTF-8
Приклад запиту і відповіді
Запит
{
"APIVERSION":1,
"TRANSACTIONTYPE": "GET_CLIENT",
"MERCHANTACCOUNT": "TEST_MERCH_N1",
"MERCHANTSIGNATURE": "4F00E7C84B027B010A3FB54975A826B4",
"RECTOKEN": "55111111-1111-0000-9988-68C457123456"
}
Відповідь
{
"REASONCODE": 1100,
"REASON": "OK",
"LASTNAME": "ИВАНОВ",
"FIRSTNAME": "ИВАН",
"MIDDLENAME": "ИВАНОВИЧ",
"PHONE": "+380123456789",
"EMAIL": "EMAIL@MAIL.COM",
"BIRTHDAY": "01.01.1980",
"INN": "123456789",
"SEX": "M",
"RESIDENT": "UA",
"PROCESSEDDATE": 1607894262,
"MODIFIEDDATE": 1605992800,
"ADDRESSES": [
{
"TYPE": "BIRTH",
"COUNTRY": "UA",
"STATE": NULL,
"CITY": NULL,
"STREET": "НЕТ УЛИЦЫ",
"HOUSE": NULL,
"FLAT": NULL,
"MODIFIEDDATE": 159828761
},
{
"TYPE": "FACTUAL",
"COUNTRY": "UA",
"STATE": "КИЕВСКАЯ",
"CITY": "КИЕВ",
"STREET": "КОВАЛЕВА",
"HOUSE": "100",
"FLAT": "70",
"MODIFIEDDATE": 1887622186
}
],
"DOCUMENTS": [
{
"TYPE": "PASSPORT",
"SERIES": "АА",
"NUMBER": "123456",
"ISSUE": "ШЕВЧЕНКОВСКИМ РО УМВД УКРАИНЫ В КИЕВСКОЙ ОБЛАСТИ",
"ISSUECOUNTRY": "UA",
"DATEISSUE": "1998-01-01",
"MODIFIEDDATE": 1456864446
}
]
}