Raiffeisenbank cards API

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

Автоматизированный выпуск карт с помощью API или реестра. Это позволит вам выпускать корпоративные карты без документов и паспортов. Отправляйте нам список держателей реестром через банк-клиент или по API — мы выпустим вам карты.

Реестр

  1. Отправляйте список сотрудников через интернет-банк в формате XLS, CSV или XML. Список сотрудников можете заполнять вручную или выгружать из вашей учетной системы.
  2. Если заказываете карты в отделение банка, срок доставки через 3-5 дней. Если заказываете карты на адреса держателей (только для форматов XLS и CSV), срок доставки через 5-7 дней в зависимости от региона доставки. Держатели получат СМС о готовности карты.

Формат реестра

Шаблон реестра:

Примеры реестров:

Наименование параметра Значение
ИдПервичногоДокумента Уникальный идентификатор реестра на стороне Компании
РасчетныйСчетОрганизации Счёт Компании, открытый в Банке, к которому будут созданы карты
ВидВклада/КодВидаВклада Тип карт
(MIR_CORPORATE/ MIR_CORPORATE_VIRTUAL/ MC_CORPORATE/ CASH_IN/ CASH_IN&OUT)
Фамилия Фамилия сотрудника-держателя, которому будет создана карта
Имя Имя сотрудника-держателя, которому будет создана карта
Отчество Отчество сотрудника-держателя, которому будет создана карта
ЭмбоссированныйТекст Имя и фамилия сотрудника-держателя латиницей, которые будет напечатаны на карте
ОтделениеБанка/ ФилиалОтделенияБанка Код отделения Банка, куда будут доставлены карты
Пол Пол сотрудника-держателя, которому создаётся карта
ДатаРождения Дата рождения
МестоРождения.СтранаНазвание Страна рождения
Серия Серия паспорта РФ
Номер Номер паспорта РФ
ДатаВыдачи Дата выдачи паспорта РФ
КемВыдан Кем выдан паспорт РФ
Гражданство Гражданство
АдресПрописки.Страна Страна прописки
АдресПрописки.РегионНазвание Регион адреса прописки
АдресПрописки. НаселенныйПунктНазвание Населенный пункт адреса прописки
АдресПрописки.УлицаНазвание Улица адреса прописки
(при отсутствии указать Нет)
АдресПрописки.Дом Дом адреса прописки
(при отсутствии указать Нет)
МобильныйТелефон Мобильный телефон сотрудника-держателя
(79210000001 или 9210000001)
Суточный лимит
(csv файл)
Суточный лимит на снятие наличных
Месячный лимит
(csv файл)
Ежемесячный общий расходный лимит
Секретное слово
(csv файл)
Секретное слово держателя карты
Индекс доставки
(csv файл)
Индекс доставки
Регион доставки
(csv файл)
Регион доставки
Населенный пункт доставки
(csv файл)
Населенный пункт доставки
Улица доставки
(csv файл)
Улица доставки
Дом доставки
(csv файл)
Дом доставки
Корпус доставки
(csv файл)
Корпус доставки

Инструкция по выгрузке реестра из 1С

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

Об API

После заключения договора вам придет письмо о подключении к сервису с авторизационными данными.

  1. Интегрируйте наш API с вашей учетной системой.
  2. Отправляйте список сотрудников.
  3. Проверяйте статус готовности карт.
  4. Через 3-5 дней карты доставят в отделение банка. Держатели получат СМС о готовности карты.

Взаимодействие осуществляется по протоколу HTTP с использованием методов GET/POST (в описании каждого запроса явно указан требуемый метод и адрес). POST-запросы используют JSON-аргументы, GET-запросы работают со строками запросов.

API всегда возвращает ответ в формате JSON, независимо от типа запроса. Ответ любого метода содержит код сообщения (code). Если в процессе обработки любого запроса произойдет логическая ошибка, API вернет дополнительно описание ошибки (message).

Авторизация

Для авторизация запросов необходимы:

  • secretKey - секретный ключ, который используется для межсервисного взаимодействия.

ВАЖНО: Секретный ключ необходимо хранить в защищенном месте, нельзя публиковать на сторонних ресурсах или передавать третьим лицам.

Межсервисные запросы авторизуются посредством секретного ключа API (SECRET_KEY). Параметр авторизации указывается в заголовке Authorization, значение которого формируется как "Bearer SECRET_KEY". API

Выпуск карт

Для реализации взаимодействия Райффайзенбанк предоставляет API:

  • запрос на создание карт с ипользованием HTTP;
  • получение информации о статусе запроса на создание карт.

Заявка на создание карт

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

header Parameters
Authorization
required
string

