Introduction

Введение

Тип запроса POST.
Формат запросов application/json.

Заголовки запроса:

X-Action - Вызываемый метод.

X-Request-Id - Уникальный ID запроса UUID.

Accept-Language - Язык ответов системы (на данный момент не используется).

X-JWS-Signature - Подпись запроса. Подробнее описано ниже.

Content-Type - Должен содержать значение application/json.

Accept - Должен содержать значение application/json.

Заголовки ответа:

X-Action - метод

X-Request-Id - Уникальный ID запроса UUID.

X-Datetime - Дата и время обработки запроса.

X-Request-Status - Статус обработки запроса

API содержит 3 основных URL:

api.freedompay.uz/v5/g2g/create - создание объекта в системе PG.

api.freedompay.uz/v5/g2g/read - получение информации об объекте.

api.freedompay.uz/v5/g2g/edit - обновление информации об объекте.

Объект в платежной системе представляет собой сущность или ресурс, с которым взаимодействует система для обработки платежей и управления финансовыми операциями. Этот объект может быть платежом, картой, счетом и т.д. Объект содержит набор атрибутов, характеризующих его свойства, состояние и историю операций. Взаимодействие с объектом осуществляется через API платежной системы, позволяющее выполнять различные операции, такие как создание, получение, обновление и удаление объектов, а также выполнение дополнительных действий в контексте конкретного объекта.

Формирование подписи X-JWS-Signature

Для отправки любого запроса необходимо сформировать подпись запроса по технологии JWS
Формат JWS должен содержать обязательные блоки header и signature и передаваться в заголовке запроса X-JWS-Signature.
Состав header (все поля являются обязательными):

{
    "uri": "/v5/g2g/create",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}

Поле	Описание
uri	Передается путь, по которому вызывается АПИ
auth_id	ID пользователя для проверки подписи
method	Метод запроса
params	Зарезервированное поле
alg	Алгоритм шифрования

Состав Payload:
В payload для формирования jws передается тело HTTP запроса
Поддерживаемый алгоритм шифрования подписи HS256 и в качестве ключа подписи должно применяться secret_key мерчанта

Пример формирования подписи:
Header

{
    "uri": "/v5/g2g/create",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}

Payload

{
  "amount": 123.42,
  "currency": "KZT",
  "description": "description",
  "order_id": "order_id",
  "user_id": "user_id",
  "auto_clearing": true,
  "from": {
    "type": "card",
    "card": {
      "name": "CARD HOLDER",
      "pan": "1234567890123456",
      "cvc": "012",
      "year": 24,
      "month": 1
    },
    "save": true,
    "recurrent": {
      "lifetime": 3
    }
  },
  "device": {
    "user_ip": "123.123.123.123"
  },
  "urls": {
    "check_url": "https://webhook.site/2af177da-0d72-4651-a31e-a0ea56ccc8a4",
    "result_url": "https://webhook.site/2af177da-0d72-4651-a31e-a0ea56ccc8a4"
  }
}

Ключ шифрования - 123456
Полученный jws:

eyJ1cmkiOiIvdjUvZzJnL2NyZWF0ZSIsImF1dGhfaWQiOiIxMjM0NTYiLCJtZXRob2QiOiJQT1NUIiwicGFyYW1zIjoiIiwiYWxnIjoiSFMyNTYifQ..82NnkgrNjfYu2UnAajnVsJUn2AgJWsqnmCK4x5A7zt0

Введение#

Заголовки запроса:#

Заголовки ответа:#

API содержит 3 основных URL:#

Формирование подписи X-JWS-Signature#

Введение

Заголовки запроса:

Заголовки ответа:

API содержит 3 основных URL:

Формирование подписи X-JWS-Signature