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

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

GET

/beneficiaries/state/{id}

Метод возвращает детализированный баланс, список смарт-контрактов и список событий, связанных с балансом бенефициара. Списки можно пролистать постранично.

Запрос

Path Parameters

id

uuid

required

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

Query Parameters

eventsPageNumber

number

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

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

eventsPageSize

number

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

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

smartContractsPageNumber

number

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

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

smartContractsPageSize

number

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

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

Header Parameters

RqUID

RqUID

required

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

Ответы

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

OK

Response Headers

• events-page-number

  number

  Example: 0

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

• events-page-size

  number

  Example: 20

  Количество элементов событий смарт-контрактов у бенефициара на странице

• events-total-elements

  number

  Example: 215

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

• events-updated

  string

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

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

• smart-contracts-page-number

  number

  Example: 0

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

• smart-contracts-page-size

  number

  Example: 20

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

• smart-contracts-total-elements

  number

  Example: 427

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

• smart-contracts-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

balance

object

Детализированный баланс бенефициара. Свободный остаток рассчитывается как freeBalance = balance - obligations - pending - blocked - debt. Если debt > 0, то freeBalance может получиться отрицательным значением.

balance

integer

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

Все деньги бенефициара на НС

obligations

integer

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

Общий объем обязательств по смарт-контрактам

pending

integer

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

Деньги, находящиеся в обработке банком при выводе средств (moneyback)

blocked

integer

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

Деньги, заблокированные гос. органами

debt

integer

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

Текущий долг перед гос. органами

smartContracts

object[]

Possible values: <= 20

Список актуальных смарт-контрактов

Array [

id

uuid

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

Id смарт-контракта

title

smartContractTitle (string)

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

Номер договора, заключенного сторонами

expiryDate

smartContractExpDate (string)

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

Дата по которую действует смарт-контракт

status

string

Возможные значения: [RUN, DONE, DECLINED]

Статус смарт-контракта

beneficiaryId

uuid

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

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

contractors

object[]

Possible values: <= 10

Реквизиты участников смарт-контракта

Array [

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

required

Значение должно соответствовать регулярному выражению ^[А-ЯЁа-яе][А-ЯЁа-яе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.,()"«»-]+$

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

]

obligations

obligations (integer)

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

Cумма средств в копейках

currency

currency (string)

Возможные значения: [RUB]

Валюта

pending

pending (integer)

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

Средства, находящиеся в обработке платежа банком

]

events

object[]

Possible values: <= 20

Последние события и их статусы

Array [

eventId

uuid

required

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

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

smartContractId

uuid

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

Id смарт-контракта

eventType

string

required

Возможные значения: [CREDIT, DEBIT, HOLD, UNHOLD, BLOCK, UNBLOCK, DEBT, UNDEBT]

Тип события

eventValue

string

required

Возможные значения: [CREATED, PENDING, DONE, DECLINED, ERROR]

Значение события, обычно является его статусом

errorMessage

errorMessage (string)

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

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

amount

amount (integer)

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

Cумма средств в копейках

purpose

purpose (string)

Возможные значения: <= 210 characters, Value must match regular expression ^(?!.*--)[^<>#@&$’*]+$

Назначение платежа

payee

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

required

Значение должно соответствовать регулярному выражению ^[А-ЯЁа-яе][А-ЯЁа-яе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.,()"«»-]+$

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

createDate

date-time

required

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

editDate

date-time

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

]

{
  "beneficiaryId": "99ee301b-8e06-4fd5-88d4-2ca5668294b1",
  "status": "ACTIVATED",
  "balance": {
    "balance": 100100500,
    "obligations": 100500,
    "pending": 220030,
    "blocked": 50000,
    "debt": 0
  },
  "smartContracts": [
    {
      "id": "99ee301b-8e06-4fd5-88d4-2ca5668294b1",
      "title": "Договор купли-продажи №КП 12/1-2022 от 01.12.2022",
      "expiryDate": "2022-12-13",
      "status": "RUN",
      "beneficiaryId": "99ee301b-8e06-4fd5-88d4-2ca5668294b1",
      "contractors": [
        {},
        {},
        {}
      ],
      "obligations": 2019900,
      "currency": "RUB",
      "pending": 220030
    }
  ],
  "events": [
    {
      "eventId": "f36fe80a-2ea2-4f79-bdc3-fc52dceea7f9",
      "smartContractId": "99ee301b-8e06-4fd5-88d4-2ca5668294b1",
      "eventType": "DEBIT",
      "eventValue": "DONE",
      "errorMessage": "На счете получателя установлены блокирующие ограничения",
      "amount": 20100,
      "purpose": "Оплата по Договору поставки №23/04-2022 от 01.04.2022, включая НДС 20%",
      "payee": {},
      "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...