Авторизация запроса происходит путем формирования и передачи JWS токена запроса в заголовке X-JWS-Signature. JWS это часть токена JWT, которая содержит только header и signature.
Формат передаваемых данных application/json.
Пример формирования подписи
Тело запроса:
aaaaaaaa
Заголовок JWT токена:
ddddddddddd
ssssssssssss
Эта строка является подписью запроса и должна быть передана в параметре заголовка запроса X-JWS-Signature.
Метод позволяет выпустить карту с выбранным продуктом.
Запрос
URL запроса
POST https://.../v5/card-api/card/issue
Название параметра;Название параметра;;Описание;Тип
request_id<br>required ;;; Уникальный номер запроса в системе партнера (uuid);string/uuid
product_id<br>required ;;; Код продукта выпускаемой карты; integer
cardholder<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трана резидентства держателя карты (alpha-3)<br>string
;person_id<br>required ;; Идентификатор держателя карты в стране резидентства (для Казахстана ИНН, для РФ ИИН и т.д.); string
;language;; Язык общения держателя карты<br>(alpha-2); string
;document<br>required ;; Скан-копия документа, удостоверяющий личность<br>Формат файла pdf<br>Формат передачи base64<br>Максимальный размер файла 2 МБ.; string
;external_user_id;; Идентификатор клиента в системе партнера; string
;address1<br>required ;; Данные адреса регистрации держателя карты; object
;;country<br>required; Страна регистрации<br>(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; Страна проживания<br>(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:m string
;identified_by<br>required;; Идентификатор пользователя проведший идентификацию клиента; string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
dt; Дата и время запроса в формате RFC 3339. <br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Получить статус обработки запроса
Метод позволяет получить статус обработки запроса по request_id.
Запрос
URL запроса
POST https://.../v5/card-api/request/status
Название параметра;Описание;Тип
request_id<br>required; Уникальный номер запроса в системе партнера (uuid); string/uuid
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
card_id; Идентификатор выпущенной карты; string
dt; Дата и время запроса в формате RFC 3339. <br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm ;string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Получить список карт клиента
Метод позволяет получить список карты выпущенных для одного клиента.
Запрос
URL запроса
POST https://.../v5/card-api/client/cards/list
Название параметра;Описание;Тип
client_id<br>required; Идентификатор клиента, которому выпущена карта; string
Ответ
Название параметра;Название параметра;Название параметра;Описание;Тип
status ;;;Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; ;; Показывает статус выполнения запроса. Справочник статусов запроса.;string
cards ;;; Массив с данными карт клиента; array
;card_id;;Идентификатор выпущенной карты;string
;cards.*.product_id ;; Код продукта выпускаемой карты; integer
;cards.*.card_mask ;; Маскированный номер карты (часть цифр номера карты скрыты).<br>Пример: 5483-18XX-XXXX-0293; string
;cards.*.card_month ;; Месяц окончания срока выпущенной карты<br>Количество цифр: 2; integer
;cards.*.card_year;; Год окончания срока выпущенной карты<br>Количество цифр: 2 ; integer
;cards.*.first_name ;; Имя держателя карты; string
;cards.*.last_name ;; Фамилия держателя карты; string
;cards.*.status ;; Статус карты; string
;cards.*.iban;; Номер счета; string
;cards.*.balances;; Массив с информацией по балансам; array
;;balances.*.сurrency; Валюта<br>(alpha-3); string
;;balances.*.amount; Доступный баланс; float
;;balances.*.blocked_amount; Заблокированный баланс; float
dt ;;; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Запрос на выпуск физической карты
Запрос
URL запроса
POST https://.../v5/card-api/card/print
Название параметра;Описание;Тип
request_id<br>required; Уникальный номер запроса в системе партнера (uuid); string/uuid
card_id<br>required; Идентификатор ранее выпущенной карты ;string
first_name<br>required; Имя держателя карты (Латиница); string
last_name<br>required; Фамилия держателя карты (Латиница); string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
dt; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Получить информацию по карте
Метод позволяет по card_id получить информацию по карте.
Запрос
URL запроса
POST https://.../v5/card-api/card/info
Название параметра;Описание;Тип
card_id<br>required; Идентификатор ранее выпущенной карты; string
Ответ
Название параметра;Название параметра;Название параметра;Описание;Тип
status;;; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status;;; Показывает статус выполнения запроса. Справочник статусов запроса.;string
card ;;; Данные по карте клиента; object
;product_id;; Код продукта выпускаемой карты; integer
;card_mask;; Маскированный номер карты (часть цифр номера карты скрыты).<br>Пример: 5483-18XX-XXXX-0293; string
;card_month;; Месяц окончания срока выпущенной карты<br>Количество цифр: 2; integer
;card_year;; Год окончания срока выпущенной карты<br>Количество цифр: 2;integer
;first_name;; Имя держателя карты; string
;last_name;; Фамилия держателя карты; string
;status;; Статус карты; string
;iban;; Номер счета; string
;balances;; Массив с информацией по балансам; array
;;balances.*.сurrency; Валюта<br>(alpha-3); string
;;balances.*.amount; Доступный баланс; float
;;balances.*.blocked_amount; Заблокированный баланс; float
dt;;; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки ;string
Получить секретные карточные данные
Запрос
URL запроса
POST https://.../v5/card-api/card/secret_info
Название параметра;Описание;Тип
card_id<br>required; Идентификатор ранее выпущенной карты; string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
card_pan; Полный номер карты.<br>Пример: 5483183333330293 ;string
card_cvc; CVC/CVC2/CVV пароль карты Цифры.; integer
dt; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Запрос на закрытие карты
Запрос
URL запроса
POST https://.../v5/card-api/card/close
Название параметра;Описание;Тип
request_id<br>required; Уникальный номер запроса в системе партнера (uuid); string/uuid
card_id<br>required; Идентификатор ранее выпущенной карты; string
description <br>required; Основание (тестовое описание от клиента); string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса. ;string
dt; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm ;string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description ;Текстовое описание ошибки; string
Запрос на блокирование карты
Запрос
URL запроса
POST https://.../v5/card-api/card/block
Название параметра;Описание;Тип
request_id<br>required; Уникальный номер запроса в системе партнера (uuid) ;string/uuid
card_id<br>required; Идентификатор ранее выпущенной карты; string
description<br>required ;Основание (тестовое описание от клиента); string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
dt; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description ;Текстовое описание ошибки; string
Получить баланс по карте
Запрос
URL запроса
POST https://.../v5/card-api/card/balance
Название параметра;Описание;Тип
card_id<br>required ;Идентификатор ранее выпущенной карты; string
Ответ
Название параметра;Название параметра;Описание;Тип
status; ; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; ; Показывает статус выполнения запроса. Справочник статусов запроса.; string
balances; ; Массив с информацией по балансам; array
;balances.*.сurrency; Валюта<br>(alpha-3); string
;balances.*.amount; Доступный баланс; float
;balances.*.blocked_amount; Заблокированный баланс; float
dt;; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code; ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Получить выписку по карте
Метод позволяет получить выписку по карте. Если период не определен, то выписка будет содержать последние 10 операций. Максимальный период выгрузки – 12 месяцев.
Запрос
URL запроса
POST https://.../v5/card-api/card/statement
Название параметра;Описание;Тип
card_id<br>required; Идентификатор ранее выпущенной карты; string
start_date; Дата и время начала периода выписки в формате RFC 3339<br>YYYY-MM-DDThh:mm:ss±hh:mm.; string
end_date; Дата и время окончания периода выписки в формате RFC 3339<br>YYYY-MM-DDThh:mm:ss±hh:mm. ;string
Ответ
Название параметра;Название параметра;Название параметра;Описание;Тип
status;;; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status;;; Показывает статус выполнения запроса. Справочник статусов запроса.;string
operations;;; Массив данных по операциям; array
;operations.*.type;; Тип операции. Cправочник типов операций.; string
;operations.*.amount;; Сумма операции; number
;operations.*.commission;; Сумма комиссии; number
;operations.*.currency;; Валюта операции<br>(alpha-3); string
;operations.*.mcc ;; Merchant Category Code; number
;operations.*.datetime;; Дата и время проведения операции в формате RFC 3339<br>YYYY-MM-DDThh:mm:ss±hh:mm.; date
;operations.*.rrn;; Уникальный идентификатор операции; string
;operations.*.merchant;; Объект ;object
;;name; Наименование; string
;;country ;Страна (alpha-3); string
;;address_line1; Город; string
;;postal_code; Индекс; string
;;url; сайт
dt ;;; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code ;ID кода ошибки; string
error_description; Текстовое описание ошибки; string
Установить пин-код по карте
Запрос
URL запроса
POST https://.../v5/card-api/card/set_pin
Название параметра;Описание;Тип
card_id<br>required; Идентификатор ранее выпущенной карты; string
pin<br>required; PIN карты. Длина 4 символа, цифры от 0 до 9.<br>Пример: 1234; string
Ответ
Название параметра;Описание;Тип
status; Показывает статус получения запроса<br>ok - Запрос прошел успешно<br>error - Запрос прошел с ошибкой; string
request_status; Показывает статус выполнения запроса. Справочник статусов запроса.; string
dt; Дата и время запроса в формате RFC 3339.<br>Формат: YYYY-MM-DDThh:mm:ss±hh:mm; string
В случае ошибок, будут дополнительные параметры ответа:
Название параметра;Описание;Тип
error_code ;ID кода ошибки; string
error_description; Текстовое описание ошибки ;string
Справочники Справочник кодов продуктов карты
Код;Описание;
1000; Visa Wallet Card
Справочник типов операций
Код;Описание;
A1; Снятие наличных в банкомате
a1; Отмена снятия наличных в банкомате
C1; Снятие наличных в кассе(через POS-терминал)
c1; Отмена снятия наличных в кассе(через POS-терминал)
CB; Снятие наличных в банкомате по коду(без карты)
cb; Отмена снятия наличных в банкомате по коду(без карты)
TA; Списание средств с карты (AFT)
ta; Отмена списания средств с карты (AFT)
T0; Зачисление средств на карту (OCT)
t0; Отмена зачисления средств на карту (OCT)
K1; Зачисление средств на карту(чаще всего используется для возврата в POS-терминале)
k1; Отмена зачисления средств на карту(чаще всего используется для возврата в POS-терминале)
AN; Взнос наличных в банкомате
an; Отмена взноса наличных в банкомате
R1; Покупка
r1; Отмена/возврат покупки
U1; Покупка (квази-кэш)
u1; Отмена/возврат покупки (квази-кэш)
Справочник статусов запроса
Код;Описание;
0; Успешно обработан
1; В обработке
2; Ошибка обработки
Справочник кодов ошибок
Код;Описание;
12001; Некорректно переданы входящие параметры
12002; Неуникальный идентификатор запроса
12003; Код продукта не найден
12004; Запрос с указанным идентификатором запроса не найден
12006; Карта с указанным идентификатором не найдена
12007; Клиента с указанным идентификатором не найдена
12008; Не удалось выпустить физическую карту
12009; Не удалось открыть карту
12010; Не удалось закрыть карту
12011; Карта уже закрыта
12012; Не удалось заблокировать карту
12013; Карта уже заблокирован
12014; Не удалось установить пин-код
9999; Системная ошибка, повторите запрос позже
1000; Сервис недоступен