openapi: 3.1.0 info: title: Получение информации о банковских счетах клиента. Методы для Юридических Лиц. description: "\n

Введение

\n\nСтандарт содержит описание конечных точек, модели данных и контроля доступа к данным, которые являются общими для всех API, определяющих взаимодействие между Сторонним поставщиком и Поставщиком услуг в процессе получения информации по банковским счетам Физических Лиц.\n\n

Область применения

\n\nСтандарт рекомендован к использованию организациями при обмене финансовыми сообщениями, связанными с получением информации о банковском счете.\nСтандарт предназначен для:\n- участников получения информации о банковском счете (кредитные организации и их клиенты, а также Сторонние поставщики);\n- разработчиков информационного и программного обеспечения, информационных систем.\n\nПоложения настоящего стандарта применяются на добровольной основе, если только в отношении конкретных положений обязательность их применения не установлена нормативными актами Банка России или условиями договоров.\nПоложения настоящего стандарта применяются совместно со следующими документами:\n- СТО БР ФАПИ.СЕК-1.6-2024 Стандарт Банка России \"Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID\" (далее ФАПИ.СЕК).\n- СТО БР ФАПИ.ПАОК-1.0-2024 Стандарт Банка России \"Безопасность финансовых (банковских) операций. Обеспечения безопасности финансовых сервисов при инициации OpenID Connect клиентом потока аутентификации по отдельному каналу\" (далее ФАПИ.ПАОК).\n- СТО БР Открытые программные интерфейсы. Общие положения.\n- СТО БР Открытые программные интерфейсы. Общие требования к прикладным стандартам.\n- СТО БР Открытые программные интерфейсы. Получение информации о банковских счетах клиента. Спецификация API. Описание взаимодействия.\n- СТО БР Открытые программные интерфейсы. Получение информации о банковских счетах клиента. Правила взаимодействия.\n- СТО БР Открытые программные интерфейсы. Получение согласия на доступ к банковским счетам клиента. Методы для Юридических Лиц.\n- СТО БР Открытые программные интерфейсы. Профиль для расширенного режима безопасности.\n\n

Термины и определения

\n\nВ Стандарте применяются термины и определения в соответствии со стандартами ФАПИ.СЕК, ФАПИ.ПАОК, «Открытые программные интерфейсы. Общие положения» а также следующие:\n- `Ресурс`-\tРесурсом является представление любой сущности (например, перевод денежных средств, счет, транзакция) в определенном формате (например JSON). Каждый ресурс идентифицируется посредством постоянного идентификатора, который не меняется при изменении состояния ресурса.\n- `Полезная нагрузка`\tЧасть пакета данных (сообщения) без служебной информации (без заголовка, битов синхронизации и т. п.).\n- `YAML` -\tФормат сериализации данных, концептуально близкий к языкам разметки, но ориентированный на удобство ввода‑вывода типичных структур данных многих языков программирования.\n- `ППИУ` - Поставщик платежных и информационных и услуг.\n- `СПИУ` - Сторонний поставщик информационных услуг.\n- `Информационный сервис` - Сервис предоставления информации о счетах Пользователя в режиме реального времени.\n\n

Общее описание процесса

\n\nСпецификация API определяет поток взаимодействия при получении информации о счете клиента третей стороной через информационный сервис Открытых банковских интерфейсов Среды Открытых банковских интерфейсов, которые позволяют СПИУ:\n- Создать или отозвать ресурс согласие на доступ к счету;\n- Получать данные, связанные со счетом клиента.\n" version: 2.0.0 termsOfService: https://openbankingrussia.ru/terms/01 contact: name: Ассоциация развития финансовых технологий (Ассоциация ФинТех) url: https://fintechru.org email: info@openbankingrussia.ru license: name: open-licence url: https://openbankingrussia.ru x-logo: url: static/logo.svg altText: Открытые банковские интерфейсы href: https://openbankingrussia.ru/ servers: - url: https://sb0.openbankingrussia.ru/sandbox0/open-banking/v2.0/aisp-le description: | Сервер ресурсов в рамках данной спецификации должен предоставлять единственный URI, соответствующий следующей структуре: ```http - participant-path-prefix]/open-banking/[version]/[resource-group]/[resource]/[resource-id]/[sub-resource] ```` При этом параметр `resource-group` для данной спецификации должен иметь значение `aisp-le`. tags: - name: Accounts description: Информация о счете - name: Balances description: Остаток на счете - name: Statements Sync description: Выписки по счету в синхронном режиме - name: Statements Async description: Выписки по счету в асинхронном режиме paths: /accounts: get: operationId: getAccounts externalDocs: description: Примеры использования AccountsLE.md url: static/openapi-docs/Accounts.md tags: - Accounts summary: Получение списка счетов description: | Конечная точка позволяет СПИУ получать полный список счетов и их идентификаторы (accountId), которые были авторизованы Пользователем на стороне ППИУ parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetAccountsLE' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru-accounts-le /accounts/{accountId}: get: operationId: getAccountsAccountId tags: - Accounts summary: Получение детальной информации о счете по его идентификатору `accountId` description: Конечная точка позволяет СПИУ получать детальную информацию о счете по идентификатору accountId (который был получен при вызове конечной точке списка счетов GET /accounts) parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetAccountsLEAccountId' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le /accounts/{accountId}/balances: get: operationId: getAccountsAccountIdBalances tags: - Balances summary: Баланс банковского счета по идентификатору accountId description: | Конечная точка позволяет СПИУ получать информацию об остатке на счете с идентификатором accountId parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetAccountsAccountIdBalancesLE' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le /balances: get: operationId: getBalances externalDocs: description: Примеры использования BalancesLE.md url: static/openapi-docs/BalancesLE.md tags: - Balances summary: Остаток денежных средств по всем счетам description: | Конечная точка позволяет СПИУ получать остаток по всем счетам, которые были авторизованы Пользователем для доступа с помощью согласия parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetBalancesLE' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le /statements: post: operationId: createStatementsAccountId tags: - Statements Async summary: Создание ресурса выписки description: Конечная точка позволяет СПИУ создать ресурс выписки по идентификатору счета accountId, который предоставляется при вызове конечной точки GET /accounts parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StatementInitRequest' example: Data: Statement: accountId: 95791e79-0f2d-47de-a5e0-df034b285XXx fromBookingDateTime: '2019-09-03T00:00:00+00:00' toBookingDateTime: '2019-12-03T00:00:00+00:00' responses: '201': $ref: '#/components/responses/201PostStatementInitResponse' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le /statements/{statementId}: get: operationId: getStatementsStatementId tags: - Statements Async summary: Получение выписки по идентификатору выписки description: Конечная точка позволяет СПИУ получать выписки по идентификатору выписки parameters: - $ref: '#/components/parameters/statementId' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/fromBookingDateTime' - $ref: '#/components/parameters/toBookingDateTime' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetStatementsStatementId' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le /accounts/{accountId}/statements: get: operationId: getAccountsAccountIdStatements externalDocs: description: Примеры использования Statements.md url: static/openapi-docs/Statements.md tags: - Statements Sync summary: Получение выписки по идентификатору счета description: Конечная точка позволяет СПИУ получать выписки по идентификатору счета в режиме онлайн parameters: - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/fromBookingDateTime' - $ref: '#/components/parameters/toBookingDateTime' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200GetAccountsAccountIdStatements' '400': $ref: '#/components/responses/400Error-req' '401': $ref: '#/components/responses/401Error-req' '403': $ref: '#/components/responses/403Error-req' '405': $ref: '#/components/responses/405Error-req' '406': $ref: '#/components/responses/406Error-req' '429': $ref: '#/components/responses/429Error-req' '500': $ref: '#/components/responses/500Error-req' '501': $ref: '#/components/responses/501Error-req' '503': $ref: '#/components/responses/503Error-req' security: - PSUAccountConsentsLE: - obru_accounts_le components: securitySchemes: TPPAccountConsentsLE: type: oauth2 description: СПИУ использует поток авторизации сlient сredentional для доступа к ресурсам ППИУ flows: clientCredentials: tokenUrl: https://sb0.openbankingrussia.ru/sandbox0/as/aft/connect/token scopes: obru_account_consents_le: Доступ к ресурсу согласия PSUAccountConsentsLE: type: oauth2 description: Поток авторизации, требующий получения СПИУ авторизации конечного Пользователя на доступ к ресурсам на сервере авторизации ППИУ. flows: authorizationCode: authorizationUrl: https://sb0.openbankingrussia.ru/sandbox0/as/aft/connect/authorize tokenUrl: https://sb0.openbankingrussia.ru/sandbox0/as/aft/connect/token scopes: obru_accounts_le: доступ к информации о счете parameters: page: name: page in: query required: false description: Номер страницы schema: type: integer format: int32 minimum: 1 maximum: 5000 default: 1 x-fapi-auth-date: in: header name: x-fapi-auth-date schema: type: string minLength: 1 maxLength: 29 pattern: ^[a-zA-Z0-9 :,]{29}$ required: false description: 'Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT' example: Mon, 26 Aug 2019 12:23:11 GMT x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address schema: type: string minLength: 0 maxLength: 21 pattern: ^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}\.){3}\d{1,3}$ example: 172.123.123.123 required: false description: IP-адрес Пользователя, если Пользователь в данный момент подключен к Стороннему Поставщику (авторизован в приложении Стороннего Поставщика). x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: true description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. schema: type: string format: uuid description: Универсальный уникальный идентификатор (UUID) версии 4, в соответствии с IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace". example: 97ed4827-7b6f-4491-a06f-b548d5a7512d x-customer-user-agent: in: header name: x-customer-user-agent schema: type: string description: В заголовке указывается тип устройства (user-agent), который использует Пользователь. Сторонний Поставщик может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение Стороннего Поставщика, Сторонний Поставщик проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. required: false example: mobile accountId: name: accountId in: path required: true description: Идентификатор счета schema: type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id x-idempotency-key: name: x-idempotency-key in: header description: Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. required: false schema: type: string format: uuid x-jws-signature: name: x-jws-signature in: header required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string statementId: name: statementId in: path required: true description: Идентификатор выписки schema: type: string pattern: ^[a-zA-Z0-9-]{1,40}$ maxLength: 40 minLength: 1 example: 9b23e27e-f4f8-4cab-9b80-aaa008d4330c fromBookingDateTime: name: fromBookingDateTime in: query required: false description: Дата и время начала фильтрации списка операций по счету schema: description: Формат даты и времени type: string format: date-time example: '2021-06-05T15:15:13' toBookingDateTime: name: toBookingDateTime in: query required: false description: Дата и время окончания фильтрации списка операций по счету schema: description: Формат даты и времени type: string format: date-time example: '2021-06-05T15:15:13+00:00' schemas: AccountStatus: description: | Статус банковского счета

