Cards API | Платежные карточки

Платежные карточки

Авторизация

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

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

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

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

{
    "request_id": "828cf71d-a447-4a67-a149-c1df8bc197ca"
}

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

{
    "uri": "/v5/card-api/request/status",
    "auth_id": "123456",
    "method": "POST",
    "params": "",
    "alg": "HS256"
}

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

eyJ1cmkiOiIvdjUvY2FyZC1hcGkvcmVxdWVzdC9zdGF0dXMiLCJhdXRoX2lkIjoiMTIzNDU2IiwibWV0aG9kIjoiUE9TVCIsInBhcmFtcyI6IiIsImFsZyI6IkhTMjU2In0.eyJyZXF1ZXN0X2lkIjoiODI4Y2Y3MWQtYTQ0Ny00YTY3LWExNDktYzFkZjhiYzE5N2NhIn0.5kx_b2FEI0qfCeJDIkhR33I6Oc7fe6y0aIMnxG8elJQ

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

eyJ1cmkiOiIvdjUvY2FyZC1hcGkvcmVxdWVzdC9zdGF0dXMiLCJhdXRoX2lkIjoiMTIzNDU2IiwibWV0aG9kIjoiUE9TVCIsInBhcmFtcyI6IiIsImFsZyI6IkhTMjU2In0..5kx_b2FEI0qfCeJDIkhR33I6Oc7fe6y0aIMnxG8elJQ

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

Инстант карты

Массовый выпуск карт

Метод позволяет выпустить инстант карты

URL запроса

POST https://.../v5/card-api/cards/batch-instant

Параметры запроса

Параметры ответа

Идентификация инстант карты

Метод предназначен для осуществления связки ранее созданной карты с ранее созданным клиентом

URL запроса

POST https://.../v5/card-api/card/link

Параметры запроса

Параметры ответа

Платежные карты

Cоздание карточки клиента

Метод предназначен для создания карточки клиента в системе Freedom Processing. Обязательный набор полей зависит от продукта в рамках которого создается карточка клиента.

URL запроса

POST https://.../v5/card-api/client/add

Параметры запроса

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

Параметры ответа

Выпуск карты

Метод позволяет выпустить карту с выбранным продуктом для ранее созданного клиента.

URL запроса

POST https://.../v5/card-api/card/issue

Параметры запроса

Параметры ответа

Редактирование карточки клиента

Метод предназначен для редактирования ранее созданной карточки клиента

URL запроса

POST https://.../v5/card-api/client/update

Параметры запроса

Параметры ответа

Активация карты

Метод предназначен для активации ранее выпущенной карты

URL запроса

POST https://.../v5/card-api/card/activate

Параметры запроса

Параметры ответа

Блокирование карты

URL запроса

POST https://.../v5/card-api/card/block

Параметры запроса

Параметры ответа

Разблокирование карты

Метод предназначен для разблокировки карты

URL запроса

POST https://.../v5/card-api/card/unblock

Параметры запроса

Параметры ответа

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

URL запроса

POST https://.../v5/card-api/card/info

Параметры запроса

Параметры ответа

Получение списка карт по клиенту

URL запроса

POST https://.../v5/card-api/client/cards/list

Параметры запроса

Параметры ответа

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

URL запроса

POST https://.../v5/card-api/card/balance

Параметры запроса

Параметры ответа

Установка пин-кода по карте

Метод для установки пин-кода по карте

URL запроса

POST https://.../v5/card-api/card/set_pin

Параметры запроса

Параметры ответа

Сброс счетчика пин-кода

Метод для сброса счетчика попыток использования пин-кода

URL запроса

POST https://.../v5/card-api/card/reset_counter_pin

Параметры запроса

Параметры ответа

Получение секретных карточных данных

Метод для получения полного номера карты и cvc

URL запроса

POST https://.../v5/card-api/card/secret_info

Параметры запроса

Параметры ответа

Выпуск физической карты

Метод для печати пластика по ранее созданной карте

URL запроса

POST https://.../v5/card-api/card/print

Параметры запроса

Параметры ответа

Закрытие карты

Метод для закрытие ранее выпущенной карты

URL запроса

POST https://.../v5/card-api/card/close

Параметры запроса

Параметры ответа

Получение списка операций по карте

Метод для получения списка операций по карте

URL запроса

POST https://.../v5/card-api/card/statement

Параметры запроса

Параметры ответа

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

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

URL запроса

POST https://.../v5/card-api/request/status

Параметры запроса

Параметры ответа

Справочники

Статус запроса

Код продукта клиента

Параметры метода Cоздание карточки клиента с product_id = 1000

request_id required ;;; Уникальный номер запроса в системе партнера (uuid) ;string/uuid product_id required ;;; Идентификатор в рамках какого продукта создается клиент; integer client required ;; ; Данные клиента; object ;phone required; ; Номер телефона клиента; integer ;type;; Тип клиента 1 - физическое лицо 2 - юридическое лицо 3 - индивидуальный предприниматель; integer ;resident ;; Признак резидентства 1 - резидент 2 - нерезидент; integer ;first_name required;; Имя клиента (Латиница); string ;last_name required;; Фамилия клиента (Латиница); string ;middle_name ;; Отчество клиента (Латиница); string ;birthdate;; Дата рождения держателя карты YYYY-MM-DD; date ;email;; Электронный адрес клиента; string ;country required;; Cтрана резидентства клиента (alpha-3);string ;person_id required ;; Идентификатор клиента в стране резидентства (для Казахстана ИНН, для РФ ИИН и т.д.) ;string ;language;;Язык общения клиента (alpha-2); string ;document required;; Скан-копия документа, удостоверяющий личность Формат файла pdf Формат передачи base64 Максимальный размер файла 2 МБ.; string ;external_user_id;; Идентификатор клиента в системе партнера; 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:m string ;string ;identified_by required;; Идентификатор пользователя проведший идентификацию клиента; string

