ym88659208ym87991671
Запросить состояние бенефициара | Документация для разработчиков

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

Обновлено 5 июля 2024
Скачать спецификацию
GET
/beneficiaries/state/:id

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

Запрос

Path Parameters

    id
    uuid
    required

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

Query Parameters

    eventsPageNumber
    number

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

    eventsPageSize
    number

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

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

    smartContractsPageNumber
    number

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

    smartContractsPageSize
    number

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

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

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}$

Ответы

OK

Response Headers
  • events-page-number number

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

  • 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

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

  • 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

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

Schema
    beneficiaryId
    uuid

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

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

    status
    string

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

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

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

    title
    smartContractTitle

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

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

    expiryDate
    smartContractExpDate

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

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

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

    contractors object[]

    Possible values: <= 10

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

  • Array [
    • oneOf
    typeCode
    string
    required

    Возможные значения: Value must match regular expression ^UL$

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

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

    orgName
    orgShortNameRu
    required

    Возможные значения: Value must match regular expression ^[А-Яа-яеЁ][А-Яа-яеЁ0-9 "«»№+-]{3,160}$

    Наименование организации

    inn
    string
    required

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

    ИНН ЮЛ

    kpp
    kpp
    required

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

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

    ogrn
    string
    required

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

    ОРГН

    account objectrequired

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

    accountNumber
    basisAccountNumber
    required

    Возможные значения: Value must match regular expression ^4[0-9]{4}810[0-9]{12}$

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

    bankBIC
    string
    required

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

    БИК

    bankCorAccount
    string
    required

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

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

    bankName
    string
    required

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

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

  • ]
    • obligations
    obligations

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

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

    currency
    currency

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

    Валюта

    pending
    pending

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

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

  • ]
    • events object[]

    Possible values: <= 20

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

  • Array [
    • eventId
    uuid
    required

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

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

    smartContractId
    uuid

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

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

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

    amount
    amount

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

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

    purpose
    purpose

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

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

    payee object
    oneOf
    typeCode
    string
    required

    Возможные значения: Value must match regular expression ^UL$

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

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

    orgName
    orgShortNameRu
    required

    Возможные значения: Value must match regular expression ^[А-Яа-яеЁ][А-Яа-яеЁ0-9 "«»№+-]{3,160}$

    Наименование организации

    inn
    string
    required

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

    ИНН ЮЛ

    kpp
    kpp
    required

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

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

    ogrn
    string
    required

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

    ОРГН

    account objectrequired

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

    accountNumber
    basisAccountNumber
    required

    Возможные значения: Value must match regular expression ^4[0-9]{4}810[0-9]{12}$

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

    bankBIC
    string
    required

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

    БИК

    bankCorAccount
    string
    required

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

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

    bankName
    string
    required

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

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

    createDate
    date-time
    required

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

    editDate
    date-time

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

  • ]
Loading...
Loading...
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.