Значение

Описание

Enabled

Cчет доступен и может использоваться

Disabled

Cчет не доступен и не может использоваться, временно или навсегда

Deleted

Счет удален и не может использоваться
example: Enabled enum: - Enabled - Disabled - Deleted x-enum-descriptions: - Cчет доступен и может использоваться - Cчет не доступен и не может использоваться, временно или навсегда - Счет удален и не может использоваться x-enum-varnames: - Enabled - Disabled - Deleted ISODateTime: description: Формат даты и времени type: string format: date-time example: '2021-06-05T15:15:13+00:00' ActiveOrHistoricCurrencyCode: description: Код валюты, соответствующий международному стандарту ISO 4217 type: string pattern: ^[A-Z]{3,3}$ example: RUB AccountType: description: | Тип банковского счета

Значение

Описание

Business

Cчет юридического лица

Personal

Cчет юридического лица
type: string enum: - Business - Personal x-enum-descriptions: - Счет юридического лица - Счет физического лица x-enum-varnames: - Business - Personal AccountIdentificationCode: description: | Схема идентификации банковского счета

Значение

Описание

RU.CBR.BBAN

Базовый номер банковского счета (RUCBRAccountIdentifier)

RU.CBR.EPID

Идентификатор электронного средства платежа

RU.CBR.PAN

Идентификатор счета по номеру карты

RU.CBR.MTEL

Идентификатор счета по номеру телефона

RU.CBR.ORID

Иной идентификатор (номер, однозначно идентифицирующий счет стороны)
type: string enum: - RU.CBR.BBAN - RU.CBR.EPID - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.ORID example: RU.CBR.BBAN x-enum-descriptions: - Базовый номер банковского счета (RUCBRAccountIdentifier) - Идентификатор электронного средства платежа - Идентификатор счета по номеру карты - Идентификатор счета по номеру телефона - Иной идентификатор (номер, однозначно идентифицирующий счет стороны) x-enum-varnames: - BBAN - EPID - PAN - MTEL - ORID CashAccount: description: Идентификация счета type: object additionalProperties: false properties: name: description: Наименование счета, присвоенное учреждением, обслуживающим счет, по согласованию с владельцем счета для обеспечения дополнительных средств идентификации счета type: string pattern: ^[\w\W]{1,70}$ minLength: 1 maxLength: 70 example: Основной счет schemeName: description: Наименование схемы идентификации счета allOf: - $ref: '#/components/schemas/AccountIdentificationCode' identification: description: Идентификатор счета, соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) type: string pattern: ^[\w\W]{1,256}$ minLength: 1 maxLength: 256 example: '40817810621234570000' required: - schemeName - identification CountryCode: description: Код страны в формате ISO 3166-1 alpha-2 type: string pattern: ^[A-Z]{2,2}$ example: RU PartyIdentificationCode: description: | Схема идентификации юридического или физического лица

Значение

Описание

RU.CBR.TXID

Используется в случае идентификационной схемы ИНН/КИО

RU.CBR.LEI

Код организации в соответствии с ISO 17442

RU.CBR.PASP

Номер паспорта

RU.CBR.CLID

Другой идентификатор

RU.CBR.QRST

Идентификатор в виде QR - кода

RU.CBR.TAXT

КПП

RU.CBR.OGRN

ОГРН

RU.CBR.SNILS

СНИЛС

RU.CBR.PAN

Идентификатор платежной карты

RU.CBR.MTEL

Номер мобильного телефона

RU.CBR.BBAN

Идентификатор банковского счета
type: string example: RU.CBR.TXID maxLength: 35 enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.PASP - RU.CBR.CLID - RU.CBR.QRST - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.SNILS - RU.CBR.PAN - RU.CBR.MTEL - RU.CBR.BBAN x-enum-descriptions: - Используется в случае идентификационной схемы ИНН/КИО - Код организации в соответствии с ISO 17442 - Номер паспорта - Другой идентификатор - Идентификатор в виде QR - кода - КПП - ОГРН - СНИЛС - Идентификатор платежной карты - Номер мобильного телефона - Идентификатор банковского счета x-enum-varnames: - TXID - LEI - PASP - CLID - QRST - TAXT - OGRN - SNILS - PAN - MTEL - BBAN IdentificationType: description: Идентификация физического лица type: object additionalProperties: false properties: schemeName: description: Наименование идентификационной схемы юридического или физического лица allOf: - $ref: '#/components/schemas/PartyIdentificationCode' identification: description: Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '7728240240' required: - schemeName - identification AddressTypeCode: description: |- Тип адреса

Значение

Описание

Business

Адрес, указанный в едином государственном реестре юридических лиц

Correspondence

Адрес для корреспонденции

DeliveryTo

Адрес доставки

MailTo

Почтовый ящик

POBox

Абонентский ящик

Postal

Фактический/почтовый адрес местонахождения юридического лица

Residential

Адрес постоянной регистрации физического лица (прописка)

Statement

Адрес временной регистрации физического лица (регистрация временного пребывания)
type: string example: Postal enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement x-enum-descriptions: - Адрес, указанный в едином государственном реестре юридических лиц - Адрес для корреспонденции - Адрес доставки - Почтовый ящик - Абонентский ящик - Фактический/почтовый адрес местонахождения юридического лица - Адрес постоянной регистрации физического лица (прописка) - Адрес временной регистрации физического лица (регистрация временного пребывания) x-enum-varnames: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement PostalAddress: description: Почтовый адрес type: object additionalProperties: false properties: addressType: description: Тип адреса allOf: - $ref: '#/components/schemas/AddressTypeCode' example: Postal addressLine: description: Строка адреса type: string pattern: ^[\w\W]{1,140}$ minLength: 1 maxLength: 140 example: Адрес в виде строки streetName: description: Наименование улицы или проспекта type: string pattern: ^[\w\W]{1,70}$ minLength: 1 maxLength: 70 example: Садовая buildingNumber: description: Номер, который определяет положение здания на улице type: string pattern: ^[\w\W]{1,16}$ minLength: 1 maxLength: 16 example: '11' postCode: description: Почтовый индекс type: string pattern: ^[\w\W]{6,16}$ minLength: 6 maxLength: 16 example: '0100010' townName: description: Наименование населённого пункта или территории, находящейся вне границ поселений type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: Бигсити countrySubDivision: description: Наименование и тип субъекта Российской Федерации type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: Мой край country: description: Название страны в кодированной форме allOf: - $ref: '#/components/schemas/CountryCode' PartyIdentification: description: Информация об участнике, используемая для идентификации юридического или физического лица type: object additionalProperties: false properties: name: description: Наименование организации или Ф.И.О. type: string pattern: ^[\w\W]{1,160}$ minLength: 1 maxLength: 160 example: Наименование организации или физического лица mobileNumber: description: Номер мобильного телефона type: string pattern: ^\d{11,15}$ example: '79206001010' countryOfResidence: description: Страна проживания allOf: - $ref: '#/components/schemas/CountryCode' countryOfBirth: description: Место рождения (страна) allOf: - $ref: '#/components/schemas/CountryCode' provinceOfBirth: description: Место рождения (область). type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: Ставропольский край cityOfBirth: description: Место рождения (город) type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: Ставрополь birthDate: description: Дата рождения allOf: - $ref: '#/components/schemas/ISODateTime' Identification: description: Идентификация юридического или физического лица. type: array maxItems: 12 items: $ref: '#/components/schemas/IdentificationType' minItems: 1 PostalAddress: $ref: '#/components/schemas/PostalAddress' required: - name - Identification FinancialInstitutionIdentificationCode: description: | Схема идентификации финансового учреждения

Значение

Описание

RU.CBR.BICFI

BIC для финансовых учреждений согласно ISO 9362

RU.CBR.BIC

Уникальный идентификатор банка, используемый в платежных документах на территории Российской Федерации

enum: - RU.CBR.BICFI - RU.CBR.BIC example: RU.CBR.BIC x-enum-descriptions: - BIC для финансовых учреждений согласно ISO 9362 - Уникальный идентификатор банка, используемый в платежных документах на территории Российской Федерации x-enum-varnames: - BICFI - BIC BranchAndFinancialInstitutionIdentification: description: Идентификация финансового учреждения type: object additionalProperties: false properties: schemeName: description: Наименование идентификационной схемы финансового учреждения allOf: - $ref: '#/components/schemas/FinancialInstitutionIdentificationCode' identification: description: Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '9612123' required: - schemeName - identification OrganizationIdentificationCode: description: |+ Схема идентификации юридического или физического лица

Значение

Описание

RU.CBR.TXID

Используется в случае идентификационной схемы ИНН/КИО

RU.CBR.LEI

Код организации в соответствии с ISO 17442

RU.CBR.TAXT

КПП

RU.CBR.OGRN

ОГРН

RU.CBR.OKPO