Параметры метода Cоздание карточки клиента с product_id = 2000

Код продукта карты

Статус карты

Тип блокировки карты

Тип операции

1000;Запрос Баланса. Клиринг. 1001;Запрос Баланса. Авторизация. 1002;Отмена запроса Баланса. Клиринг. 1003;Отмена запроса Баланса. Авторизация. 1004;Комиссия Банкомата 1005;Отмена комиссии Банкомата 1006;Онлайн выписка 1007;Отмена онлайн выписки 1008;Выпуск карты 1009;Отмена выпуска карты 1010;Перевыпуск карты 1011;Отмена перевыпуска карты 1012;Годовое обслуживание 1013;Отмена годового обслуживания 1014;Комиссия за запрос баланса 1015;Отмена комиссии за запрос баланса 1016;Перевыпуск карты(по истечению срока действия) 1017;Отмена перевыпуска карты(по истечению срока действия) 1018;Выпуск дебетовой карты 1019;Отмена выпуска дебетовой карты 1020;Комиссия за перевыпуск карты 1021;Отмена комиссии за перевыпуск карты 1022;Перевыпуск карты (по утере) 1023;Отмена перевыпуска карты (по утере) 1024;Комиссия за перевыпуск карты 1025;Отмена комиссии за перевыпуск карты 1026;Минивыписка. Клиринг. 1027;Минивыписка. Авторизация. 1028;Отмена минивыписки. Клиринг. 1029;Отмена минивыписки. Авторизация. 1030;Доборы между мультивалютными счетами 1031;Отмена добора между мультивалютными счетами 1032;Перевод между счетами 1033;Отмена перевода между счетами 1034;Покупка с выдчей наличности. Клиринг. 1035;Покупка с выдчей наличности. Авторизация. 1036;Отмена покупки с выдачей наличности. Клиринг. 1037;Отмена покупки с выдачей наличности. Авторизация. 1038;Снятие наличных в кассе(через POS-терминал). Клиринг. 1039;Снятие наличных в кассе(через POS-терминал). Авторизация. 1040;Отмена снятия наличных в кассе(через POS-терминал). Клиринг. 1041;Отмена снятия наличных в кассе(через POS-терминал). Авторизация. 1042;Списание средств с карты (AFT). Клиринг. 1043;Списание средств с карты (AFT). Авторизация. 1044;Отмена списания средств с карты (AFT). Клиринг. 1045;Отмена списания средств с карты (AFT). Авторизация. 1046;Покупка (квази-кэш). Клиринг. 1047;Покупка (квази-кэш). Авторизация. 1048;Отмена/возврат покупки (квази-кэш). Клиринг. 1049;Отмена/возврат покупки (квази-кэш). Авторизация. 1050;Зачисление средств на карту(чаще всего используется для возврата в POS-терминале). Клиринг. 1051;Зачисление средств на карту(чаще всего используется для возврата в POS-терминале). Авторизация. 1052;Отмена зачисления средств на карту(чаще всего используется для возврата в POS-терминале). Клиринг. 1053;Отмена зачисления средств на карту(чаще всего используется для возврата в POS-терминале). Авторизация. 1054;Снятие наличных в банкомате. Клиринг. 1055;Снятие наличных в банкомате. Авторизация. 1056;Отмена снятия наличных в банкомате. Клиринг. 1057;Отмена снятия наличных в банкомате. Авторизация. 1058;Покупка. Клиринг. 1059;Покупка. Авторизация. 1060;Отмена/возврат покупки. Клиринг. 1061;Отмена/возврат покупки. Авторизация. 1062;Зачисление средств на карту (OCT). Клиринг. 1063;Зачисление средств на карту (OCT). Авторизация. 1064;Отмена зачисления средств на карту (OCT). Клиринг. 1065;Отмена зачисления средств на карту (OCT). Авторизация. 1066;Списание со счета 1067;Отмена списания со счета 1068;Взнос наличных в банкомате. Клиринг. 1069;Взнос наличных в банкомате. Авторизация. 1070;Отмена взноса наличных в банкомате. Клиринг. 1071;Отмена взноса наличных в банкомате. Авторизация. 1072;Пополнение карты с устройства. Клиринг. 1073;Пополнение карты с устройства. Авторизация. 1074;Отмена пополнения карты. Клиринг. 1075;Отмена пополнения карты. Авторизация. 1076;Пополнение счета 1077;Отмена пополнения счета 1078;Снятие наличных в банкомате по коду(без карты). Клиринг. 1079;Снятие наличных в банкомате по коду(без карты). Авторизация. 1080;Отмена снятия наличных в банкомате по коду(без карты). Клиринг. 1081;Отмена снятия наличных в банкомате по коду(без карты). Авторизация.

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