Формат взаємодії: GET та POST запити на відповідні URL в домені fc-pay.gerc.ua. Всі POST запити відправляються, та відповіді надаються в тілі у форматі JSON в кодуванні UTF-8. Всі приклади наведеній в цій документації є ілюстративними для демонстрації структури запитів і відповідей та не можуть бути використані для роботи з API “як є”.
POST запити в систему мають загальний формат:
|
Вкладеність |
Параметр |
Обов'язковість |
Тип |
Розмірність |
Опис |
|---|---|---|---|---|---|
| 1 | data | Так | object | – | Дані запиту |
| 1 | signature | Ні | string | 40 символів | Цифровий підпис |
{
"data":{"partner_id":4,"paydata":[{"point_id":42,"amount":17000,"description":"Тестовий"}],"order_id":"909910","api_ver":"1"},
"signature":"07d38398e0e6d594dae41c00237c4de5dd9890e1"
}
Зверніть увагу! Весь запит повинен передаватися єдиною строкою, без пробілів і переносів. В прикладах цієї документації пробіли и переноси присутні задля кращої читаємості, але не повинні бути у справжніх запитах до системи.
Зверніть увагу! Весь текст не повинен містити жодного екранування: ані символів тексту, ані спецсимволів, за виключенням обов'язкового екранування для відповідності формату JSON.
Ідентифікація партнера та визначення отримувачів коштів відбувається за допомогою параметрів partner_id та point_id:
Для отримання partner_id та point_id необхідно передати до ТОВ "Фінансова компанія “ГЕРЦ” перелік необхідних реквізитів або узгодити передачу банківських реквізитів онлайн. Кількість point_id в одному платежі необмежена. Один і той самий point_id можна використати в одному запиті декілька разів.
Усі запити повинні містити електронний підпис. Також підпис містять всі нотифікації та відповіді про успішну сплату.
Алгоритм отримання підпису:
sha1(sha1(data) + sha1(partner_id+ partner_key))
де символ “+” означає строкову конкатенацію, а “sha1()” – використанння алгоритму підпису SHA1 у шістнадцятковому (hexadecimal) форматі.
де,
| Параметр | Опис | Приклад |
| data | "Корисні" дані. JSON без пробілів та переносів | {"partner_id":4,"backref_url":"https://fc-pay.gerc.ua/","notify_url":"https://fc.gerc.ua/", "user_ip":"8.8.8.8","paydata":[{"point_id": 22,"amount": 800,"description": "testdescr2"},{"point_id": 42,"amount": 200,"description":"testdescr1"}],"api_ver":1} |
| partner_id | ID партнера (надається менеджерами ГЕРЦ) | 4 |
| partner_key | Ключ партнера (надається менеджерами ГЕРЦ) | 12345 |
Отриманий рядок потрібно вставити в JSON запит у поле signature.
{
"data":{...},
"signature":"d32ead604549c44a5edbe78a32466aca15a29372"
}