ОКПО
type: string example: RU.CBR.TXID maxLength: 35 enum: - RU.CBR.TXID - RU.CBR.LEI - RU.CBR.TAXT - RU.CBR.OGRN - RU.CBR.OKPO x-enum-descriptions: - Используется в случае идентификационной схемы ИНН/КИО - Код организации в соответствии с ISO 17442 - КПП - ОГРН - ОКПО x-enum-varnames: - TXID - LEI - TAXT - OGRN - OKPO OrganizationIdentificationType: description: Идентификация юридического лица type: object additionalProperties: false properties: schemeName: $ref: '#/components/schemas/OrganizationIdentificationCode' identification: description: Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '7728240240' required: - schemeName - identification BranchAndFinancialInstitutionInformation: description: Информация о кредитной организации type: object additionalProperties: false properties: name: description: Наименование организации type: string pattern: ^[\w\W]{1,160}$ minLength: 1 maxLength: 160 example: Наименование организации BankIdentification: description: Идентификация финансового учреждения type: array minItems: 1 maxItems: 12 items: $ref: '#/components/schemas/BranchAndFinancialInstitutionIdentification' OrganizationIdentification: description: Идентификация юридического лица. type: array minItems: 0 maxItems: 12 items: $ref: '#/components/schemas/OrganizationIdentificationType' CorrespondentAccount: description: Корреспондентский счет type: object additionalProperties: false properties: schemeName: description: Наименование схемы идентификации счета allOf: - $ref: '#/components/schemas/AccountIdentificationCode' identification: description: Идентификатор счета соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) type: string pattern: ^[\w\W]{1,256}$ minLength: 1 maxLength: 256 example: '40817810621234570000' required: - schemeName - identification PostalAddress: $ref: '#/components/schemas/PostalAddress' required: - name - BankIdentification AccountLE: description: Счет type: object x-openapiru-object-type-contract: true additionalProperties: false properties: accountId: description: Уникальный и неизменный идентификатор, используемый для идентификации ресурса type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id status: description: Статус счета в форме кода allOf: - $ref: '#/components/schemas/AccountStatus' statusUpdateDateTime: description: Дата и время изменения статуса счета allOf: - $ref: '#/components/schemas/ISODateTime' currency: description: Валюта ведения счета allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' accountType: description: Тип счета (физическое или юридическое лицо) allOf: - $ref: '#/components/schemas/AccountType' accountDescription: type: string pattern: ^[\w\W]{1,128}$ minLength: 1 maxLength: 128 description: Краткое описание назначения счета или продукта, привязанного к счету example: Розничные операции AccountDetails: type: array minItems: 1 maxItems: 24 items: $ref: '#/components/schemas/CashAccount' description: Идентификация счета Owner: description: Информация о владельце счета allOf: - $ref: '#/components/schemas/PartyIdentification' Servicer: description: Информация о кредитной организации, облужиывющий счет клиента allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformation' required: - accountId - status - accountDescription - currency - accountType Links: description: | Поставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи. type: object additionalProperties: false properties: self: description: Текущая ссылка type: string format: uri example: https://sb.example.ru/open-banking/v2.0/group_id-value/?page=1 first: description: Первая ссылка type: string format: uri example: https://sb.example.ru/open-banking/v2.0/group_id-value/?page=1 prev: description: Предыдущая ссылка type: string format: uri example: https://sb.example.ru/open-banking/v2.0/group_id-value/?page=1 next: description: Следующая ссылка type: string format: uri example: https://sb.example.ru/open-banking/v2.0/group_id-value/?page=1 last: description: Последняя ссылка type: string format: uri example: https://sb.example.ru/open-banking/v2.0/group_id-value/?page=1 required: - self Meta: description: Дополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует. type: object additionalProperties: false properties: totalPages: type: integer format: int32 minimum: 1 maximum: 5000 description: Указывает на количество передаваемых страниц example: 1 AccountResponseLE: type: object additionalProperties: false description: Список счетов и их идентификаторы properties: Data: description: Раздел данных полезной нагрузки ответа на запрос о списке счетов type: object additionalProperties: false properties: Account: type: array maxItems: 50 items: $ref: '#/components/schemas/AccountLE' minItems: 0 Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links' example: self: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts Meta: description: Раздел метаданных $ref: '#/components/schemas/Meta' required: - Data minProperties: 1 maxProperties: 3 OBRUErrorResponseErrorCode: description: | Низкоуровневое описание ошибки. Поставщик услуг должен заполнить сообщение детальным описанием ошибки, не раскрывая конфиденциальную информацию.

Код ошибки

HTTP статус

Описание

RU.CBR.Field.Expected

400

Если поля передаются парой (ключ-значение) и значение не было передано. В поле path должен передаваться путь к ожидаемому полю (например, ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.identification”). Например, для допустимого значения поля «schemeName» должно передаваться соответствующее значение идентификатора в поле «identification».

RU.CBR.Field.Invalid

400

В поле указано недопустимое значение или длина предоставленного значения превышает соответствующую максимальную длину поля в домене ППИУ. Ссылка на недопустимое поле должна быть указана в поле path (например, ErrorResponse.Errors.path == “AccountResponse.Data.Account.AccountDetails.schemeName”). В поле URL может быть ссылка на веб-страницу, объясняющую правильное поведение.

RU.CBR.Field.InvalidDate

400

Указана неверная дата. Например, когда ожидается будущая дата, а указана дата в прошлом или текущая дата. Ссылка на недопустимое поле должна быть указана в поле path.

RU.CBR.Field.Missing

400

Обязательное поле, необходимое для API, отсутствует в полезной нагрузке. Данный код ошибки можно использовать, если ошибка еще не определена при проверке RU.CBR.Resource.InvalidFormat.

RU.CBR.Header.Invalid

400

В элементе заголовка HTTP указано неверное значение. Элемент заголовка HTTP должен быть указан в элементе пути.

RU.CBR.Header.Missing

400

Обязательный элемент HTTP-заголовка не был предоставлен. Элемент заголовка HTTP должен быть указан в элементе path.

RU.CBR.Resource.InvalidFormat

400

Json-схема полезной нагрузки не соответствует конечной точке. Например, конечная точка POST /account-consents вызывается с полезной нагрузкой JSON, которая не может быть проанализирована в классе ConsentRequest.

RU.CBR.Resource.NotFound

400

Ресурс с указанным идентификатором не существует или не может быть обработан (в том числе неприемлемый формат или значение идентификатора ресурса).

RU.CBR.Resource.NotCreated

400

Ресурс с указанным идентификатором еще не создан и не может быть передан в ответном сообщении. Для асинхронных вызовов.

RU.CBR.Rules.AfterCutOffDateTime

400

Ресурс согласия или ресурс платежа запрашиваются после даты CutOffDateTime.

RU.CBR.Signature.Invalid

400

Заголовок подписи x-jws-signature был проанализирован и имеет действительный заголовок JOSE, соответствующий спецификации. Но сама подпись не может быть проверена.

RU.CBR.Signature.InvalidClaim

400

Заголовок JOSE в элементе x-jws-signature имеет одно или несколько утверждений (claim) с недопустимым значением.

RU.CBR.Signature.MissingClaim

400

Заголовок JOSE в элементе x-jws-signature имеет одно или несколько обязательных утверждений, которые не указаны.

RU.CBR.Signature.Malformed

400

x-jws-signature в заголовке запроса была искажена и не могла быть проанализирована как допустимый JWS.

RU.CBR.Signature.Missing

400

Запрос API предполагает x-jws-signature в заголовке, но элемент отсутствовал.

RU.CBR.Unsupported.AccountIdentifier

400

Идентификатор счета не поддерживается для данной схемы. Элемент path должен быть заполнен путем к элементу accountIdentifier.

RU.CBR.Unsupported.LocalInstrument

400

Указанный localInstrument не поддерживается ППИУ. Элемент path должен быть заполнен путем к элементу localInstrument.

RU.CBR.Operation.Unprocessable

400

Операция по извлечению ресурса не может быть выполнена или недопустима.

RU.CBR.Authenticate.InvalidScope

403

Предъявленный токен доступа не содержит область действия ("scope") необходимую для доступа к ресурсу.

RU.CBR.Authenticate.InvalidConsent

403

Отказано доступу к ресурсу с указанным идентификатором, так как согласие Пользователя отсутствует или не корректно.

RU.CBR.Authenticate.SuspiciousActivityDetected

403

Доступ к ресурсу приостановлен по причине выявления подозрения на мошеннические действия.

RU.CBR.Rules.ResourceAlreadyExists

409

Ресурс с такими же параметрами уже существует.

RU.CBR.UnexpectedError

5xx

Данный код ошибки можно использовать при возникновении непредвиденной ошибки.
type: string example: RU.CBR.Field.Missing enum: - RU.CBR.Field.Expected - RU.CBR.Field.Invalid - RU.CBR.Field.InvalidDate - RU.CBR.Field.Missing - RU.CBR.Header.Invalid - RU.CBR.Header.Missing - RU.CBR.Resource.InvalidFormat - RU.CBR.Resource.NotFound - RU.CBR.Resource.NotCreated - RU.CBR.Rules.AfterCutOffDateTime - RU.CBR.Signature.Invalid - RU.CBR.Signature.InvalidClaim - RU.CBR.Signature.MissingClaim - RU.CBR.Signature.Malformed - RU.CBR.Signature.Missing - RU.CBR.Unsupported.AccountIdentifier - RU.CBR.Unsupported.LocalInstrument - RU.CBR.Operation.Unprocessable - RU.CBR.Authenticate.InvalidScope - RU.CBR.Authenticate.InvalidConsent - RU.CBR.Authenticate.SuspiciousActivityDetected - RU.CBR.Rules.ResourceAlreadyExists - RU.CBR.UnexpectedError OBRUError: description: Контейнер с ошибкой type: object additionalProperties: false properties: errorCode: description: Низкоуровневое описание ошибки $ref: '#/components/schemas/OBRUErrorResponseErrorCode' message: type: string pattern: ^[\w\W]{1,500}$ minLength: 1 maxLength: 500 description: Описание ошибки example: Обязательное поле не указано path: type: string pattern: ^[\w\W]{1,500}$ minLength: 1 maxLength: 500 description: Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, но не обязательное поле example: Data.Model.Object.name url: type: string format: uri description: URL для помощи в устранении проблемы, Также через URL можно предоставлять дополнительную информацию example: https://example.com/error-description required: - errorCode - message OBRUErrorResponse: description: Контейнер с детализацией ошибки type: object additionalProperties: false properties: code: type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 description: Высокоуровневый текстовый код ошибки, необходимый для классификации example: '400' id: type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 description: Уникальный идентификатор ошибки, для целей аудита, в случае неизвестных / не классифицированных ошибок example: 4aca5b0d-1730-416f-a52b-6d353b687082 message: type: string pattern: ^[\w\W]{1,500}$ minLength: 1 maxLength: 500 description: Краткое сообщение об ошибке. Например, «что-то не так с предоставленными параметрами запроса» example: Bad Request Errors: type: array maxItems: 50 items: $ref: '#/components/schemas/OBRUError' minItems: 1 required: - code - message - Errors BalanceTypeLE: description: | Тип остатка

Значение

Описание

Expected

Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса.

