Документация по АДМ Райффайзенбанк (1.0)

Download OpenAPI specification:Download

Support e-mail: Adm_product@raiffeisen.ru

Добавление вносителей по реестру

Автоматизированный выпуск кодов для внесения наличных в АДМ. Отправьте нам список вносителей реестром через банк-клиент – мы выпустим и направим код по электронной почте.

  1. Заполните реестр
  2. Отправьте список через интернет-банк
  3. В течение одного дня направим коды внесения по электронной почте, которую вы указали в реестре

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

xlsx реестр

Наименование поля Значение
Наименование Клиента Полное наименование компании
Расчетный Счет Организации Счёт Компании, открытый в Банке, к которому будут созданы коды внесения
Фамилия Фамилия сотрудника-вносителя, которому будет создан код
Имя Имя сотрудника-вносителя, которому будет создан код
Отчество Отчество сотрудника-вносителя, которому будет создан код
Пол Пол сотрудника-вносителя, которому создаётся код
Дата Дата рождения
Страна Страна рождения
Гражданство Гражданство вносителя (для граждан других государств выпуск кода осуществляется по скану паспорта)
Серия Серия паспорта РФ
Номер Номер паспорта РФ
Когда выдан Дата выдачи паспорта РФ
Кем Выдан Кем выдан паспорт РФ
Страна Страна прописки
Регион Регион адреса прописки
Населенный пункт Населенный пункт адреса прописки
Улица Улица адреса прописки
Дом Дом адреса прописки
E-mail Адрес электронной почты, на который необходимо отправить созданный код (почта вносителя)

Об API

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

Авторизация

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

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

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

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

Выпуск кодов

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

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

Запрос на создание кодов вносителей

header Parameters
Authorization
required
string

Bearer secret key.

Request Body schema: application/json

requestPayers

batchId
string <= 36 characters

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

Array of objects (cards) [ items ]

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

Responses

Request samples

Content type
application/json
{
  • "batchId": "d780dd10-3276-4d0b-afd0-29e271491e24",
  • "payers": [
    • {
      • "id": "a111bc10-7777-4d0b-afd0-29e271491e13",
      • "account": "40702810603000060801",
      • "person": {
        • "surname": "Иванова",
        • "name": "Иван",
        • "patronymic": "Иванович",
        • "birthday": "1993-12-23",
        • "gender": "MALE",
        • "email": "79123456789",
        • "passport": {
          • "series": "1234",
          • "number": "123456",
          • "issuedBy": "ОУФМС по МО в городском округе Красногорск",
          • "issuedDate": "2010-01-30",
          • "countryOfBirthName": "Россия"
          },
        • "address": {
          • "region": "Московская обл",
          • "city": "Красногорск",
          • "street": "Ленина",
          • "house": "7",
          • "countryOfRegistrationName": "Россия"
          }
        }
      }
    ]
}

Response samples

Content type
application/json
{
  • "info": [
    • "Duplicated client with document data(full name: Иванов Иван Иванович, birthday: 1975)"
    ]
}

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

path Parameters
batchId
required
string

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

header Parameters
Authorization
required
string

Bearer secret key.

Responses

Response samples

Content type
application/json
{
  • "cards": [
    • {
      • "id": "c130bc10-3286-4d0b-afd0-29e271491e13",
      • "payerId": "12345678",
      • "status": {
        • "value": "IN_PROGRESS",
        • "description": "В обработке",
        • "dateTime": "2020-01-15T16:01:49.043924"
        },
      • "account": "40702810603000060801",
      • "person": {
        • "companyId": "NBA2K0",
        • "maskedName": "Те*****ст****в.",
        • "birthday": "1980-01-10",
        • "gender": "MALE",
        • "document": {
          • "maskedSeries": "1*7*",
          • "maskedNumber": "1***77",
          • "issuedDate": "2000-10-28"
          }
        }
      }
    ]
}

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

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

Описание основных ошибок:

HTTP-код code message Комментарий
200 SUCCESS Запрос обработан успешно Успешное выполнение запроса без логических и системных сбоев
400 ERROR.Код_ошибки Текстовое сообщение о сути ошибки Логическая ошибка при выполнении запроса
500 ERROR.INTERNAL Ошибка Внутренняя ошибка сервера при выполнении запроса