Raif logo
API docs by Redocly

Управление кодами внесения АДМ (1.0.0)

Download OpenAPI specification:Download

Support e-mail: acdc_devteam@raiffeisen.ru

Общая информация

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

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

Блокировка кода

Заявка на блокировку кода внесения

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

Request Body schema: application/json
required

Заявка для создания

code
required
string

Код внесения

Responses

Request samples

Content type
application/json
{
  • "code": "2873654434"
}

Response samples

Content type
application/json
{
  • "id": "6f6cd181-13dc-4736-b944-6d9da53f45a3"
}

Изменение электронной почты для получения чеков

Изменение параметров кода

Выполняет операции изменения email плательщика.

Поддерживаемые поля для обновления:

  • email — email плательщика (необходима для отправки электронных чеков)

Метод выполняет частичное обновление ресурса в стиле JSON Merge Patch.

path Parameters
id
required
string
Example: 78901211

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

Request Body schema: application/json
required
email
string or null <email>

Новый email плательщика

Responses

Request samples

Content type
application/json
{
  • "email": "newemail@client.com"
}

Response samples

Content type
application/json
{
  • "id": "12345678",
  • "available": true,
  • "createDate": "2025-07-16T08:29:31.93956Z",
  • "updateDate": "2025-07-31T19:13:15.331124Z",
  • "customer": {
    },
  • "person": {
    }
}

Получение списка выпущенных кодов

Возвращает список выпущенных кодов внесения АДМ с возможностью фильтрации по:

  • идентификаторам компаний (cnum)
  • доступности кода (активные/заблокированные) Поддерживает пагинацию через параметры offset и limit.
query Parameters
offset
integer >= 0
Default: 0
Example: offset=0

Смещение от начала списка

limit
integer [ 1 .. 100 ]
Default: 20
Example: limit=35

Максимальное количество возвращаемых записей

cnums
string
Example: cnums=123456,111WWW

Фильтр по идентификаторам компаний в банке (cnum)

fullname
string
Example: fullname=Иванов Иван Иванович

Фильтр по полному имени плательщика. Может содержать фамилию, имя и отчество (частично или полностью).

available
boolean
Example: available=true

Фильтр доступности кода (true — активные, false — заблокированные)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "offset": 0,
  • "limit": 20,
  • "totalCount": 1
}

Получение детальной информации о коде

Возвращает полную информацию о конкретном коде внесения АДМ по его идентификатору

path Parameters
id
required
string
Example: 78901211

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

Responses

Response samples

Content type
application/json
{
  • "id": "12345678",
  • "available": true,
  • "createDate": "2025-07-16T08:29:31.93956Z",
  • "updateDate": "2025-07-31T19:13:15.331124Z",
  • "customer": {
    },
  • "person": {
    }
}