Удаление бенефициара

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

POST

/beneficiaries/delete

Запрос отправляет id бенефициара для удаления из реестра бенефициаров номинального счета
Чтобы использовать метод, в параметре scope ссылки авторизации пользователя должен быть указан сервис nominal_accounts для получения доступа к этому ресурсу
Перед вызовом метода необходимо проверить, что у бенефициара закрыты все смарт-контракты и выведены денежные средства
Бенефициар, в отношении которого выполняется удаление, должен быть активным

Запрос

Header Parameters

RqUID

RqUID

required

Возможные значения: Value must match regular expression ^[0-9a-fA-F]{32}$

Authorization

Authorization

required

Возможные значения: Value must match regular expression ^([a-zA-Z0-9]){38}$

• application/json

Body

content

object

required

Подписываемый контент

data

object

required

beneficiaryId

uuid

Возможные значения: Value must match regular expression ^[0-9a-fA-F-]{36}$

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

agreement

agreement (string)

required

Возможные значения: [Клиент подтверждает, что операция совершается в соответствии с условиями Договора номинального счета]

Соглашение

signature

signature (string)

required

Возможные значения: <= 16000 characters, Value must match regular expression ^[A-Za-z0-9+/=]+$

Подпись над content

Ответы

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

OK

Bad Request

• application/json

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

Schema

httpCode

string

required

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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

Возможные значения: Value must match regular expression ^[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...