Skip to main content

Формaт взаємодії​

У Feennex API є кілька основних сутностей:

  • Платіж – потрібен для прийому оплати від платника. Платіж містить усю інформацію про платіж
  • Виплата – потрібна для виводу грошей зі рахунку магазину вашим клієнтам.

Процес оплати залежить від обраного сценарію інтеграції

Основи​

Feennex API побудоване на принципах REST. Кожен запит в API пов’язаний із виконанням певної дії над платежем або виплатою, наприклад створення чи отримання статусу.

Feennex API використовує HTTP, що робить його сумісним із розробкою будь-якою мовою програмування, яка підтримує HTTP-бібліотеки (наприклад, Requests, Httpx, Axios, Guzzle та інші).

API endpoint: https://core.feennex.com/<метод API>

API підтримує POST та GET-запити. POST використовує JSON для аргументів, а GET — рядкові запити. API завжди повертає відповідь у форматі JSON, незалежно від типу запиту.

Під час надсилання запиту до Feennex API потрібно вказати заголовок "Content-Type: application/json" і щоразу генерувати підпис за допомогою вашого секретного ключа. Секретний ключ можна отримати в особистому кабінеті.

Якщо ви не передали обов’язкові параметри, у відповіді повернеться помилка з поясненням, якого параметра бракує в запиті.

Для роботи з API Feennex ви можете використовувати готові бібліотеки для мов Python та PHP.

Oбрoбкa відповідей​

Feennex API обробляє отриманий запит негайно та повертає результат обробки. Відповідь містить код відповіді HTTP, стандартні заголовки та тіло відповіді у форматі JSON.
У тілі відповіді повертаються такі параметри:

  • data — містить дані, специфічні для кожного запиту. Тип – object.
  • error_code — містить код помилки. Тип - number. Приклад: 0 – помилок немає. Докладніше про можливі коди помилок
  • result — показує, пройшов запит успішно чи ні. Тип – boolean. Приклад: true
  • message — містить опис помилки. Тип – string. Приклад: "Ok". За значенням цього параметра можна дізнатися, що пішло не так.

Формат відповіді​

Тіло відповіді при успіху​

Формат тіла відповіді — JSON. Параметри тіла відповіді залежать від запиту.

Приклад тіла відповіді

{
  "data": {
    "data": {
      "session_id": "3067894a580242dd86e03890506a88b"
    },
    "id": 499564464,
    "method": "GET",
    "url": "https://example.com"
  },
  "error_code": 0,
  "message": "Ok",
  "result": true
}

Тіло відповіді при помилці Якщо із запитом щось не так, повернеться тіло відповіді у форматі JSON з кодом помилки. Докладніше про коди помилок Приклад тіла відповіді при неправильно сформованому підписі

{
    "data": null,
    "error_code": 10,
    "message": "Invalid sign, string_to_sign: 500:840:card_usd:6199:99991",
    "result": false
}