InterimAvailable

Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса.
type: string enum: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked - InterimAvailable x-enum-descriptions: - Конечный остаток суммы денег, которая находится в распоряжении владельца счета на указанную дату - Остаток по счету на конец предварительно согласованного отчетного периода. Это сумма начального зарегистрированного баланса в начале периода и всех записей, зачисленных на счет в течение предварительно согласованного отчетного периода - Конечный остаток суммы денег, которая очищается в указанную дату - Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса. - Начальный баланс суммы денег, которая находится в распоряжении владельца счета на указанную дату - Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета - Начальный баланс, который очищается в указанную дату - Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу - Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса x-enum-varnames: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked - InterimAvailable ActiveCurrencyAndAmountSimpleType: description: Сумма денежных средств type: string pattern: ^\d{1,15}\.\d{2,4}$ example: '200.00' ActiveOrHistoricCurrencyAndAmount: description: Сумма денежных средств и код валюты type: object additionalProperties: false properties: amount: description: Сумма денежных средств allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: Код валюты, соответствующий международному стандарту ISO 4217 allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - amount - currency CreditDebitCode: description: | Признак дебета/кредита

Значение

Описание

Credit

Операция зачисления или положительный остаток на счете

Debit

Операция списания или отрицательный остаток на счете
type: string example: Debit enum: - Credit - Debit x-enum-descriptions: - Операция зачисления или положительный остаток на счете - Операция списания или отрицательный остаток на счете x-enum-varnames: - Credit - Debit OBRUCreditLine: description: Набор элементов, используемых для предоставления подробной информации о кредитной линии type: object additionalProperties: false properties: included: description: Показывает включена или нет кредитная линия в расчет остатка type: boolean example: false Amount: description: Значение лимита внутридневного кредитования (ВДК) allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' required: - included - Amount BalanceLE: description: Остаток на счете type: object additionalProperties: false x-openapiru-object-type-contract: true properties: accountId: description: Уникальный и неизменный идентификатор, используемый для идентификации ресурса счета type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id type: description: Тип остатка allOf: - $ref: '#/components/schemas/BalanceTypeLE' Amount: description: Сумма остатка allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' creditDebitIndicator: description: Определяет является остаток кредитовым или дебетовым allOf: - $ref: '#/components/schemas/CreditDebitCode' dateTime: description: Дата, на которую рассчитан остаток allOf: - $ref: '#/components/schemas/ISODateTime' CreditLine: description: Кредитная линия type: array minItems: 0 maxItems: 50 items: $ref: '#/components/schemas/OBRUCreditLine' required: - accountId - type - dateTime - Amount - creditDebitIndicator DataBalanceResponseLE: description: Раздел данных полезной нагрузки ответа на запрос об остатке на счете type: object additionalProperties: false properties: Balance: type: array maxItems: 50 items: $ref: '#/components/schemas/BalanceLE' minItems: 0 BalanceResponseLE: type: object additionalProperties: false description: Ответ на запрос об остатке на счете properties: Data: allOf: - $ref: '#/components/schemas/DataBalanceResponseLE' description: Раздел данных полезной нагрузки ответа Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links' example: self: https://sb.example.ru/open-banking/v2.0/aisp-pe/ Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta' required: - Data minProperties: 1 maxProperties: 3 StatementInitType: description: Объект запроса на создание ресурса выписки type: object additionalProperties: false properties: accountId: description: Идентификатор ресурса счета type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id fromBookingDateTime: description: Дата и время начала расчетов, представленных в выписке allOf: - $ref: '#/components/schemas/ISODateTime' example: '2019-09-15T00:00:00+00:00' toBookingDateTime: description: Дата и время окончания расчетов, представленных в выписке allOf: - $ref: '#/components/schemas/ISODateTime' example: '2019-12-15T00:00:00+00:00' required: - accountId - fromBookingDateTime - toBookingDateTime DataStatementInitRequest: description: Запрос создания ресурса выписки type: object additionalProperties: false properties: Statement: description: Объект запроса на создание ресурса выписки allOf: - $ref: '#/components/schemas/StatementInitType' required: - Statement StatementInitRequest: description: Запрос создания ресурса выписки type: object additionalProperties: false properties: Data: allOf: - $ref: '#/components/schemas/DataStatementInitRequest' required: - Data minProperties: 1 maxProperties: 1 StatementInitResponseType: description: Ресурс выписки type: object additionalProperties: false properties: statementId: description: Идентификатор ресурса выписки type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-statement-id accountId: description: Идентификатор ресурса счета type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id fromBookingDateTime: description: Дата и время начала выписки type: string format: date-time example: '2019-09-15T00:00:00+00:00' toBookingDateTime: description: Дата и время окончания выписки type: string format: date-time example: '2019-12-15T00:00:00+00:00' required: - statementId - fromBookingDateTime - toBookingDateTime DataStatementInitResponse: description: Раздел данных полезной нагрузки ответа запроса на создание выписки type: object additionalProperties: false properties: Statement: description: Ресурс выписки allOf: - $ref: '#/components/schemas/StatementInitResponseType' required: - Statement StatementInitResponse: description: Ответ на запрос создания ресурса выписки type: object additionalProperties: false properties: Data: allOf: - $ref: '#/components/schemas/DataStatementInitResponse' description: Раздел данных полезной нагрузки ответа Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links' example: self: https://sb.example.ru/open-banking/v2.0/aisp-pe/statements/this-is-a-slug-format-statement-id Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta' required: - Data minProperties: 1 maxProperties: 3 BalanceType: description: | Тип остатка

Значение

Описание

Expected

Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса.

InterimAvailable

Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса.

ClosingAvailable

Конечный остаток суммы денег, которая находится в распоряжении владельца счета на указанную дату

ClosingBooked

Остаток по счету на конец предварительно согласованного отчетного периода. Это сумма начального зарегистрированного баланса в начале периода и всех записей, зачисленных на счет в течение предварительно согласованного отчетного периода

ClosingCleared

Конечный остаток суммы денег, которая очищается в указанную дату

OpeningAvailable

Начальный баланс суммы денег, которая находится в распоряжении владельца счета на указанную дату

OpeningBooked

Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета

OpeningCleared

Начальный баланс, который очищается в указанную дату

PreviouslyClosedBooked

Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу
type: string enum: - Expected - InterimAvailable x-enum-descriptions: - Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса. - Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса x-enum-varnames: - Expected - InterimAvailable CashBalance: description: Детальная информация об остатке на счете type: object additionalProperties: false properties: creditDebitIndicator: description: Определяет является остаток кредитовым или дебетовым allOf: - $ref: '#/components/schemas/CreditDebitCode' type: description: Тип остатка allOf: - $ref: '#/components/schemas/BalanceType' Amount: description: Сумма остатка allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' required: - type - Amount - creditDebitIndicator NumberAndSumOfTransactions: description: Набор элементов, обеспечивающих общую сумму записей type: object additionalProperties: false properties: numberOfEntries: description: "\_Колличество записей" type: string pattern: ^\d{1,15}$ example: '1' sum: description: Общая сумма всех записей allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' currency: description: Код валюты, соответствующий международному стандарту ISO 4217 allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - sum - currency TransactionsSummary: description: Обороты по кредиту и дебету type: object additionalProperties: false properties: TotalCreditEntries: description: Обороты по кредиту allOf: - $ref: '#/components/schemas/NumberAndSumOfTransactions' example: numberOfEntries: '2' sum: '100.00' currency: RUB TotalDebitEntries: description: Обороты по дебету allOf: - $ref: '#/components/schemas/NumberAndSumOfTransactions' example: numberOfEntries: '2' sum: '1500.00' currency: RUB PurposeCode: description: | Код вида дохода - причина, по которой осуществляется платеж. type: string enum: - '1' - '2' - '3' x-enum-descriptions: - При переводе денежных средств, являющихся заработной платой и (или) иными доходами - При переводе денежных средств, являющихся доходами, на которые не может быть обращено взыскание - При переводе денежных средств, являющихся доходами, к которым ограничения по обращению взыскания не применяются x-enum-varnames: - _1 - _2 - _3 example: '1' TransactionStatusCode: description: | Статус записи операции по счету

Значение

Описание

AcceptedCreditSettlementCompleted

Расчет по счету Получателя средств завершен

AcceptedSettlementCompleted

Расчет по счету Плательщика завершен

AcceptedSettlementInProcess

Все предыдущие проверки, такие как техническая проверка и профиль клиента, были успешными, и поэтому запрос об инициировании платежа был принят к исполнению

AcceptedWithoutPosting

Платежная инструкция, включенная в перевод, принимается без зачисления на счет Получателя средств

Pending

Ожидается инициирование группы платежей или отдельного платежа, включенного в группу платежей

Rejected

