Запросить актуальные сведения о смарт-контракте

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

GET

/smart-contracts/{id}

Запрос позволяет увидеть актуальный статус смарт-контракта, детализацию финансовых обязательств и список событий

Запрос

Path Parameters

id

uuid

required

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

Query Parameters

pageNumber

number

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

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

pageSize

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

• page-number

  number

  Example: 0

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

• page-size

  number

  Example: 20

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

• total-elements

  number

  Example: 83

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

• updated

  string

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

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

• application/json

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

Schema

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

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

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

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

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

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

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

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

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

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

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

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

]

obligations

obligations (integer)

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

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

currency

currency (string)

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

Валюта

pending

pending (integer)

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

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

events

object[]

Possible values: <= 20

Cобытия по смарт-контракту и их статусы

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

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

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

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

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

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

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

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

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

createDate

date-time

required

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

editDate

date-time

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

]

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

{
  "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 ^.+$

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

moreInformation

string

required

Возможные значения: <= 254 characters, Value must match regular expression ^.+$

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

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

Bad Gateway

Service Unavailable

Gateway Timeout

Loading...

Loading...