Запити надсилаються за допомогою методу POST у форматі JSON. Кодування запитів і відповідей UTF-8. Для передачі запитів встановлюється SSL сесія з використанням сертифікатів отриманих в кабінеті мерчанту.
{
"payload": "JVBERi0xLjYNCjBBEFEiE ... lJUVPRg0K"
"signature": "AQAAAAEAACcQAAAAELRJ...2lZX0ypXbrFrKis1DzUUwRCFg=="
}
{
"payload": "JVBERi0xLjYNCjBBEFEiE ... lJUVPRg0K"
} Метод виконує виключно кредитову частину P2P-переказу. Дані дебетової частини приймаються та зберігаються без ініціювання операції списання.
| Параметр | Тип | Обов'язково | Опис |
| merchantTransactionId | string |
Y |
ID транзакції в системі торговця (має бути унікальним в межах merchantid) |
| amount | number | Y | Сума платежу у копійках |
| currency | number(3) | Y | Числовий код валюти платежу по ISO 4217 (тільки 980) |
| sender.pan | string | Y | Primary Account Number карти платника |
| sender.f_name | string(35) | Y | Ім'я платника. тільки латиниця |
| sender.m_name | string(35) | N | По батькові платника. тільки латиниця |
| sender.l_name | string(35) | Y | Фамілія платника. тільки латиниця |
| sender.document | string(10) |
Y |
Номер документа платника валідація document при document_type = 01: 9 цифр 02: 2 великі латинські літери + 6 цифр 03: 10 цифр 04: 8 цифр |
| sender.document_type | string | Y |
Тип документа платника 01 – ID-картка |
| sender.phone | string | N | Номер телефону платника у форматі 380ХХХХХХХХХ |
| receiver.pan | string | Y | Primary Account Number карти отримувача |
| receiver.f_name | string(35) | Y | Ім'я отримувача. тільки латиниця |
| receiver.m_name | string(35) | N | По батькові отримувача. тільки латиниця |
| receiver.l_name | string(35) | Y | Фамілія отримувача. тільки латиниця |
| receiver.document | string(10) |
N якщо в запиті передали параметр receiver.document_type то receiver.document стає обов'язковим |
Номер документа отримувача
валідація document при document_type = 01: 9 цифр 02: 2 великі латинські літери + 6 цифр 03: 10 цифр 04: 8 цифр |
| receiver.document_type | string |
N якщо в запиті передали параметр receiver.document то receiver.document_type стає обов'язковим |
Тип документа отримувача 01 – ID-картка |
| receiver.phone | string | N | Номер телефону отримувача у форматі 380ХХХХХХХХХ |
| purpose | string (256) | N | Призначення платежу |
{
"merchantTransactionId": "11223344aBC",
"amount": 35000,
"currency": 980,
"sender":{
"pan":"1111222233334444",
"f_name":"First",
"m_name":"Middle",
"l_name":"Last",
"phone":"380502223344",
"document_type":"02",
"document":"MP234760"
},
"receiver":{
"pan":"4444333322221111",
"f_name":"First",
"m_name":"Middle",
"l_name":"Last",
"phone":"380501112233",
"document_type":"01",
"document":"999999999"
},
"purpose":"Переказ власних коштів",
}
| Параметр | Тип | Опис |
| status | string | Статус виконання запиту |
| data.operationId | number | ID операції в Системі E-COMM |
| data.pan | string | Primary Account Number карти отримувача |
| data.amount | number | Сума платежу в копійках |
| data.status | string |
Статус виконання операції CREATED - операція створена |
| data.authorization.rrn | number | Reference Retrieval Number |
| data.authorization.approvalCode | string | Approval Code |
| data.authorization.stan | string | STAN |
| data.createdUTC | string | Дата та час створення запиту |
| data.updatedUTC | string | Дата та час отримання фінального статусу |
{
"status": "OK",
"data": {
"operationId": 123456,
"pan": "4444 **** **** 1111",
"amount": 35000,
"status": "SUCCESS",
"authorization": {
"rrn": 52010006177,
"approvalCode": "015182",
"stan": "006176"
},
"createdUTC": "20-JAN-24 11.59.37.285108",
"updatedUTC": "21-JAN-24 08.00.04.709618"
}
}
| Параметр | Тип | Опис |
| status | string | Статус результату запиту. Якщо запит виконано з помилкою, значення "FAILED". |
| error.code | number | Код помилки e-com. |
| error.message | string | Текст помилки. |
| error.details.operationId | number | id неуспішної операції |
| error.details.ebppError | number | Код відмови процесування |
| error.details.rrn | number | Ідентифікатор транзакції в МПС (RRN) |
| error.details.approvalCode | string | Код авторизації |
| error.details.stan | string | Системний код авторизації |
{
"status": "FAILED",
"error": {
"code": 142,
"message": "Error EBPP. 907",
"details": {
"operationId": 221693123,
"ebppError": 907,
"rrn": 633134657983,
"approvalCode": "273581",
"stan": "236476"
}
}
}