Инициирование группы платежей или отдельного платежа, включенная в группу инициирования платежей, были отклонены
type: string example: AcceptedSettlementCompleted enum: - AcceptedCreditSettlementCompleted - AcceptedSettlementCompleted - AcceptedSettlementInProcess - AcceptedWithoutPosting - Pending - Rejected x-enum-descriptions: - Расчет по счету Получателя средств завершен - Расчет по счету Плательщика завершен - Все предыдущие проверки, такие как техническая проверка и профиль клиента, были успешными, и поэтому запрос об инициировании платежа был принят к исполнению - Платежная инструкция, включенная в перевод, принимается без зачисления на счет Получателя средств - Ожидается инициирование группы платежей или отдельного платежа, включенного в группу платежей - Инициирование группы платежей или отдельного платежа, включенная в группу инициирования платежей, были отклонены x-enum-varnames: - AcceptedCreditSettlementCompleted - AcceptedSettlementCompleted - AcceptedSettlementInProcess - AcceptedWithoutPosting - Pending - Rejected CurrencyExchange: description: Подробная информация об обмене валюты type: object additionalProperties: false properties: sourceCurrency: description: Валюта, из которой необходимо конвертировать сумму allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' targetCurrency: description: Валюта, в которую необходимо конвертировать сумму allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' unitCurrency: description: Валюта, в которой обменный курс выражен allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' exchangeRate: description: Коэффициент, используемый для перевода суммы из одной валюты в другую. Это отражает цену, по которой одна валюта была куплена за другую валюту type: string pattern: ^[\w\W]{1,12}$ minLength: 1 maxLength: 12 example: '0.7' contractIdentification: type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 description: Идентификатор для однозначного определения валютного контракта example: DOC441234-1234-1234 quotationDate: description: Дата и время обменного курса allOf: - $ref: '#/components/schemas/ISODateTime' required: - sourceCurrency - exchangeRate AmountAndCurrencyExchangeDetails: description: Сумма денег и информации об обменом курсе, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной в случае, если указанная сумма и/или валюта отличаются от суммы и/или валюты операции по счету type: object additionalProperties: false properties: Amount: description: Сумма денег, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' CurrencyExchange: description: 'Набор элементов, используемые для указания информации об обменом курсе. Использование: Это может быть либо встречная сумма, указанная в сделке с иностранной валютой, либо результат информации о валюте, примененной к указанной сумме, до вычета расходов' allOf: - $ref: '#/components/schemas/CurrencyExchange' required: - Amount BankTransactionCode: description: Код банковской операции type: object additionalProperties: false properties: code: type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 description: Тип банковской операции example: '20' subCode: type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 description: Подтип банковской операции example: '20' issuer: type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 example: RU.CBR description: Идентификация эмитента собственного банковского кода операции по счету required: - code LocalInstrumentCode: description: | (Номер реквизита 5) Вид платежного распоряжения. 01 - в рамках расчетов платежными поручениями 02 - в рамках расчетов в форме перевода денежных средств по требованию получателя средств (прямое дебетование) 03 - в рамках расчетов с помощью денежных чеков 04 - в рамках расчетов приходного кассового ордера или объявление на взнос наличными 06 - в рамках расчетов инкассовыми поручениями 09 - в рамках расчетов мемориальным ордером 16 - при частичном исполнении 17 - в рамках расчетов банковским ордером type: string maxLength: 35 enum: - '01' - '02' - '03' - '04' - '06' - '09' - '16' - '17' ServiceLevelCode: description: | Вид платежа: type: string enum: - URGP - NURG x-enum-descriptions: - Срочный - Не срочный x-enum-varnames: - URGP - NURG PaymentTypeInformation: description: Информация о платеже additionalProperties: false type: object properties: localInstrument: description: (Номер реквизита 5) Вид платежного распоряжения. allOf: - $ref: '#/components/schemas/LocalInstrumentCode' categoryPurpose: description: | (Номер реквизита 15.3) Очередность платежа. Применение: Поле может принимать значение в диапазоне 0-5. Значение поля должно быть равно 0, если в соответствии с нормативными актами Банка России очередность платежа не применяется type: string example: '1' enum: - '0' - '1' - '2' - '3' - '4' - '5' serviceLevel: description: (Номер реквизита 15.1) Вид платежа allOf: - $ref: '#/components/schemas/ServiceLevelCode' BranchAndFinancialInstitutionInformationShort: description: Краткая информация о кредитной организации type: object additionalProperties: false properties: name: description: Наименование организации type: string pattern: ^[\w\W]{1,160}$ minLength: 1 maxLength: 160 example: Наименование организации schemeName: description: Наименование идентификационной схемы финансового учреждения allOf: - $ref: '#/components/schemas/FinancialInstitutionIdentificationCode' identification: description: Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '9612123' required: - schemeName - identification - name PartyChoice: description: Информация об участнике, используемая для идентификации юридического, физического лица или финансовой организации type: object additionalProperties: false properties: Agent: description: Информация об участнике, используемая для идентификации финансовой организации type: object allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationShort' Party: description: Информация об участнике, используемая для идентификации юридического или физического лица allOf: - $ref: '#/components/schemas/PartyIdentification' minProperties: 1 maxProperties: 1 ISOYearMonth: type: string description: Формат даты год и месяц pattern: ^(1[0-2]|0[1-9]|\d)\/([2-9]\d[1-9]\d|[1-9]\d)$ example: 12/2025 TrackData1: type: object description: Данные магнитной дорожки платежной карты или их эквивалент additionalProperties: false properties: trackNumber: description: Номер дорожки карты type: string pattern: ^[0-9]$ example: '1' trackValue: description: Содержание дорожки карты или его эквивалент type: string pattern: ^[\w\W]{1,140}$ maxLength: 140 minLength: 1 example: B1234567890123456^CARDHOLDER/JOHN^2512101000000000000000123000000 required: - trackValue CSCManagement1Code: type: string description: | Управление кодом безопасности карты (CSC) в связи с операцией

Значение

Описание

CSCPresent

CSC (Card Security Code) присутствует и передан для операции

CSCByPass

Обход CSC для транзакции

CSCUnread

CSC нечитабельный (не может быть прочитан с карты)

NoCSC

CSC отсутствует
enum: - CSCPresent - CSCByPass - CSCUnread - NoCSC CardSecurityInformation1: type: object additionalProperties: false description: Код безопасности карты (CSC), связанный с выполнением операции по карте properties: CSCManagement: $ref: '#/components/schemas/CSCManagement1Code' CSCValue: description: Код безопасности карты type: string pattern: ^[0-9]{3,4}$ example: '123' required: - CSCManagement PlainCardData1: type: object additionalProperties: false description: Конфиденциальные данные, связанные с выполнением операции по карте properties: PAN: description: Основной учетный номер карты (PAN) или номер карты type: string pattern: ^[*0-9]{4,28}$ example: '*0001' cardSequenceNumber: description: Идентификатор карты среди множества карт с одинаковым номером карты (PAN) type: string pattern: ^[0-9]{2,3}$ example: '01' effectiveDate: description: Дата, начиная с которой карту можно использовать allOf: - $ref: '#/components/schemas/ISOYearMonth' example: 12/2021 expiryDate: description: Дата окончания срока действия карты allOf: - $ref: '#/components/schemas/ISOYearMonth' example: 12/2025 serviceCode: description: Услуги по карте в соответствии с ISO 7813 type: string pattern: ^[0-9]{3}$ example: '121' TrackData: description: Данные магнитной дорожки платежной карты или их эквивалент type: array maxItems: 1000 items: $ref: '#/components/schemas/TrackData1' CardSecurityCode: description: Код безопасности карты (CSC), связанный с выполнением операции по карте allOf: - $ref: '#/components/schemas/CardSecurityInformation1' required: - PAN - expiryDate CountryCodeNumeric: description: Код страны по ISO-3166-1 в форме трехзначного цифрового кода type: string pattern: ^[0-9]{3}$ example: '643' PartyType3Code: description: | Тип субъекта в виде кода

Значение

Описание

OPOI

Участник системы операций по платежам

MERC

Продавец или получатель платежа

ACCP

Принимающий платежи участник

ITAG

Эмитент тегов или идентификаторов

ACQR

Банк-эквайер для карточных операций

CISS

Центральная информационная служба системы

DLIS

Поставщик или агент по доставке
type: string enum: - OPOI - MERC - ACCP - ITAG - ACQR - CISS - DLIS example: ACCP GenericIdentification32: type: object additionalProperties: false description: Информация, связанная с идентификацией properties: identification: description: Идентификатор субъекта type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: pc001 type: $ref: '#/components/schemas/PartyType3Code' required: - identification PaymentCard4: type: object description: Данные по платежной карте additionalProperties: false properties: PlainCardData: description: Конфиденциальные данные, связанные с выполнением операции по карте allOf: - $ref: '#/components/schemas/PlainCardData1' cardCountryCode: description: Код страны, присвоенный карте эмитентом карты allOf: - $ref: '#/components/schemas/CountryCodeNumeric' CardBrand: description: Брендовое наименование карты allOf: - $ref: '#/components/schemas/GenericIdentification32' additionalCardData: description: Дополнительные сведения, специфичные для эмитента карты type: string pattern: ^[\w\W]{1,70}$ example: Дополнительные сведения maxLength: 70 minLength: 1 POIComponentType1Code: type: string description: |- Управление кодом безопасности карты (CSC) в связи с операцией

Значение

Описание

CSCPresent

CSC (Card Security Code) присутствует и передан для операции

CSCByPass

Обход CSC для транзакции

CSCUnread

CSC нечитабельный (не может быть прочитан с карты)

NoCSC

