Партнерам | Электронные деньги

Freedom Docs

Freedom Docs

Электронные деньги

Авторизация

Авторизация запроса происходит путем формирования и передачи JWS токена запроса в заголовке X-JWS-Signature. JWS это часть токена JWT, которая содержит только header и signature.

Формат передаваемых данных application/json.

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

Тело запроса:

{
    "request_id": "828cf71d-a447-4a67-a149-c1df8bc197ca",
    "country": "KAZ",
    "currency": "KZT"
}

Заголовок JWT токена:

{
    "uri": "/v5/partner/wallet/add",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}

Ключ партнера может быть secret_key. В этом случае может быть сформирован следующий JWT токен:

eyJ1cmkiOiIvdjUvcGFydG5lci93YWxsZXQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0X2lkIjoiODI4Y2Y3MWQtYTQ0Ny00YTY3LWExNDktYzFkZjhiYzE5N2NhIiwiY291bnRyeSI6IktBWiIsImN1cnJlbmN5IjoiS1pUIn0.5xVbhml5y1Uw1TYQ_djwwefFz8y_CnX-ajzNvOBCcmE

Эта строка является подписью запроса и должна быть передана в параметре заголовка запроса X-JWS-Signature.

eyJ1cmkiOiIvdjUvcGFydG5lci93YWxsZXQvYWRkIiwiYXV0aF9pZCI6IjEyMzQ1NiIsIm1ldGhvZCI6IlBPU1QiLCJwYXJhbXMiOiIiLCJhbGciOiJIUzI1NiJ9..5xVbhml5y1Uw1TYQ_djwwefFz8y_CnX-ajzNvOBCcmE

Поддерживаемый алгоритм шифрования подписи HS256.

Запрос на открытие кошелька

Метод позволяет открыть не идентифицированный кошелек в системе электронных денег (Далее СЭД).

Запрос

URL запроса

POST https://.../v5/partner/wallet/add

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Запрос на идентификацию владельца кошелька

Метод позволяет предоставить данные владельца кошелька для присвоения кошельку статуса полностью идентифицированного.

Запрос

URL запроса

POST https://.../v5/partner/wallet/identify

request_id<br>required ; ;; Уникальный номер запроса в системе партнера (uuid);string/uuid identifier<br>required ;;; Уникальных идентификатор кошелька от партнера; string owner<br>required ; ;; Данные владельца кошелька; object ;first_name<br>required; ; Имя владельца кошелька; string ;last_name<br>required; ; Фамилия владельца кошелька; string ;middle_name; ; Отчество владельца кошелька; string ;birthdate; ; Дата рождения владельца кошелька<br>YYYY-MM-DD; date ;phone<br>required ;; Номер телефона владельца кошелька; integer ;email;; Электронный адрес владельца кошелька; string ;country<br>required; ; Cтрана резидентства владельца кошелька<br>(alpha-3);string ;person_id<br>required; ; Идентификатор владельца кошелька в стране резидентства<br>(для Казахстана ИИН, для РФ ИНН и т.д.); string ;language;; Язык общения владельца кошелька<br>(alpha-2); string ;document<br>required;; Скан-копия документа, удостоверяющий личность владельца кошелька<br><br>Формат файла pdf<br>Формат передачи base64<br><br>Максимальный размер файла 2 МБ.; string ;address1<br>required ;; Данные адреса регистрации владельца кошелька; object ;; country<br>required; Страна регистрации (alpha-3); string ;; postal_code<br>required; Индекс; string ;; address_line1<br>required; Город регистрации; string ;; address_line2<br>required; Улица регистрации; string ;; address_line3<br>required; Здание, помещение регистрации; string ;address2<br>required ;; Данные адреса проживания держателя карты; object ;; country<br>required; Страна проживания (alpha-3); string ;; postal_code<br>required; Индекс; string ;; address_line1<br>required; Город проживания; string ;; address_line2<br>required; Улица проживания; string ;; address_line3<br>required; Здание, помещение проживания; string identification_info<br>required;; ; Данные идентификации владельца кошелька;object ;idn_date<br>required; ; Дата прохождения идентификации в формате RFC 3339<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string ;identified_by<br>required ;; Идентификатор пользователя проведший идентификацию владельца кошелька; string

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Получить статус обработки запроса

Метод позволяет получить статус обработки запроса по request_id.

Запрос

URL запроса

POST https://.../v5/partner/wallet/request/status

Ответ

Ответ

Получить информацию по кошельку

Метод позволяет получить информацию по кошельку.

Запрос

URL запроса

POST https://.../v5/partner/wallet/info

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Запрос на закрытие кошелька

Запрос

URL запроса

POST https://.../v5/partner/wallet/close

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Запрос на блокирование кошелька

Запрос

URL запроса

POST https://.../v5/partner/wallet/block

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Получить баланс по кошельку

Запрос

URL запроса

POST https://.../v5/partner/wallet/balance

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Получить выписку по кошельку

Метод позволяет получить выписку по кошельку. Если период не определен, то выписка будет содержать последние 10 операций. Максимальный период выгрузки – 12 месяцев.

Запрос

URL запроса

POST https://.../v5/partner/wallet/statement

Ответ

В случае ошибок, будут дополнительные параметры ответа:

Справочники
Справочник типов операций

Справочник статусов запроса

Справочник кодов ошибок