Запросить сведения о бенефициарe

Обновлено 20 февраля 2025

Скачать спецификацию

GET

/beneficiaries/details/{id}

Возвращает статус и реквизиты бенефициара, хранимые в реестре
Чтобы использовать метод, в параметре scope ссылки авторизации пользователя должен быть указан сервис nominal_accounts для получения доступа к этому ресурсу

Запрос

Path Parameters

id

uuid

required

Значение должно соответствовать регулярному выражению ^[0-9a-fA-F-]{36}$

Query Parameters

pageNumber

number

Возможные значения: <= 10000

По умолчанию: 0

pageSize

number

Возможные значения: >= 1 и <= 40

По умолчанию: 40

Header Parameters

RqUID

RqUID

required

Значение должно соответствовать регулярному выражению ^[0-9a-fA-F]{32}$

Authorization

Authorization

required

Значение должно соответствовать регулярному выражению ^([a-zA-Z0-9]){38}$

Ответы

• 200
• 400
• 401
• 403
• 404
• 405
• 429
• 500
• 502
• 503
• 504

OK

Response Headers

• page-number

  number

  Example: 0

  Порядковый номер страницы реестра бенефициаров

• page-size

  number

  Example: 40

  Количество элементов реестра бенефициаров на одной странице

• total-elements

  number

  Example: 2086

  Общее количество элементов реестра бенефициаров

• updated

  string

  Example: 2022-03-15T23:31:00.999Z

  Время обновления списка

• application/json

• Схема
• Пример из схемы

Schema

beneficiaryId

uuid

Значение должно соответствовать регулярному выражению ^[0-9a-fA-F-]{36}$

Идентификатор бенефициара номинального счета

status

string

Значение должно соответствовать регулярному выражению ^[A-Z]{5,9}$

Статус бенефициара принимает одно из значений: CREATED, ACTIVATED, PENDING, DELETED, BLOCKED, ERROR

subject

object

oneOf

• organization
• individualEntrepreneur
• individual

typeCode

string

required

Значение должно соответствовать регулярному выражению ^UL$

По умолчанию: UL

Тип участника UL

orgName

orgShortNameRu (string)

required

