API docs by Redocly

API интеграции работы с исполнителями (1.0)

Download OpenAPI specification:Download

Support e-mail: ecom@raiffeisen.ru

API для управления исполнителями

Работа с исполнителями

Методы работы с исполнителями

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

Возвращает список исполнителей

Authorizations:
BearerAuth
query Parameters
page
integer >= 1
Example: page=1

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

size
integer [ 1 .. 100 ]
Example: size=20

Количество элементов на странице

status
Array of strings
Items Enum: "TAXPAYER_UNDEFINED_STATUS_ERROR" "IN_PROGRESS" "TAXPAYER_DEREGISTERED_ERROR" "TAXPAYER_SUCCESSFULLY_BOUND" "TAXPAYER_ALREADY_BOUND_ERROR" "TAXPAYER_NOT_BOUND_ERROR" "TAXPAYER_UNREGISTERED_ERROR" "BINDING_DECLINED_BY_TAXPAYER" "UNKNOWN_ERROR"
Example: status=TAXPAYER_NOT_BOUND_ERROR

Фильтр по статусу самозанятого (можно указывать несколько значений)

type
string
Enum: "SELF_EMPLOYED" "INDIVIDUAL"
Example: type=SELF_EMPLOYED

Фильтр по типу исполнителя

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 1,
  • "size": 20,
  • "totalElements": 1542
}

Импорт реестра исполнителей (Создание)

Метод для массовой загрузки новых исполнителей Поддерживает загрузку файла (CSV/XLSX) или передачу JSON Если вы указываете тип исполнителя SELF_EMPLOYED (самозанятый), поле inn становится обязательным. Без ИНН запрос с таким типом будет отклонен

Authorizations:
BearerAuth
Request Body schema:
required
registryFile
required
string <binary> (RegistryFile)

Файл реестра исполнителей (CSV или XLSX) Требования к структуре файла: Файл должен содержать заголовки строго в следующем порядке:

  1. Тип (Обязательно)
  2. Имя (Обязательно)
  3. Фамилия (Опционально)
  4. Отчество (Опционально)
  5. ИНН (Если Тип - SELF_EMPLOYED, тогда проставление обязательно)
  6. Комментарий (Опционально)
  7. Номер счета (Опционально)
  8. BIK (Опционально)
  9. Телефон (Опционально)
  10. ID банка (Опционально)
  11. ID исполнителя (Опционально)
operationType
string
Enum: "CREATE" "UPDATE"

Тип операции импорта реестра

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "totalRows": 150,
  • "successfullyCreated": 148,
  • "errors": [
    ]
}

Обновление исполнителей

Метод для обновления существующих записей исполнителей Поддерживает загрузку файла (CSV/XLSX) или передачу JSON

Authorizations:
BearerAuth
Request Body schema:
required
Array
type
required
string (ContractorTypeEnum)
Enum: "SELF_EMPLOYED" "INDIVIDUAL"
Array of objects (AccountRequisite)

Список реквизитов

Array of objects (SbpRequisites)

Список реквизитов для выплат через СБП

inn
string

ИНН исполнителя

lastName
string non-empty

Фамилия получателя

firstName
required
string non-empty

Имя получателя

middleName
string non-empty

Отчество получателя

comment
string

Внутренний комментарий к исполнителю (например, назначение платежа или роль)

id
required
string <^[Aa-Zz0-9_-]+> (Id) non-empty

Уникальный идентификатор, если не передать его, он будет сгенерирован

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "totalRows": 150,
  • "successfullyUpdated": 148,
  • "errors": [
    ]
}

Массовая привязка самозанятых к банку

Метод для массовой привязки исполнителей к банку Принимает список UUID исполнителей, выполняет привязку только для самозанятых (SELF_EMPLOYED) Возвращает разделение на успешно привязанных и не привязанных

Authorizations:
BearerAuth
Request Body schema: application/json
required
ids
required
Array of strings <uuid> non-empty [ items <uuid > ]

Список UUID исполнителей для привязки

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": [
    ],
  • "failed": [
    ]
}

Получение шаблона файла реестра

Скачивание пустого шаблона файла (CSV или XLSX) для корректного заполнения данных перед импортом Структура файла (заголовки):

  1. Тип (Обязательно)
  2. Имя (Обязательно)
  3. Фамилия (Опционально)
  4. Отчество (Опционально)
  5. ИНН (Если Тип - SELF_EMPLOYED, тогда проставление обязательно)
  6. Комментарий (Опционально)
  7. Номер счета (Опционально)
  8. BIK (Опционально)
  9. Телефон (Опционально)
  10. ID банка (Опционально)
  11. ID исполнителя (Опционально)
Authorizations:
BearerAuth
query Parameters
format
string
Enum: "xlsx" "csv"
Example: format=xlsx

Формат шаблона xlsx или csv

Responses

Response samples

Content type
application/json
{
  • "code": "INVALID_DATA",
  • "message": "The request contains invalid fields or values",
  • "traceId": "84b19a21e19410b62c30b4cd40c228a1"
}

Приглашение исполнителей

Методы приглашения исполнителей по ссылке

Получить токен для ссылки-приглашения

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "token": "f74f43ad-705e-4b37-bcbf-0e4b4f0cfda6",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Создать токен для ссылки-приглашения

Authorizations:
BearerAuth
Request Body schema: application/json
required
expirationType
required
string
Enum: "PERMANENT" "ONE_MONTH"

Срок действия токена: PERMANENT, ONE_MONTH

Responses

Request samples

Content type
application/json
{
  • "expirationType": "PERMANENT"
}

Response samples

Content type
application/json
{
  • "token": "f74f43ad-705e-4b37-bcbf-0e4b4f0cfda6",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Проверить токен для ссылки-приглашения

path Parameters
token
required
string [ 32 .. 512 ] characters

Непрозрачный, высокоэнтропийный токен приглашения

Responses

Response samples

Content type
application/json
{
  • "company": "string",
  • "status": "VALID"
}

Регистрация нового исполнителя

path Parameters
token
required
string [ 32 .. 512 ] characters

Непрозрачный, высокоэнтропийный токен приглашения

Request Body schema: application/json
required
lastName
required
string [ 1 .. 64 ] characters
firstName
required
string [ 1 .. 64 ] characters
middleName
string or null <= 64 characters
inn
required
string^\d{12}$

ИНН самозанятого (12 цифр).

phone
required
string^7[0-9]{10}$

Номер телефона в формате 79XXXXXXXXX.

bankId
required
string [ 1 .. 16 ] characters

ID банка из справочника банков СБП.

Responses

Request samples

Content type
application/json
{
  • "lastName": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "inn": "774162887884",
  • "phone": "79191234567",
  • "bankId": "100000000007"
}

Response samples

Content type
application/json
{
  • "code": "INVITATION_EXPIRED",
  • "message": "The request contains invalid fields or values",
  • "traceId": "84b19a21e19410b62c30b4cd40c228a1"
}