Bearer secret key

Request Body schema: application/json
batchId
required
string <= 36 characters

Уникальный идентификатор пакета.

required
Array of objects[ items ]

Список карт на выпуск.

Responses

Request samples

Content type
application/json
{
  • "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"
        }
      }
    ]
}

Response samples

Content type
application/json
{
  • "code": "ERROR.INVALID_DATA",
  • "message": "Некорректные данные",
  • "errors": [
    • {
      • "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
      • "invalidFields": [
        • "person.passport.series"
        ]
      }
    ]
}

Статус заявки на выпуск карт

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

path Parameters
batchId
required
string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters
Authorization
required
string

Bearer secret key

Responses

Response samples

Content type
application/json
[
  • {
    • "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
    • "cardId": "12345678",
    • "account": "40702810603000060801",
    • "product": "MC_CORPORATE",
    • "dailyLimit": "500",
    • "monthlyLimit": "5000",
    • "branchId": "603",
    • "status": {
      • "value": "IN_PROGRESS",
      • "description": "В обработке",
      • "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"
        }
      }
    }
]

Заявка на привязку моментальных карт

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

header Parameters
Authorization
required
string

Bearer secret key

Request Body schema: application/json
batchId
required
string <= 36 characters

Уникальный идентификатор пакета.

required
Array of objects[ items ]

Список карт на выпуск.

Responses

Request samples

Content type
application/json
{
  • "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"
        }
      }
    ]
}

Response samples

Content type
application/json
{
  • "code": "ERROR.INVALID_DATA",
  • "message": "Некорректные данные",
  • "errors": [
    • {
      • "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
      • "invalidFields": [
        • "person.passport.series"
        ]
      }
    ]
}

Статус запроса на привязку моментальных карт

Информация о статусе заявки на привязку моментальных карт.

path Parameters
batchId
required
string

Уникальный идентификатор пакета, по которому нужно получить статус

header Parameters
Authorization
required
string

Bearer secret key

Responses

Response samples

Content type
application/json
[
  • {
    • "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
    • "cardId": "12345678",
    • "account": "40702810603000060801",
    • "product": "MC_CORPORATE",
    • "dailyLimit": "500",
    • "monthlyLimit": "5000",
    • "branchId": "603",
    • "status": {
      • "value": "IN_PROGRESS",
      • "description": "В обработке",
      • "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:

  • Просмотр списка карт
  • Подробная информация по карте
  • Блокировка и закрытие карты
  • История действий

Список карт

Подробная информация о картах с фильтром и пагинацией.

query Parameters
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"

Карточный продукт

header Parameters
Authorization
required
string

Bearer secret key

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "page": 0,
    • "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"
          }
        ]
      }
    ]
}

Информация о карте

Подробная информация по конкретной карте.

path Parameters
cardId
required
string

Идентификатор карты

header Parameters
Authorization
required
string

Bearer secret key

Responses

Response samples

Content type
application/json
{
  • "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"
      }
    ]
}

История действий по карте

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

path Parameters
cardId
required
string

id карты

query Parameters
page
integer <int32>
Default: 1

Номер страницы

size
integer <int32>
Default: 20

Количество отображаемых карт

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "cardId": "string",
      • "createdDate": "string",
      • "type": "string",
      • "action": {
        • "limits": [
          • {
            • "type": "string",
            • "period": "string",
            • "oldValue": "string",
            • "value": "string"
            }
          ],
        • "status": {
          • "oldStatus": "string",
          • "status": "string",
          • "reason": "string"
          }
        }
      }
    ],
  • "meta": {
    • "page": 0,
    • "size": 20,
    • "hasNext": true,
    • "count": 34
    }
}

Список операций по карте

Метод получения списка операций по карте (период не обязательный, если его не указывать то: toDate = текущая дата, fromDate = минус 7 дней от текущей даты)

path Parameters
cardId
required
string

Идентификатор карты

query Parameters
toDate
string <date>
fromDate
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    • "accountMovementType": "DEBIT",
    • "extendedNarrative": "string",
    • "authorization": {
      • "amount": "1000.00",
      • "currency": "RUB"
      },
    • "status": {
      • "value": "HOLD",
      • "dateTime": "2019-08-24T14:15:22Z"
      },
    • "transaction": {
      • "amount": "1000.00",
      • "currency": "RUB"
      },
    • "card": {
      • "id": 1,
      • "maskedNumber": "553496******0091"
      },
    • "merchant": {
      • "mcc": "1000",
      • "label": "Лимузины и такси",
      • "name": "YANDEX.TAXI",
      • "city": "Gorod Moskva",
      • "country": "RU"
      }
    }
]

Реквизиты карты