CSC отсутствует
enum: - SOFT - EMVK - EMVO - MRIT - CHIT - SECM - PEDV example: CHIT PointOfInteractionComponent1: type: object additionalProperties: false description: Данные, относящиеся к компоненту POI, выполняющему операцию properties: POIComponentType: $ref: '#/components/schemas/POIComponentType1Code' manufacturerIdentification: description: Идентификатор поставщика программного обеспечения, аппаратной части или системы компонента POI-терминала type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: manufacturerIdentification model: description: Идентификатор модели компонента POI-терминала для определенного производителя type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: model versionNumber: description: Версия компонента, являющегося частью определенной модели type: string pattern: ^[\w\W]{1,16}$ maxLength: 16 minLength: 1 example: versionNumber serialNumber: description: Серийный номер компонента type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: serialNumber approvalNumber: description: Уникальный регистрационный номер компонента, предоставленный органом сертификации type: string pattern: ^[\w\W]{1,70}$ maxLength: 70 minLength: 1 example: approvalNumber required: - POIComponentType PointOfInteraction1: type: object additionalProperties: false description: Точка взаимодействия, выполняющая транзакцию properties: Identification: description: Уникальный и однозначный идентификатор (карты/POI-терминала), присвоенный идентифицирующей организацией allOf: - $ref: '#/components/schemas/GenericIdentification32' systemName: description: Общее название, присвоенное эквайером POI-системе type: string pattern: ^[\w\W]{1,70}$ maxLength: 70 minLength: 1 example: POI-sysname groupIdentification: description: Идентификатор, присвоенный торгово-сервисной организацией, идентифицирующий множество POI-терминалов, выполняющих некоторые категории операций type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: pi001 Component: description: Данные, относящиеся к компоненту POI, выполняющему операцию type: array maxItems: 1000 items: $ref: '#/components/schemas/PointOfInteractionComponent1' required: - Identification TransactionIdentifier1: type: object additionalProperties: false description: Идентификация операции однозначным способом properties: transactionDateTime: description: Дата и время основной операции (присвоенные POI-терминалом (точкой взаимодействия) allOf: - $ref: '#/components/schemas/ISODateTime' transactionReference: description: Идентификатор операции, который должен быть уникальным в течение периода времени type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: tr-0011 required: - transactionDateTime - transactionReference UnitOfMeasure1Code: type: string description: | Единицы измерения

Значение

Описание

PIEC

Штука

TONS

Тонна

FOOT

Фут

GBGA

Британский галлон

USGA

Американский галлон

GRAM

Грамм

INCH

Дюйм

KILO

Килограмм

PUND

Фунт

METR

Метр

CMET

Сантиметр

MMET

Миллиметр

LITR

Литр

CELI

Сантилитр

MILI

Миллилитр

GBOU

Британская жидкая унция

USOU

Американская жидкая унция

SQFO

Квадратный фут

SQME

Квадратный метр

CMMT

Кубический сантиметр

CBMT

Кубический метр
enum: - PIEC - TONS - FOOT - GBGA - USGA - GRAM - INCH - KILO - PUND - METR - CMET - MMET - LITR - CELI - MILI - GBOU - USOU - GBQA - USQA - GBPI - USPI - MILE - KMET - YARD - SQKI - HECT - ARES - SMET - SCMT - SMIL - SQMI - SQYA - SQFO - SQIN - ACRE example: KILO Product2: type: object additionalProperties: false description: Информация о продукте properties: productCode: description: Код продукта type: string pattern: ^[\w\W]{1,70}$ maxLength: 70 minLength: 1 example: code-01-ac unitOfMeasure: $ref: '#/components/schemas/UnitOfMeasure1Code' productQuantity: description: Количество товара type: string pattern: ^[0-9]{1,18}$|^[0-9]{1,18}[.][0-9]{1,18}$ example: '10.2' unitPrice: description: Цена за единицу товара $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' productAmount: description: Денежная стоимость приобретаемого товара $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' taxType: description: Код причины постановки на учет (КПП) type: string pattern: ^\d{9}$ example: '991230001' additionalProductInformation: description: Дополнительная информация о товаре type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: Дополнительная информация о товаре required: - productCode CardIndividualTransaction2: type: object additionalProperties: false description: Сведения об отдельной операции по карте, записанные на POI-терминале (точке взаимодействия) properties: transactionCategory: description: Код категории соответствует ISO 18245 и относится к типу услуг или товаров, которые продавец предоставляет для транзакции type: string pattern: ^[\w\W]{1,4}$ maxLength: 4 minLength: 1 sequenceNumber: description: Порядковый номер транзакции по карте, назначенный POI (точка взаимодействия) type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 minLength: 1 example: '01' TransactionIdentification: description: Идентификатор операции, назначенной POI (точка взаимодействия) allOf: - $ref: '#/components/schemas/TransactionIdentifier1' Product: description: Товар, заказанный по операции type: array maxItems: 1000 items: allOf: - $ref: '#/components/schemas/Product2' authorizationCode: description: Код авторизации операции type: string pattern: ^[\w\W]{3,35}$ maxLength: 35 minLength: 3 example: '123' CardTransaction18: type: object additionalProperties: false description: Предоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте properties: Card: $ref: '#/components/schemas/PaymentCard4' POI: description: Физический или логический карточный платежный терминал, состоящий из программного обеспечения и аппаратной части allOf: - $ref: '#/components/schemas/PointOfInteraction1' Transaction: description: Сведения об отдельной операции по карте, записанные на POI-терминале (точке взаимодействия) allOf: - $ref: '#/components/schemas/CardIndividualTransaction2' ReferredDocumentInformation: description: Информация о связанном документе. В первом повторении секции ReferredDocumentInformation указывается Дата составления распоряжения. По договоренности участников обмена могут быть указаны иные коды связанных документов в последующих повторениях секции ReferredDocumentInformation. type: object additionalProperties: false properties: type: description: | Тип связанного документа. Для указания Даты составления распоряжения (реквизит 4) в relatedDate в данном поле указывается значение "POD" (Payment Order Date). Допустимо использовать иные коды по договоренности участников обмена. type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '0' number: description: Номер связанного документа type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '0' relatedDate: description: Дата связанного документа type: string format: date example: '2021-06-05' CreditorReferenceInformation: type: object description: Информация о референсах, предоставленная получателем денежных средств, позволяющая идентифицировать исходные документы. additionalProperties: false properties: type: description: | Тип идентификатора платежа (Номер реквизита 15.6.n) Возможные значения реквизита: -УИП2: Уникальный идентификатор платежа, присвоенный получателем средств или идентификатор государственного контракта. -УИН: Уникальный идентификатор начисления. -ИПД: Идентификатор платежного документа. -ЕЛС: Единый лицевой счет. -ЖКУ: Идентификатор жилищно-коммунальных услуг. -ДОГН: Номер договора, товарного документа, иного документа, являющегося основанием платежа. -ДОКД: Дата договора, товарного документа, иного документа, являющегося основанием платежа. -Период оплаты платежа. -Иное, по договоренности участников обмена. type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 example: ИПД reference: description: Значение идентификатора платежа (Номер реквизита 15.7.n). Ссылка, присвоенная получателем денежных средств, которая является основанием для осуществления перевода type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: CBR-130 TaxParty: description: Налоговая информация об участнике перевода денежных средств type: object additionalProperties: false properties: taxType: description: Код причины постановки на учет (КПП) type: string pattern: ^\d{9}$ example: '991230001' registrationIdentification: description: Реквизит 107. Код таможенного органа (Поле заполняется для распоряжений по уплате таможенных платежей) type: string pattern: ^[\w\W]{1,35}$ maxLength: 35 example: aa-12340 TaxRecordPeriodCode: description: "Тип налогового периода (реквизит 107)\n\n\n\t\n\t\n\n\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\n\t\n\n
\n\t\t

Значение

\n\t		\n\t\t

Описание

\n\t

MM01

Январь

MM02

Февраль

MM03

Март

MM04

Апрель

MM05

Май

MM06

Июнь

MM07

Июль

MM08

Август

MM09

Сентябрь

MM10

Октябрь

MM11

Ноябрь

MM12

Декабрь

QTR1

Первый квартал

QTR2

Второй квартал

QTR3

Третий квартал

QTR4

Четвертый квартал

HLF1

Первое полугодие

HLF2

Второе полугодие

\n" type: string example: MM02 enum: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 x-enum-descriptions: - Январь - Февраль - Март - Апрель - Май - Июнь - Июль - Август - Сентябрь - Октябрь - Ноябрь - Декабрь - Первый квартал - Второй квартал - Третий квартал - Четвертый квартал - Первое полугодие - Второе полугодие x-enum-varnames: - MM01 - MM02 - MM03 - MM04 - MM05 - MM06 - MM07 - MM08 - MM09 - MM10 - MM11 - MM12 - QTR1 - QTR2 - QTR3 - QTR4 - HLF1 - HLF2 TaxPeriod: description: Налоговый период type: object additionalProperties: false properties: year: description: Год, к которому относится налог type: string pattern: ^([1-9][0-9]{3}|0[0-9]{3})-01-01$ example: '2021-01-01' type: description: Тип налогового периода (реквизит 107) allOf: - $ref: '#/components/schemas/TaxRecordPeriodCode' example: MM02 fromDate: description: Дата уплаты налогового платежа allOf: - $ref: '#/components/schemas/ISODateTime' toDate: description: Дата уплаты налогового платежа allOf: - $ref: '#/components/schemas/ISODateTime' CBRFTaxRate: description: Процентная ставка НДС type: string pattern: ^\d{1,2}$ example: '20' TaxAmount: description: Информация о НДС type: object additionalProperties: false properties: rate: description: Ставка НДС (Номер реквизита 14.3) allOf: - $ref: '#/components/schemas/CBRFTaxRate' totalAmount: description: Сумма НДС (Номер реквизита 14.4) allOf: - $ref: '#/components/schemas/ActiveCurrencyAndAmountSimpleType' TaxRecord: description: Дополнительные налоговые реквизиты type: object additionalProperties: false properties: type: description: Реквизит 110. Код выплат type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '1234' category: description: Реквизит 106. Основание налогового платежа type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: TP categoryDetails: description: Код бюджетной классификации type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '18210301000011000000' debtorStatus: description: Статус налогоплательщика type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: '13' Period: description: (Номер реквизита 14.2) Налоговый период type: array maxItems: 50 items: $ref: '#/components/schemas/TaxPeriod' minItems: 0 TaxAmount: description: Информация о НДС allOf: - $ref: '#/components/schemas/TaxAmount' TaxInformation: description: Налоговая информация type: object additionalProperties: false properties: administrationZone: description: Реквизит 105. Код по Общероссийскому классификатору территорий муниципальных образований ОКТМО type: string maxLength: 11 pattern: ^\d{1,11}$ example: '45388000' referenceNumber: description: Реквизит 108. Номер налогового документа type: string pattern: ^[\w\W]{1,140}$ minLength: 1 maxLength: 140 example: '120' date: description: Реквизит 109. Дата налогового документа allOf: - $ref: '#/components/schemas/ISODateTime' creditor: description: Налоговая информация о получателе средств allOf: - $ref: '#/components/schemas/TaxParty' debtor: description: Налоговая информация о плательщике allOf: - $ref: '#/components/schemas/TaxParty' Record: description: Дополнительные налоговые реквизиты allOf: - $ref: '#/components/schemas/TaxRecord' RemittanceInformation: description: Назначение платежа. Предоставляемая информация, позволяющая сопоставить запись с позициями, для которых предназначен перевод type: object additionalProperties: false properties: unstructured: description: Текстовое назначение платежа type: string pattern: ^[\w\W]{1,210}$ minLength: 1 maxLength: 210 example: Назначение платежа - оплата за товары или услуги ReferredDocumentInformation: description: Информация о связанном документе. В первом повторении секции ReferredDocumentInformation указывается Дата составления распоряжения. По договоренности участников обмена могут быть указаны иные коды связанных документов в последующих повторениях секции ReferredDocumentInformation. type: array minItems: 0 maxItems: 50 items: $ref: '#/components/schemas/ReferredDocumentInformation' CreditorReferenceInformation: description: Информация от получателя денежных средств allOf: - $ref: '#/components/schemas/CreditorReferenceInformation' TaxRemittance: description: Информация о платеже, которая связана с оплатой налогов allOf: - $ref: '#/components/schemas/TaxInformation' required: - unstructured ReportEntry: description: Запись об операция по счету type: object additionalProperties: false properties: transactionIdentification: description: Уникальный и неизменный идентификатор, используемый для идентификации операции по счету type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-transaction-id instructionIdentification: description: Уникальный идентификатор, присвоенный инструктирующей стороной для инструктируемой стороны для однозначного определения инструкции type: string pattern: ^[\w\W]{1,35}$ minLength: 1 maxLength: 35 example: 12345-IID-001 endtoendIdentification: description: Уникальный идентификатор, присвоенный инструктирующей стороной для инструктируемой стороны для однозначного определения инструкции type: string pattern: ^[\w\W]{1,40}$ minLength: 1 maxLength: 35 example: 12345-EEID-001 uetr: description: Указывается идентификатор, присваиваемый при передаче распоряжения с использованием системы SWIFT, в соответствии со стандартом RFC 4122 (IETF) type: string pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}' minLength: 1 maxLength: 36 example: de2da6c9-18be-48d4-8053-867ed90a316a purpose: description: (Номер реквизита 15.5 Код вида дохода) Причина, по которой осуществляется платеж. allOf: - $ref: '#/components/schemas/PurposeCode' creditDebitIndicator: description: Определяет является ли операция дебетовая или кредитовая allOf: - $ref: '#/components/schemas/CreditDebitCode' status: description: Статус операции по счету allOf: - $ref: '#/components/schemas/TransactionStatusCode' bookingDateTime: description: Дата и время, когда запись об операции по счету публикуется на счете в бухгалтерской книге обслуживающей организации. Используется стандарт ISO8601 type: string format: date-time example: '2023-12-15T00:00:00+00:00' valueDateTime: description: Дата и время, когда активы становятся доступными владельцу счета в случае ввода кредита или перестают быть доступными владельцу счета в случае ввода дебетовой операции по счету type: string format: date-time example: '2023-12-15T00:00:00+00:00' Amount: description: Информация о сумме и валюте операции по счету для данной записи (Примечание - TransactionAmount,ChargeAmount,InstructedAmount - это детали данного реквизита) allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' TransactionAmount: description: Сумма в валюте исходной операции по счету allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' ChargeAmount: description: Комиссия за операции по счету allOf: - $ref: '#/components/schemas/ActiveOrHistoricCurrencyAndAmount' InstructedAmount: description: Сумма денег и информации об обменом курсе, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной в случае, если указанная сумма и/или валюта отличаются от суммы и/или валюты операции по счету allOf: - $ref: '#/components/schemas/AmountAndCurrencyExchangeDetails' BankTransactionCode: description: Подробная информация для полной идентификации собственного банковского кода операции по счету allOf: - $ref: '#/components/schemas/BankTransactionCode' PaymentTypeInformation: description: Информация о типе платежа allOf: - $ref: '#/components/schemas/PaymentTypeInformation' UltimateDebtor: description: Фактический плательщик allOf: - $ref: '#/components/schemas/PartyIdentification' Debtor: description: Плательщик allOf: - $ref: '#/components/schemas/PartyChoice' DebtorAgent: description: Финансовое организация, обслуживающая счет плательщика allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationShort' DebtorAgentAccount: description: Однозначная идентификация счета плательщика у обслуживающего его банка в платежной цепочке allOf: - $ref: '#/components/schemas/CashAccount' DebtorAccount: description: Уникальная идентификация счета плательщика, на котором будет сделана дебетовая запись в результате операции allOf: - $ref: '#/components/schemas/CashAccount' IntermediaryAgent: description: Банк-посредник, находящийся между банком плательщика и банком получателя денежных средств allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationShort' IntermediaryAgentAccount: description: Счет банка-посредника allOf: - $ref: '#/components/schemas/CashAccount' CreditorAgent: description: Финансовое организация, обслуживающая счет получателя денежных средств allOf: - $ref: '#/components/schemas/BranchAndFinancialInstitutionInformationShort' CreditorAccount: description: Идентификатор счета получателя средств, на котором будет проведена запись о кредите в результате операции allOf: - $ref: '#/components/schemas/CashAccount' CreditorAgentAccount: description: Однозначная идентификация счета банка получателя денежных средств у обслуживающего его банка, по которому будет выполнена кредитовая запись в результате платежной операции allOf: - $ref: '#/components/schemas/CashAccount' Creditor: description: Получатель денежных средств allOf: - $ref: '#/components/schemas/PartyChoice' UltimateCreditor: description: Фактический получатель денежных средств allOf: - $ref: '#/components/schemas/PartyIdentification' CardTransaction: description: |- Предоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте allOf: - $ref: '#/components/schemas/CardTransaction18' RemittanceInformation: description: Предоставляемая информация, позволяющая сопоставить запись с позициями, для которых предназначен перевод, такими как коммерческие счета в системе дебиторской задолженности allOf: - $ref: '#/components/schemas/RemittanceInformation' required: - status - bookingDateTime - Amount - creditDebitIndicator Statement: description: Выписка по счету type: object additionalProperties: false properties: statementId: description: Идентификатор ресурса выписки type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-statement-id accountId: description: Уникальный и неизменный идентификатор, используемый для идентификации ресурса accounts type: string pattern: ^[a-zA-Z0-9-]{1,40}$ minLength: 1 maxLength: 40 example: this-is-a-slug-format-account-id fromBookingDateTime: description: Дата и время начала выписки allOf: - $ref: '#/components/schemas/ISODateTime' example: '2019-09-15T00:00:00+00:00' toBookingDateTime: description: Дата и время окончания выписки allOf: - $ref: '#/components/schemas/ISODateTime' example: '2019-12-15T00:00:00+00:00' creationDateTime: description: Дата и время создания ресурса allOf: - $ref: '#/components/schemas/ISODateTime' Balance: type: array maxItems: 10 minItems: 0 items: $ref: '#/components/schemas/CashBalance' description: Информация об остатках по счету (например, в массиве можно указать значения на начало и конец операционного дня) TransactionsSummary: description: Обороты по кредиту и дебету allOf: - $ref: '#/components/schemas/TransactionsSummary' Entry: type: array maxItems: 500 items: $ref: '#/components/schemas/ReportEntry' minItems: 0 description: Список операций required: - statementId - accountId - fromBookingDateTime - toBookingDateTime - creationDateTime StatementStatementIdResponse: description: Получение выписки по идентификатору type: object additionalProperties: false properties: Data: description: Раздел данных полезной нагрузки ответа allOf: - $ref: '#/components/schemas/Statement' Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links' example: self: https://sb.example.ru/open-banking/v2.0/aisp-le/statementsthis-is-a-slug-format-statement-id?page=1 first: https://sb.example.ru/open-banking/v2.0/aisp-le/statementsthis-is-a-slug-format-statement-id?page=1 prev: https://sb.example.ru/open-banking/v2.0/aisp-le/statementsthis-is-a-slug-format-statement-id?page=1 next: https://sb.example.ru/open-banking/v2.0/aisp-le/statementsthis-is-a-slug-format-statement-id?page=1 last: https://sb.example.ru/open-banking/v2.0/aisp-le/statementsthis-is-a-slug-format-statement-id?page=1 Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta' required: - Data minProperties: 1 maxProperties: 3 x-example: Data: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: '2019-09-15T00:00:00+00:00' toBookingDateTime: '2019-12-15T00:00:00+00:00' creationDateTime: '2021-06-05T15:15:13+00:00' Balance: - creditDebitIndicator: Debit type: ClosingAvailable Amount: amount: '200.00' currency: RUB TransactionsSummary: TotalCreditEntries: numberOfEntries: '2' sum: '100.00' currency: RUB TotalDebitEntries: numberOfEntries: '2' sum: '1500.00' currency: RUB Entry: - transactionIdentification: this-is-a-slug-format-transaction-id instructionIdentification: 12345-IID-001 endtoendIdentification: 12345-EEID-001 uetr: de2da6c9-18be-48d4-8053-867ed90a316a purpose: '1' creditDebitIndicator: Debit status: AcceptedSettlementCompleted bookingDateTime: '2023-12-15T00:00:00+00:00' accDocDate: '2021-01-01' valueDateTime: '2023-12-15T00:00:00+00:00' Amount: amount: '200.00' currency: RUB TransactionAmount: amount: '200.00' currency: RUB ChargeAmount: amount: '200.00' currency: RUB InstructedAmount: Amount: amount: '200.00' currency: RUB CurrencyExchange: sourceCurrency: RUB targetCurrency: RUB unitCurrency: RUB exchangeRate: '0.7' contractIdentification: DOC441234-1234-1234 quotationDate: '2021-06-05T15:15:13+00:00' BankTransactionCode: code: '20' subCode: '20' issuer: RU.CBR PaymentTypeInformation: localInstrument: '01' categoryPurpose: '1' serviceLevel: URGP UltimateDebtor: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Debtor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: '9612123' OrganizationIdentification: - schemeName: RU.CBR.TXID identification: '7728240240' CorrespondentAccount: schemeName: RU.CBR.BBAN identification: '40817810621234570000' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU DebtorAgent: schemeName: RU.CBR.BIC identification: '9612123' DebtorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' DebtorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' IntermediaryAgent: schemeName: RU.CBR.BIC identification: '9612123' IntermediaryAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' CreditorAgent: schemeName: RU.CBR.BIC identification: '9612123' CreditorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' CreditorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' Creditor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: '9612123' OrganizationIdentification: - schemeName: RU.CBR.TXID identification: '7728240240' CorrespondentAccount: schemeName: RU.CBR.BBAN identification: '40817810621234570000' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU UltimateCreditor: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU CardTransaction: Card: PlainCardData: PAN: '*0001' cardSequenceNumber: '01' effectiveDate: 12/2021 expiryDate: 12/2025 serviceCode: '121' TrackData: - trackNumber: string trackValue: string CardSecurityCode: CSCManagement: CSCPresent CSCValue: '123' cardCountryCode: '643' CardBrand: identification: string type: ACCP additionalCardData: Дополнительные сведения POI: Identification: identification: string type: ACCP systemName: string groupIdentification: string Component: - POIComponentType: CHIT manufacturerIdentification: manufacturerIdentification model: model versionNumber: versionNumber serialNumber: serialNumber approvalNumber: approvalNumber Transaction: transactionCategory: stri sequenceNumber: string TransactionIdentification: transactionDateTime: '2021-06-05T15:15:13+00:00' transactionReference: string Product: - productCode: string unitOfMeasure: KILO productQuantity: '10.2' unitPrice: '200.00' productAmount: '200.00' taxType: string additionalProductInformation: string authorizationCode: string RemittanceInformation: unstructured: Назначение платежа - оплата за товары или услуги ReferredDocumentInformation: - Type: '0' Number: '0' RelatedDate: '2021-06-05T15:15:13+00:00' CreditorReferenceInformation: type: ИПД reference: CBR-130 TaxRemittance: administrationZone: '45388000' referenceNumber: '120' date: '2021-06-05T15:15:13+00:00' creditor: taxType: '991230001' registrationIdentification: aa-12340 debtor: taxType: '991230001' registrationIdentification: aa-12340 Record: type: '1234' category: TP categoryDetails: '18210301000011000000' debtorStatus: '13' Period: - year: '2021-01-01' type: MM02 fromDate: '2021-06-05T15:15:13+00:00' toDate: '2021-06-05T15:15:13+00:00' TaxAmount: rate: '20' totalAmount: '200.00' Links: self: https://sb.example.ru/v1.3/example?page=1 first: https://sb.example.ru/v1.3/example?page=1 prev: https://sb.example.ru/v1.3/example?page=1 next: https://sb.example.ru/v1.3/example?page=1 last: https://sb.example.ru/v1.3/example?page=1 Meta: totalPages: 1 StatementAccountIdResponse: description: Ответ запроса на выписку по идентификатору счета type: object additionalProperties: false properties: Data: description: Раздел данных полезной нагрузки ответа allOf: - $ref: '#/components/schemas/Statement' Links: description: Раздел для указания ссылок allOf: - $ref: '#/components/schemas/Links' example: self: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200/statements?page=1 first: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200/statements?page=1 prev: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200/statements?page=1 next: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200/statements?page=1 last: https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200/statements?page=1 Meta: description: Раздел метаданных allOf: - $ref: '#/components/schemas/Meta' required: - Data minProperties: 1 maxProperties: 3 x-example: Data: statementId: this-is-a-slug-format-statement-id accountId: this-is-a-slug-format-account-id fromBookingDateTime: '2019-09-15T00:00:00+00:00' toBookingDateTime: '2019-12-15T00:00:00+00:00' creationDateTime: '2021-06-05T15:15:13+00:00' Balance: - creditDebitIndicator: Debit type: ClosingAvailable Amount: amount: '200.00' currency: RUB TransactionsSummary: TotalCreditEntries: numberOfEntries: '2' sum: '100.00' currency: RUB TotalDebitEntries: numberOfEntries: '2' sum: '1500.00' currency: RUB Entry: - transactionIdentification: this-is-a-slug-format-transaction-id instructionIdentification: 12345-IID-001 endtoendIdentification: 12345-EEID-001 uetr: de2da6c9-18be-48d4-8053-867ed90a316a purpose: '1' creditDebitIndicator: Debit status: AcceptedSettlementCompleted bookingDateTime: '2023-12-15T00:00:00+00:00' accDocDate: '2021-01-01' valueDateTime: '2023-12-15T00:00:00+00:00' Amount: amount: '200.00' currency: RUB TransactionAmount: amount: '200.00' currency: RUB ChargeAmount: amount: '200.00' currency: RUB InstructedAmount: Amount: amount: '200.00' currency: RUB CurrencyExchange: sourceCurrency: RUB targetCurrency: RUB unitCurrency: RUB exchangeRate: '0.7' contractIdentification: DOC441234-1234-1234 quotationDate: '2021-06-05T15:15:13+00:00' BankTransactionCode: code: '20' subCode: '20' issuer: RU.CBR PaymentTypeInformation: localInstrument: '01' categoryPurpose: '1' serviceLevel: URGP UltimateDebtor: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Debtor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: '9612123' OrganizationIdentification: - schemeName: RU.CBR.TXID identification: '7728240240' CorrespondentAccount: schemeName: RU.CBR.BBAN identification: '40817810621234570000' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU DebtorAgent: schemeName: RU.CBR.BIC identification: '9612123' DebtorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' DebtorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' IntermediaryAgent: schemeName: RU.CBR.BIC identification: '9612123' IntermediaryAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' CreditorAgent: schemeName: RU.CBR.BIC identification: '9612123' CreditorAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' CreditorAgentAccount: name: Основной счет schemeName: RU.CBR.BBAN identification: '40817810621234570000' Creditor: Agent: name: Наименование организации или физического лица BankIdentification: - schemeName: RU.CBR.BIC identification: '9612123' OrganizationIdentification: - schemeName: RU.CBR.TXID identification: '7728240240' CorrespondentAccount: schemeName: RU.CBR.BBAN identification: '40817810621234570000' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU Party: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU UltimateCreditor: name: Наименование организации или физического лица mobileNumber: '79206001010' countryOfResidence: RU countryOfBirth: RU provinceOfBirth: Ставропольский край cityOfBirth: Ставрополь birthDate: '2021-06-05T15:15:13+00:00' Identification: - schemeName: RU.CBR.TXID identification: '7728240240' PostalAddress: addressType: Postal addressLine: - Адрес в виде строки - вторая часть строки адреса streetName: Садовая buildingNumber: '11' postCode: '0100010' townName: Бигсити countrySubDivision: Мой край country: RU CardTransaction: Card: PlainCardData: PAN: '*0001' cardSequenceNumber: '01' effectiveDate: 12/2021 expiryDate: 12/2025 serviceCode: '121' TrackData: - trackNumber: string trackValue: string CardSecurityCode: CSCManagement: CSCPresent CSCValue: '123' cardCountryCode: '643' CardBrand: identification: string type: ACCP additionalCardData: Дополнительные сведения POI: Identification: identification: string type: ACCP systemName: string groupIdentification: string Component: - POIComponentType: CHIT manufacturerIdentification: manufacturerIdentification model: model versionNumber: versionNumber serialNumber: serialNumber approvalNumber: approvalNumber Transaction: transactionCategory: stri sequenceNumber: string TransactionIdentification: transactionDateTime: '2021-06-05T15:15:13+00:00' transactionReference: string Product: - productCode: string unitOfMeasure: KILO productQuantity: '10.2' unitPrice: '200.00' productAmount: '200.00' taxType: string additionalProductInformation: string authorizationCode: string RemittanceInformation: unstructured: Назначение платежа - оплата за товары или услуги ReferredDocumentInformation: - Type: '0' Number: '0' RelatedDate: '2021-06-05T15:15:13+00:00' CreditorReferenceInformation: type: ИПД reference: CBR-130 TaxRemittance: administrationZone: '45388000' referenceNumber: '120' date: '2021-06-05T15:15:13+00:00' creditor: taxType: '991230001' registrationIdentification: aa-12340 debtor: taxType: '991230001' registrationIdentification: aa-12340 Record: type: '1234' category: TP categoryDetails: '18210301000011000000' debtorStatus: '13' Period: - year: '2021-01-01' type: MM02 fromDate: '2021-06-05T15:15:13+00:00' toDate: '2021-06-05T15:15:13+00:00' TaxAmount: rate: '20' totalAmount: '200.00' Links: self: https://sb.example.ru/v1.3/example?page=1 first: https://sb.example.ru/v1.3/example?page=1 prev: https://sb.example.ru/v1.3/example?page=1 next: https://sb.example.ru/v1.3/example?page=1 last: https://sb.example.ru/v1.3/example?page=1 Meta: totalPages: 1 responses: 200GetAccountsLE: description: Полный список счетов (с идентификаторами accountId), которые были авторизованы Пользователем на стороне ППИУ headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/AccountResponseLE' 400Error-req: description: Запрос имеет неверное, отсутствующее или несовместимое тело JSON, параметры URL или поля заголовка headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' examples: obru: value: code: '400' id: 5aca5b0d-1730-416f-a52b-6d353b687082 message: Bad Request Errors: - errorCode: RU.CBR.Field.Missing message: Обязательное поле, необходимое для API, отсутствует в полезной нагрузке path: Data.Model.Object.filled url: https://example.com/error-description 401Error-req: description: Заголовок авторизации отсутствует или неверный токен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid www-authenticate: required: true schema: type: string enum: - Valid token required 403Error-req: description: Токен имеет неверную область действия или была нарушена политика безопасности headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: '403' id: ab41a751-619b-4947-bf0a-251f6e92f599 message: Forbidden Errors: - errorCode: RU.CBR.Authenticate.InvalidScope message: Предъявленный токен доступа не содержит область действия (scope) необходимый для доступа к ресурсу url: https://example.com/error-description 405Error-req: description: Сторонний Поставщик пытается получить доступ к ресурсу с помощью метода, который не поддерживается headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. 406Error-req: description: Запрос содержал параметр заголовка Accept, отличный от разрешенных media types, и набор символов, отличный от UTF-8 headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. 429Error-req: description: Операция была отклонена, так как слишком много запросов было сделано в течение определенного периода времени headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. Retry-After: schema: type: string 500Error-req: description: Что-то пошло не так на стороне Стороннего поставщика. headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: '500' id: af467d1b-985d-4a8e-972e-24a32287085f message: Internal Server Error Errors: - errorCode: RU.CBR.UnexpectedError message: Что-то пошло не так на стороне Поставщика услуг url: https://example.com/error-description 501Error-req: description: Сторонний поставщик не поддерживает функции, необходимые для выполнения запроса headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: '501' id: 451f7718-2e96-46f0-b286-4b1c8370b87e message: Not Implemented Errors: - errorCode: RU.CBR.UnexpectedError message: Метод не поддерживается url: https://example.com/error-description 503Error-req: description: Сервис временно не доступен headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. content: application/json: schema: $ref: '#/components/schemas/OBRUErrorResponse' example: code: '503' id: 63a8dddb-b92d-4ac7-82c3-c9a9efb878a5 message: Service Unavailable Errors: - errorCode: RU.CBR.UnexpectedError message: Сервис временно не доступен url: https://example.com/error-description 200GetAccountsLEAccountId: description: Полный список счетов (с идентификаторами accountId), которые были авторизованы Пользователем на стороне ППИУ headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/AccountResponseLE' 200GetAccountsAccountIdBalancesLE: description: | Получение информации об остатке на счете с идентификатором accountId headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/BalanceResponseLE' 200GetBalancesLE: description: Получение информации об остатке по всем банковским счетам, которые Пользователь авторизовал с помощью согласия headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/BalanceResponseLE' 201PostStatementInitResponse: description: Индентификатор выписки headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementInitResponse' 200GetStatementsStatementId: description: Ответ получения выписки по идентификатору выписки headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementStatementIdResponse' 200GetAccountsAccountIdStatements: description: Ответ получения выписки по идентификатору счета headers: x-fapi-interaction-id: required: true schema: type: string format: uuid description: RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то Сторонний поставщик передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. x-jws-signature: required: true description: Отделяемая подпись полезной нагрузки в формате JWS schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementAccountIdResponse'