Формaт взаимодействия

В Feennex API есть несколько основных сущностей:

• Платеж – нужен для приема оплаты от плательщика. Платеж содержит всю информацию о платеже
• Выплата – нужна для вывода денег со счета магазина вашим клиентам.

Процесс оплаты зависит от выбранного сценария интеграции

Oсновы

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бр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
}