Download OpenAPI specification:Download
Автоматизированный выпуск карт с помощью API или реестра. Это позволит вам выпускать корпоративные карты без документов и паспортов. Отправляйте нам список держателей реестром через банк-клиент или по API — мы выпустим вам карты.
Шаблон реестра:
Примеры реестров:
Наименование параметра | Значение |
---|---|
ИдПервичногоДокумента | Уникальный идентификатор реестра на стороне Компании |
РасчетныйСчетОрганизации | Счёт Компании, открытый в Банке, к которому будут созданы карты |
ВидВклада/КодВидаВклада | Тип карт (MIR_CORPORATE/ MIR_CORPORATE_VIRTUAL/ MC_CORPORATE/ CASH_IN/ CASH_IN&OUT) |
Фамилия | Фамилия сотрудника-держателя, которому будет создана карта |
Имя | Имя сотрудника-держателя, которому будет создана карта |
Отчество | Отчество сотрудника-держателя, которому будет создана карта |
ЭмбоссированныйТекст | Имя и фамилия сотрудника-держателя латиницей, которые будет напечатаны на карте |
ОтделениеБанка/ ФилиалОтделенияБанка | Код отделения Банка, куда будут доставлены карты |
Пол | Пол сотрудника-держателя, которому создаётся карта |
ДатаРождения | Дата рождения |
МестоРождения.СтранаНазвание | Страна рождения |
Серия | Серия паспорта РФ |
Номер | Номер паспорта РФ |
ДатаВыдачи | Дата выдачи паспорта РФ |
КемВыдан | Кем выдан паспорт РФ |
Гражданство | Гражданство |
АдресПрописки.Страна | Страна прописки |
АдресПрописки.РегионНазвание | Регион адреса прописки |
АдресПрописки. НаселенныйПунктНазвание | Населенный пункт адреса прописки |
АдресПрописки.УлицаНазвание | Улица адреса прописки (при отсутствии указать Нет) |
АдресПрописки.Дом | Дом адреса прописки (при отсутствии указать Нет) |
МобильныйТелефон | Мобильный телефон сотрудника-держателя (79210000001 или 9210000001) |
Суточный лимит (csv файл) |
Суточный лимит на снятие наличных |
Месячный лимит (csv файл) |
Ежемесячный общий расходный лимит |
Секретное слово (csv файл) |
Секретное слово держателя карты |
Индекс доставки (csv файл) |
Индекс доставки |
Регион доставки (csv файл) |
Регион доставки |
Населенный пункт доставки (csv файл) |
Населенный пункт доставки |
Улица доставки (csv файл) |
Улица доставки |
Дом доставки (csv файл) |
Дом доставки |
Корпус доставки (csv файл) |
Корпус доставки |
После заключения договора вам придет письмо о подключении к сервису с авторизационными данными.
Взаимодействие осуществляется по протоколу HTTP с использованием методов GET/POST (в описании каждого запроса явно указан требуемый метод и адрес). POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов.
API всегда возвращает ответ в формате JSON, независимо от типа запроса. Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет дополнительно описание ошибки (message).
Для авторизация запросов необходимы:
ВАЖНО: Секретный ключ необходимо хранить в защищенном месте, нельзя публиковать на сторонних ресурсах или передавать третьим лицам.
Межсервисные запросы авторизуются посредством секретного ключа API (SECRET_KEY). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer SECRET_KEY". API
Для реализации взаимодействия Райффайзенбанк предоставляет API:
Метод на подачу заявки на выпуск карт.
Authorization required | string Bearer secret key |
batchId required | string <= 36 characters Уникальный идентификатор пакета. |
required | Array of objects[ items ] Список карт на выпуск. |
{- "batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
- "cards": [
- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "account": "40702810603000060801",
- "product": "MC_CORPORATE",
- "dailyLimit": "500",
- "monthlyLimit": "5000",
- "branchId": "203",
- "person": {
- "surname": "Тестов",
- "name": "Тест",
- "patronymic": "Тестович",
- "birthday": "1980-01-30",
- "gender": "MALE",
- "cellPhone": "79123456789",
- "transcriptFullName": "Testov Test Testovich",
- "citizenshipCode": "643",
- "secretWord": "secretword123",
- "email": "test@test.ru",
- "passport": {
- "series": "1234",
- "number": "123456",
- "issuedBy": "ОУФМС по МО в городском округе Серпухов",
- "issuedDate": "2010-01-30",
- "countryOfBirthIsoCode": "643"
}, - "address": {
- "countryOfRegistrationIsoCode": "643",
- "region": "Москва",
- "city": "Москва",
- "street": "Октябрьская",
- "house": "84",
- "building": "3"
}
}, - "deliveryAddress": {
- "countryOfRegistrationIsoCode": "643",
- "region": "Москва",
- "city": "Москва",
- "street": "Октябрьская",
- "house": "84",
- "building": "3",
- "postalCode": "127521"
}
}
]
}
{- "code": "ERROR.INVALID_DATA",
- "message": "Некорректные данные",
- "errors": [
- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "invalidFields": [
- "person.passport.series"
]
}
]
}
Метод получения информации о статусе заявки.
batchId required | string Уникальный идентификатор пакета, по которому нужно получить статус |
Authorization required | string Bearer secret key |
id | string Уникальный идентификатор запроса на выпуск карты. |
cardId | string Уникальный банковский идентификатор карты. |
account | string Номер счета. |
product | string Enum: "MIR_CORPORATE" "MIR_CORPORATE_VIRTUAL" "MC_CORPORATE" "CASH_IN" "CASH_IN&OUT" Карточный продукт. Возможные значения указаны в enum. |
dailyLimit | string Ежедневный лимит на снятие наличных по карте в рублях. Строка с целым числом. Необязательное поле, по умолчанию устанавливается в соответствии с типом карты. |
monthlyLimit | string Ежемесячный общий расходный лимит по карте в рублях. Строка с целым числом. Необязательное поле, по умолчанию устанавливается в соответствии с типом карты. |
branchId | string 3-х значный цифровой код отделения Банка, куда будет доставлена карта. |
object Статус по карте. | |
object Информация по держателю карты. |
[- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "cardId": "12345678",
- "account": "40702810603000060801",
- "product": "MC_CORPORATE",
- "dailyLimit": "500",
- "monthlyLimit": "5000",
- "branchId": "603",
- "status": {
- "value": "IN_PROGRESS",
- "description": "В обработке",
- "message": "Ошибка в паспортных данных: неверно указано ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
- "dateTime": "2021-01-01T12:00:27.87+00:20"
}, - "person": {
- "companyId": "HBA23K",
- "maskedName": "Тестов Т.Т.",
- "birthday": "1980.01.30",
- "gender": "MALE",
- "maskedCellPhone": "7916***4567",
- "passport": {
- "maskedSeries": "1*3*",
- "maskedNumber": "1***56",
- "issuedDate": "2012-10-22"
}
}
}
]
Метод на подачу заявки на привязку моментальных карт.
Authorization required | string Bearer secret key |
batchId required | string <= 36 characters Уникальный идентификатор пакета. |
required | Array of objects[ items ] Список карт на выпуск. |
{- "batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
- "cards": [
- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "account": "40702810603000060801",
- "product": "MC_CORPORATE",
- "dailyLimit": "500",
- "monthlyLimit": "5000",
- "branchId": "203",
- "person": {
- "surname": "Тестов",
- "name": "Тест",
- "patronymic": "Тестович",
- "birthday": "1980-01-30",
- "gender": "MALE",
- "cellPhone": "79123456789",
- "transcriptFullName": "Testov Test Testovich",
- "citizenshipCode": "643",
- "secretWord": "secretword123",
- "email": "test@test.ru",
- "passport": {
- "series": "1234",
- "number": "123456",
- "issuedBy": "ОУФМС по МО в городском округе Серпухов",
- "issuedDate": "2010-01-30",
- "countryOfBirthIsoCode": "643"
}, - "address": {
- "countryOfRegistrationIsoCode": "643",
- "region": "Москва",
- "city": "Москва",
- "street": "Октябрьская",
- "house": "84",
- "building": "3"
}
}, - "card": {
- "lastFourDigits": "4321",
- "cardId": "87654321"
}
}
]
}
{- "code": "ERROR.INVALID_DATA",
- "message": "Некорректные данные",
- "errors": [
- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "invalidFields": [
- "person.passport.series"
]
}
]
}
Информация о статусе заявки на привязку моментальных карт.
batchId required | string Уникальный идентификатор пакета, по которому нужно получить статус |
Authorization required | string Bearer secret key |
id | string Уникальный идентификатор запроса на выпуск карты. |
cardId | string Уникальный банковский идентификатор карты. |
account | string Номер счета. |
product | string Enum: "MIR_CORPORATE" "MIR_CORPORATE_VIRTUAL" "MC_CORPORATE" "CASH_IN" "CASH_IN&OUT" Карточный продукт. Возможные значения указаны в enum. |
dailyLimit | string Ежедневный лимит на снятие наличных по карте в рублях. Строка с целым числом. Необязательное поле, по умолчанию устанавливается в соответствии с типом карты. |
monthlyLimit | string Ежемесячный общий расходный лимит по карте в рублях. Строка с целым числом. Необязательное поле, по умолчанию устанавливается в соответствии с типом карты. |
branchId | string 3-х значный цифровой код отделения Банка, куда будет доставлена карта. |
object Статус по карте. | |
object Информация по держателю карты. |
[- {
- "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
- "cardId": "12345678",
- "account": "40702810603000060801",
- "product": "MC_CORPORATE",
- "dailyLimit": "500",
- "monthlyLimit": "5000",
- "branchId": "603",
- "status": {
- "value": "IN_PROGRESS",
- "description": "В обработке",
- "message": "Ошибка в паспортных данных: неверно указано ФИО и номер паспорта. Отредактируйте заявку и отправьте еще раз",
- "dateTime": "2021-01-01T12:00:27.87+00:20"
}, - "person": {
- "companyId": "HBA23K",
- "maskedName": "Тестов Т.Т.",
- "birthday": "1980.01.30",
- "gender": "MALE",
- "maskedCellPhone": "7916***4567",
- "passport": {
- "maskedSeries": "1*3*",
- "maskedNumber": "1***56",
- "issuedDate": "2012-10-22"
}
}
}
]
Для просмотра информации и управления картой Райффайзенбанк предоставляет API:
Подробная информация о картах с фильтром и пагинацией.
page | integer <int32> Default: 1 Номер страницы |
size | integer <int32> Default: 20 Количество отображаемых карт |
account | string Номер счета |
expiryStartDate | string <YYYY-MM-DD> Начало срока действия карты |
expiryEndDate | string <YYYY-MM-DD> Конец срока действия карты |
status | Array of strings Items Enum: "ACTIVE" "CLOSED" "BLOCKED" Статусы |
product | string Enum: "MIR_CORPORATE" "MIR_CORPORATE_VIRTUAL" "MC_CORPORATE" "VISA_CORPORATE" "VISA_PLATINUM" "CASH_IN" "CASH_IN&OUT" Карточный продукт |
Authorization required | string Bearer secret key |
object | |
Array of objects[ items ] |
{- "meta": {
- "page": "1",
- "size": "20",
- "hasNext": true,
- "count": "34"
}, - "data": [
- {
- "id": "string",
- "maskedNumber": "1***56",
- "status": "CLOSED",
- "createdDate": "2020-02-01",
- "isActivated": true,
- "expiryDate": "2024-02-01",
- "product": "MIR_CORPORATE",
- "account": "40702810603000060801",
- "type": "DEBIT",
- "currency": "RUB",
- "embossedName": "TEST TESTOV",
- "person": {
- "name": "Тест",
- "surname": "Тестов",
- "patronimic": "Тестович",
- "cnum": "CNUM"
}, - "limits": [
- {
- "type": "CASH",
- "period": "DAILY",
- "value": "100"
}
]
}
]
}
Подробная информация по конкретной карте.
cardId required | string Идентификатор карты |
Authorization required | string Bearer secret key |
id | string Уникальный банковский идентификатор карты. |
maskedNumber | string Маскированный номер карты. |
status | string Enum: "ACTIVE" "CLOSED" "BLOCKED" Статус карты. |
createdDate | string <YYYY-MM-DD> Дата выпуска. |
isActivated | boolean Признак активации карты. |
expiryDate | string <YYYY-MM-DD> Срок действия карты. |
product | string Enum: "MIR_CORPORATE" "MIR_CORPORATE_VIRTUAL" "MC_CORPORATE" "CASH_IN" "CASH_IN&OUT" Карточный продукт. |
account | string Номер счета. |
type | string Enum: "DEBIT" "CREDIT" Тип карты. |
currency | string Валюта карты. |
embossedName | string Имя на карте. |
object Информация по держателю карты. | |
Array of objects[ items ] |
{- "id": "string",
- "maskedNumber": "1***56",
- "status": "CLOSED",
- "createdDate": "2020-02-01",
- "isActivated": true,
- "expiryDate": "2024-02-01",
- "product": "MIR_CORPORATE",
- "account": "40702810603000060801",
- "type": "DEBIT",
- "currency": "RUB",
- "embossedName": "TEST TESTOV",
- "person": {
- "name": "Тест",
- "surname": "Тестов",
- "patronimic": "Тестович",
- "cnum": "CNUM"
}, - "limits": [
- {
- "type": "CASH",
- "period": "DAILY",
- "value": "100"
}
]
}