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

Авторизация
Авторизация запроса происходит путем формирования и передачи 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
Название параметраНазвание параметраОписаниеТип
request_id
required		Уникальный номер запроса в системе партнера (uuid)string/uuid
country
required		Cтрана резидентства владельца кошелька
(alpha-3)		string
currency
required		Валюта кошелька
(alpha-3)		string
identifiersМассив уникальных идентификатор кошелька в СЭДarray
Ответ
Название параметраОписаниеТип
statusПоказывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		string
request_statusПоказывает статус выполнения запроса. Справочник статусов запроса.string
dtДата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Запрос на идентификацию владельца кошелька

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

Запрос

URL запроса

POST https://.../v5/partner/wallet/identify
Название параметраНазвание параметраОписаниеТип
request_id
required 		Уникальный номер запроса в системе партнера (uuid)string/uuid
identifier
required 		Уникальных идентификатор кошелька от партнера string
owner
required 		Данные владельца кошелька object
first_name
required		 Имя владельца кошелька string
last_name
required		 Фамилия владельца кошелька string
middle_name Отчество владельца кошелька string
birthdate Дата рождения владельца кошелька
YYYY-MM-DD		 date
phone
required 		Номер телефона владельца кошелька integer
email Электронный адрес владельца кошелька string
country
required		 Cтрана резидентства владельца кошелька
(alpha-3)		string
person_id
required		 Идентификатор владельца кошелька в стране резидентства
(для Казахстана ИИН, для РФ ИНН и т.д.)		 string
language Язык общения владельца кошелька
(alpha-2)		 string
document
required		 Скан-копия документа, удостоверяющий личность владельца кошелька

Формат файла pdf
Формат передачи base64

Максимальный размер файла 2 МБ.		 string
address1
required 		Данные адреса регистрации владельца кошелька object
country
required		 Страна регистрации (alpha-3) string
postal_code
required		 Индекс string
address_line1
required		 Город регистрации string
address_line2
required		 Улица регистрации string
address_line3
required		 Здание, помещение регистрации string
address2
required 		Данные адреса проживания держателя карты object
country
required		 Страна проживания (alpha-3) string
postal_code
required		 Индекс string
address_line1
required		 Город проживания string
address_line2
required		 Улица проживания string
address_line3
required		 Здание, помещение проживания string
identification_info
required		 Данные идентификации владельца кошелькаobject
idn_date
required		 Дата прохождения идентификации в формате RFC 3339
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
identified_by
required 		Идентификатор пользователя проведший идентификацию владельца кошелька string
Ответ
Название параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		 string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm 		string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибкиstring
Получить статус обработки запроса

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

Запрос

URL запроса

POST https://.../v5/partner/wallet/request/status
Название параметраОписаниеТип
request_id
required		 Уникальный номер запроса в системе партнера (uuid) string/uuid
Ответ
Название параметраНазвание параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		 string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
identifiers Массив уникальных идентификатор кошелька array
identifiers.*.value Значение идентификатора string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
Ответ
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Получить информацию по кошельку

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

Запрос

URL запроса

POST https://.../v5/partner/wallet/info
Название параметраОписаниеТип
identifier
required		 Уникальный идентификатор кошелька в системе партнера string
Ответ
Название параметраНазвание параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
wallet Объект данных по кошельку object
wallet_id Идентификатор кошелька string/uuid
identifiers Массив уникальных идентификатор кошелька array
identifiers.*.value Значение идентификатора string
owner_id Уникальный идентификатор владельца кошелька string
account_number Номер счета ЭД string
currency Валюта кошелька
(alpha-3)		 string
balance Баланс кошелька в валюте кошелька string
status Статус кошелька string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Запрос на закрытие кошелька

Запрос

URL запроса

POST https://.../v5/partner/wallet/close
Название параметраОписаниеТип
request_id
required		 Уникальный номер запроса в системе партнера (uuid) string/uuid
identifier
required		 Уникальный идентификатор кошелька в системе партнера string
description
required		 Основание (тестовое описание от клиента) string
Ответ
Название параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		 string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Запрос на блокирование кошелька

Запрос

URL запроса

POST https://.../v5/partner/wallet/block
Название параметраОписаниеТип
request_id
required		 Уникальный номер запроса в системе партнера (uuid) string/uuid
identifier
required		 Уникальный идентификатор кошелька в системе партнера string
description
required		 Основание (тестовое описание от клиента) string
Ответ
Название параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		 string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Получить баланс по кошельку

Запрос

URL запроса

POST https://.../v5/partner/wallet/balance
Название параметраОписаниеТип
identifier
required		 Уникальный идентификатор кошелька в системе партнера string
Ответ
Название параметраНазвание параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
balance Объект с информацией по балансам object
сurrency Валюта
(alpha-3)		 string
amount Доступный баланс float
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Получить выписку по кошельку

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

Запрос

URL запроса

POST https://.../v5/partner/wallet/statement
Название параметраОписаниеТип
identifier
required		 Уникальный идентификатор кошелька в системе партнера string
start_date Дата и время начала периода выписки в формате RFC 3339
YYYY-MM-DDThh:mm:ss±hh:mm. 		string
end_date Дата и время окончания периода выписки в формате RFC 3339
YYYY-MM-DDThh:mm:ss±hh:mm. 		string
Ответ
Название параметраНазвание параметраОписаниеТип
status Показывает статус получения запроса
ok - Запрос прошел успешно
error - Запрос прошел с ошибкой		 string
request_status Показывает статус выполнения запроса. Справочник статусов запроса. string
operations Массив данных по операциям array
operations.*.type Тип операции. Справочник типов операций. string
operations.*.amount Сумма операции number
operations.*.commission Сумма комиссии number
operations.*.currency Валюта операции
(alpha-3)		 string
operations.*.datetime Дата и время проведения операции в формате RFC 3339
YYYY-MM-DDThh:mm:ss±hh:mm. 		date
operations.*.rrn Уникальный идентификатор операции string
operations.*.correspondent Объект object
name Наименование корреспондента string
account_number Номер счета ЭД корреспондента string
dt Дата и время запроса в формате RFC 3339.
Формат: YYYY-MM-DDThh:mm:ss±hh:mm		 string
В случае ошибок, будут дополнительные параметры ответа:
Название параметраОписаниеТип
error_code ID кода ошибки string
error_description Текстовое описание ошибки string
Справочники
Справочник типов операций
КодОписание
emoney_sale Реализация электронных денег
emoney_buy Приобретение электронных денег
emoney_emission Эмиссия электронных денег
emoney_transfer Перевод электронных денег
emoney_pay Погашение электронных денег
emoney_servicepay Оплата услуг
Справочник статусов запроса
КодОписание
0 Успешно обработан
1 В обработке
2 Ошибка обработки
Справочник кодов ошибок
КодОписание
1001 Некорректно переданы входящие параметры
1002 Неуникальный идентификатор запроса
1003 Кошелек с указанным идентификатором уже создан
1004 Кошелек с указанным идентификатором не найден
1005 Не удалось закрыть кошелек
1006 Запрос с указанным идентификатором запроса не найден
1007 Кошелек уже закрыт
1008 Не удалось заблокировать кошелек
1009 Кошелек уже заблокирован
9999 Системная ошибка, повторите запрос позже
1000 Сервис недоступен