Запросить информацию про денежный event

Обновлено 2 октября 2024

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

GET

/beneficiaries/:beneficiaryId/balance/events/:eventId

Метод позволяет по eventId получить информацию про денежный event конкретного бенефициара
Чтобы использовать метод, в параметре scope ссылки авторизации пользователя должен быть указан сервис nominal_accounts для получения доступа к этому ресурсу

Запрос

Path Parameters

beneficiaryId

uuid

required

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

eventId

uuid

required

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

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

Ответы

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

OK

• application/json

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

Schema

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

• organization
• individualEntrepreneur
• individual

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.,()"«»-]+$

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

typeCode

string

required

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

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

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

personName

string

required

Возможные значения: Value must match regular expression ^[А-ЯЁа-яе -]{3,250}$

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

orgName

string

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

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

inn

string

required

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

ИНН ФЛ

ogrnip

string

required

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

ОГРНИП

snils

snils

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

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

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.,()"«»-]+$

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

typeCode

string

required

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

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

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

personName

string

required

Возможные значения: Value must match regular expression ^[А-ЯЁа-яе -]{3,250}$

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

inn

string

required

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

ИНН ФЛ

snils

snils

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

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

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

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

{
  "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

Возможные значения: 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...