Значение должно соответствовать регулярному выражению ^[А-Яа-яеЁ][А-Яа-яеЁ0-9 "«»№+-]{3,160}$

Наименование организации (общедоступно)

inn

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{10}$

ИНН ЮЛ

kpp

kpp (string)

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

Код причины постановки на учет (общедоступно)

ogrn

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{13}$

ОРГН

account

object

required

Структура описания реквизитов расчетного счета

accountNumber

basisAccountNumber (string)

required

Значение должно соответствовать регулярному выражению ^4[0-9]{4}810[0-9]{12}$

номер расчетного счета

bankBIC

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

БИК

bankCorAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

Корреспондентский счет

bankName

string

required

Возможные значения: <= 140 characters, Value must match regular expression ^[А-ЯЁа-яе][А-ЯЁа-яе0-9 №N.,()"«»-]+$

Наименование банка

typeCode

string

required

Значение должно соответствовать регулярному выражению ^IP$

По умолчанию: IP

Тип участника IP

personName

string

required

Значение должно соответствовать регулярному выражению ^[А-ЯЁа-яе -]{3,250}$

ФИО для платежа

orgName

string

Значение должно соответствовать регулярному выражению ^[А-ЯЁа-яе][А-ЯЁа-яе0-9 "«»№+-]{3,160}$

Наименование ИП для платежа

inn

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{12}$

ИНН ФЛ

ogrnip

string

required

Значение должно соответствовать регулярному выражению ^3[0-9]{14}$

ОГРНИП

snils

snils (string)

Значение должно соответствовать регулярному выражению ^[0-9]{3}-[0-9]{3}-[0-9]{3} [0-9]{2}$

Страховой номер индивидуального лицевого счета

account

object

required

Структура описания реквизитов расчетного счета

accountNumber

basisAccountNumber (string)

required

Значение должно соответствовать регулярному выражению ^4[0-9]{4}810[0-9]{12}$

номер расчетного счета

bankBIC

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

БИК

bankCorAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

Корреспондентский счет

bankName

string

required

Возможные значения: <= 140 characters, Value must match regular expression ^[А-ЯЁа-яе][А-ЯЁа-яе0-9 №N.,()"«»-]+$

Наименование банка

typeCode

string

required

Значение должно соответствовать регулярному выражению ^FL$

По умолчанию: FL

Тип участника FL

personName

string

required

Значение должно соответствовать регулярному выражению ^[А-ЯЁа-яе -]{3,250}$

ФИО для платежа

inn

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{12}$

ИНН ФЛ

snils

snils (string)

Значение должно соответствовать регулярному выражению ^[0-9]{3}-[0-9]{3}-[0-9]{3} [0-9]{2}$

Страховой номер индивидуального лицевого счета

account

object

required

Структура описания реквизитов расчетного счета

accountNumber

basisAccountNumber (string)

required

Значение должно соответствовать регулярному выражению ^4[0-9]{4}810[0-9]{12}$

номер расчетного счета

bankBIC

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{9}$

БИК

bankCorAccount

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{20}$

Корреспондентский счет

bankName

string

required

Возможные значения: <= 140 characters, Value must match regular expression ^[А-ЯЁа-яе][А-ЯЁа-яе0-9 №N.,()"«»-]+$

Наименование банка

contractNumber

contractNumber (string)

Возможные значения: <= 25 characters, Value must match regular expression ^[А-ЯЁа-яе0-9/-]+$

Номер договора-основания

contractDate

contractDate (string)

Значение должно соответствовать регулярному выражению ^20[0-9]{2}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Дата заключения договора присоединения бенефициара к НС date – full-date notation as defined by RFC 3339, section 5.6, full-date = date-fullyear "-" date-month "-" date-mday for example, 2017-07-21

contractExpDate

contractExpDate (string)

Значение должно соответствовать регулярному выражению ^20[0-9]{2}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Дата завершения действия договора присоединения бенефициара к НС date – full-date notation as defined by RFC 3339, section 5.6, full-date = date-fullyear "-" date-month "-" date-mday for example, 2017-07-21

events

object[]

Possible values: <= 40

Последние события по бенефициару и их статусы

Array [

eventId

uuid

required

Значение должно соответствовать регулярному выражению ^[0-9a-fA-F-]{36}$

Уникальный идентификатор события

eventType

string

required

Значение должно соответствовать регулярному выражению ^[a-zA-Z]{5,10}$

Тип события CREATE, UPDATE, DELETE, BLOCK, UNBLOCK

eventValue

string

required

Значение должно соответствовать регулярному выражению ^[a-zA-Z]{4,10}$

Значение события CREATED, PENDING, ACTIVATED, BLOCKED, DELETED, ERROR, DONE

errorMessage

errorMessage (string)

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9а-яеА-ЯЁa-zA-Z._ @()/\№,]+$

Сообщение об ошибке

createDate

date-time

required

Время создания события

editDate

date-time

Время изменения статуса события

]

{
  "beneficiaryId": "99ee301b-8e06-4fd5-88d4-2ca5668294b1",
  "status": "ACTIVATED",
  "subject": {},
  "contractNumber": "ДКП02-01/2022",
  "contractDate": "2022-12-13",
  "contractExpDate": "2023-12-13",
  "events": [
    {
      "eventId": "f36fe80a-2ea2-4f79-bdc3-fc52dceea7f9",
      "eventType": "CREATE",
      "eventValue": "CREATED",
      "errorMessage": "На счете получателя установлены блокирующие ограничения",
      "createDate": "2022-03-15T23:31:00.999Z",
      "editDate": "2022-03-15T23:31:00.999Z"
    }
  ]
}

Bad Request

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Unauthorized

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Forbidden

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Not Found

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Method Not Allowed

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Too Many Requests

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Internal Server Error

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^[0-9a-zA-Z '.-]+$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^[0-9a-zA-ZА-ЯЁа-яе.,@№^)(}{$|\s:_!=?/-]*$

Дополнительная информация об ошибке

{
  "httpCode": "400",
  "httpMessage": "Error description",
  "moreInformation": "Error details"
}

Bad Gateway

Service Unavailable

Gateway Timeout

Loading...

Loading...