ПРИНЯТ И ВВЕДЕН в действие приказом Банка России от __ _____ 202_ года № ___ «О введении в действие стандарта СТО БР XXX xxx Банка России «Открытые программные интерфейсы.» Получение информации о банковских счетах Пользователя. Методы для Юридических лиц. Спецификация API.»
Настоящий Стандарт не может быть полностью или частично воспроизведен, тиражирован и распространен в качестве официального издания без разрешения Банка России.
Стандарт содержит описание конечных точек, модели данных и контроля доступа к данным, которые являются общими для всех API, определяющих взаимодействие между СПУ и ПУ в процессе получения информации по банковским счетам Юридических лиц.
Стандарт рекомендован к использованию организациями при обмене финансовыми сообщениями, связанными с получением информации о банковском счете. Стандарт предназначен для:
Положения настоящего стандарта применяются на добровольной основе, если только в отношении конкретных положений обязательность их применения не установлена нормативными актами Банка России или условиями договоров. Положения настоящего стандарта применяются совместно со следующими документами:
В Стандарте применяются термины и определения в соответствии со стандартами ФАПИ.СЕК, ФАПИ.ПАОК, «Открытые программные интерфейсы. Общие положения», «Открытые программные интерфейсы. Глоссарий».
Спецификация API определяет поток взаимодействия при получении информации о счете Пользователя третей стороной через информационный сервис Среды Открытых программных интерфейсов, которые позволяют СПУ:
Сервер ресурсов в рамках данной спецификации должен предоставлять единственный URI, соответствующий следующей структуре:
- participant-path-prefix]/open-banking/[version]/[resource-group]/[resource]/[resource-id]/[sub-resource]
При этом параметр resource-group для данной спецификации должен иметь значение aisp-le.
Спецификация API определяет следующие конечные точки
|
Наименование API |
Метод |
Обязательность |
Описание |
Метод авторизации |
|---|---|---|---|---|
|
Accounts |
Да |
Получение списка счетов |
Client Authorization code flow; scopes: |
|
|
Accounts |
Да |
Получение детальной информации о счете по его идентификатору |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
|
|
Balances |
Да |
Баланс банковского счета по идентификатору accountId |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
|
|
Balances |
Да |
Остаток денежных средств по всем счетам |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
|
|
Statements Async |
Да |
Создание ресурса выписки |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
|
|
Statements Async |
Да |
Получение выписки по идентификатору выписки |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
|
|
Statements Sync |
Да |
Получение выписки по идентификатору счета |
Client Authorization code flow; scopes: obru_accounts_le: доступ к информации о счете |
get /accounts|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
page |
(Нет) |
Integer; format: int32 |
Номер страницы |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
get /accounts/{accountId}accountId (getAccountsAccountId )|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
get /accounts/{accountId}/balances|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
date |
(Нет) |
Date; format: date-time |
Дата, за которую необходимо получить изменения по балансу счёта. Формат даты должен быть ГГГГ-ММ-ДД. |
|
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
get /balances|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
page |
(Нет) |
Integer; format: int32 |
Номер страницы |
|
|
date |
(Нет) |
Date; format: date-time |
Дата, за которую необходимо получить изменения по балансу счёта. Формат даты должен быть ГГГГ-ММ-ДД. |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
post /statementsapplication/json|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-idempotency-key |
(Нет) |
UUID; format: uuid |
Уникальный идентификатор запроса для поддержки идемпотентности. Обязательно для запросов POST к конечным точкам идемпотентного ресурса. Для других запросов не указывается. |
|
|
x-jws-signature |
(Да) |
String |
Отделяемая подпись полезной нагрузки в формате JWS |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
201 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
get /statements/{statementId}|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
page |
(Нет) |
Integer; format: int32 |
Номер страницы |
|
|
fromBookingDateTime |
(Нет) |
Date; format: date-time |
Дата и время начала фильтрации списка операций по счету |
|
|
toBookingDateTime |
(Нет) |
Date; format: date-time |
Дата и время окончания фильтрации списка операций по счету |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
get /accounts/{accountId}/statements|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
x-fapi-auth-date |
(Нет) |
String |
Время последнего входа Пользователя в систему с TPP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT |
/^[a-zA-Z0-9 :,]{29}$/ |
|
x-fapi-customer-ip-address |
(Нет) |
String |
IP-адрес Пользователя, если Пользователь в данный момент подключен к СПУ (авторизован в приложении СПУ). |
/^([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(\d{1,3}.){3}\d{1,3}$/ |
|
x-fapi-interaction-id |
(Да) |
UUID; format: uuid |
RFC4122 UID, используемый в качестве идентификатора корреляции. Если необходимо, то СПУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id. |
|
|
x-customer-user-agent |
(Нет) |
String |
В заголовке указывается тип устройства (user-agent), который использует Пользователь. СПУ может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. Если Пользователь использует мобильное приложение СПУ, СПУ проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера. |
|
|
Наименование |
Обязательность |
Тип |
Описание |
Паттерн |
|---|---|---|---|---|
|
page |
(Нет) |
Integer; format: int32 |
Номер страницы |
|
|
fromBookingDateTime |
(Нет) |
Date; format: date-time |
Дата и время начала фильтрации списка операций по счету |
|
|
toBookingDateTime |
(Нет) |
Date; format: date-time |
Дата и время окончания фильтрации списка операций по счету |
|
Данный метод API предоставляет следующие типы данных (media types):
application/json
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
|
HTTP код |
Тип ответа |
|
200 |
|
|
400 |
|
|
401 |
|
|
403 |
|
|
405 |
|
|
406 |
|
|
429 |
|
|
500 |
|
|
501 |
|
|
503 |
Спецификация API определяет типы и форматы данных, значения по умолчанию, перечисления и справочную информацию.
AccountLE|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
accountId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса |
/^[a-zA-Z0-9-]{1,40}$/ |
|
status |
(Да) |
Статус счета в форме кода |
|
|
|
statusUpdateDateTime |
(Нет) |
string; format: date-time |
Дата и время изменения статуса счета |
|
|
currency |
(Да) |
string |
Валюта ведения счета |
/^[A-Z]{3,3}$/ |
|
accountType |
(Да) |
Тип счета (физическое или юридическое лицо) |
|
|
|
accountDescription |
(Да) |
string |
Краткое описание назначения счета или продукта, привязанного к счету |
/^[\w\W]{1,128}$/ |
|
AccountDetails |
(Нет) |
Идентификация счета |
|
|
|
Owner |
(Нет) |
Информация о владельце счета |
|
|
|
Servicer |
(Нет) |
BranchAndFinancialInstitutionInformation |
Информация о кредитной организации, облужиывющий счет клиента |
|
Balance|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
accountId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса счета |
/^[a-zA-Z0-9-]{1,40}$/ |
|
type |
(Да) |
Тип остатка |
|
|
|
Amount |
(Да) |
Сумма остатка |
|
|
|
creditDebitIndicator |
(Да) |
Определяет является остаток кредитовым или дебетовым |
|
|
|
dateTime |
(Да) |
string; format: date-time |
Дата, на которую рассчитан остаток |
|
|
CreditLine |
(Нет) |
Кредитная линия |
|
AccountResponseLE|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
|
|
|
|
Links |
(Нет) |
Раздел для указания ссылок |
|
|
|
Meta |
(Нет) |
Раздел метаданных |
|
AccountResponseLE_Data|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Account |
(Нет) |
|
|
ActiveOrHistoricCurrencyAndAmount|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
amount |
(Да) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
currency |
(Да) |
string |
Код валюты, соответствующий международному стандарту ISO 4217 |
/^[A-Z]{3,3}$/ |
AmountAndCurrencyExchangeDetails|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Amount |
(Нет) |
Сумма денег, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной |
|
|
|
CurrencyExchange |
(Нет) |
Набор элементов, используемые для указания информации об обменом курсе. Использование: Это может быть либо встречная сумма, указанная в сделке с иностранной валютой, либо результат информации о валюте, примененной к указанной сумме, до вычета расходов |
|
BalanceResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Раздел данных полезной нагрузки ответа |
|
|
|
Links |
(Нет) |
Раздел для указания ссылок |
|
|
|
Meta |
(Нет) |
Раздел метаданных |
|
BankTransactionCode|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
code |
(Да) |
string |
Тип банковской операции |
/^[\w\W]{1,35}$/ |
|
subCode |
(Нет) |
string |
Подтип банковской операции |
/^[\w\W]{1,35}$/ |
|
issuer |
(Нет) |
string |
Идентификация эмитента собственного банковского кода операции по счету |
/^[\w\W]{1,35}$/ |
BranchAndFinancialInstitutionIdentification|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
Наименование идентификационной схемы финансового учреждения |
|
|
|
identification |
(Да) |
string |
Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения |
/^[\w\W]{1,35}$/ |
BranchAndFinancialInstitutionInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Да) |
string |
Наименование организации |
/^[\w\W]{1,160}$/ |
|
BankIdentification |
(Да) |
Идентификация финансового учреждения |
|
|
|
OrganizationIdentification |
(Нет) |
Идентификация юридического лица. |
|
|
|
CorrespondentAccount |
(Нет) |
BranchAndFinancialInstitutionInformation_CorrespondentAccount |
|
|
|
PostalAddress |
(Нет) |
|
|
BranchAndFinancialInstitutionInformationShort|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Да) |
string |
Наименование организации |
/^[\w\W]{1,160}$/ |
|
schemeName |
(Да) |
Наименование идентификационной схемы финансового учреждения |
|
|
|
identification |
(Да) |
string |
Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения |
/^[\w\W]{1,35}$/ |
BranchAndFinancialInstitutionInformation_CorrespondentAccount|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
Наименование схемы идентификации счета |
|
|
|
identification |
(Да) |
string |
Идентификатор счета соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) |
/^[\w\W]{1,256}$/ |
CardIndividualTransaction2|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
transactionCategory |
(Нет) |
string |
Код категории соответствует ISO 18245 и относится к типу услуг или товаров, которые продавец предоставляет для транзакции |
/^[\w\W]{1,4}$/ |
|
sequenceNumber |
(Нет) |
string |
Порядковый номер транзакции по карте, назначенный POI (точка взаимодействия) |
/^[\w\W]{1,35}$/ |
|
TransactionIdentification |
(Нет) |
Идентификатор операции, назначенной POI (точка взаимодействия) |
|
|
|
Product |
(Нет) |
Товар, заказанный по операции |
|
|
|
authorizationCode |
(Нет) |
string |
Код авторизации операции |
/^[\w\W]{3,35}$/ |
CardSecurityInformation1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
CSCManagement |
(Да) |
|
|
|
|
CSCValue |
(Нет) |
string |
Код безопасности карты |
/^[0-9]{3,4}$/ |
CardTransaction18|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Card |
(Нет) |
|
|
|
|
POI |
(Нет) |
Физический или логический карточный платежный терминал, состоящий из программного обеспечения и аппаратной части |
|
|
|
Transaction |
(Нет) |
Сведения об отдельной операции по карте, записанные на POI-терминале (точке взаимодействия) |
|
CashAccount|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Нет) |
string |
Наименование счета, присвоенное учреждением, обслуживающим счет, по согласованию с владельцем счета для обеспечения дополнительных средств идентификации счета |
/^[\w\W]{1,70}$/ |
|
schemeName |
(Да) |
Наименование схемы идентификации счета |
|
|
|
identification |
(Да) |
string |
Идентификатор счета, соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) |
/^[\w\W]{1,256}$/ |
CashBalance|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
creditDebitIndicator |
(Да) |
Определяет является остаток кредитовым или дебетовым |
|
|
|
type |
(Да) |
Тип остатка |
|
|
|
Amount |
(Да) |
Сумма остатка |
|
CreditorReferenceInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
type |
(Нет) |
string |
Тип идентификатора платежа (Номер реквизита 15.6.n) Возможные значения реквизита: -УИП2: Уникальный идентификатор платежа, присвоенный получателем средств или идентификатор государственного контракта. -УИН: Уникальный идентификатор начисления. -ИПД: Идентификатор платежного документа. -ЕЛС: Единый лицевой счет. -ЖКУ: Идентификатор жилищно-коммунальных услуг. -ДОГН: Номер договора, товарного документа, иного документа, являющегося основанием платежа. -ДОКД: Дата договора, товарного документа, иного документа, являющегося основанием платежа. -Период оплаты платежа. -Иное, по договоренности участников обмена. |
/^[\w\W]{1,35}$/ |
|
reference |
(Нет) |
string |
Значение идентификатора платежа (Номер реквизита 15.7.n). Ссылка, присвоенная получателем денежных средств, которая является основанием для осуществления перевода |
/^[\w\W]{1,35}$/ |
CurrencyExchange|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
sourceCurrency |
(Да) |
string |
Валюта, из которой необходимо конвертировать сумму |
/^[A-Z]{3,3}$/ |
|
targetCurrency |
(Нет) |
string |
Валюта, в которую необходимо конвертировать сумму |
/^[A-Z]{3,3}$/ |
|
unitCurrency |
(Нет) |
string |
Валюта, в которой обменный курс выражен |
/^[A-Z]{3,3}$/ |
|
exchangeRate |
(Да) |
string |
Коэффициент, используемый для перевода суммы из одной валюты в другую. Это отражает цену, по которой одна валюта была куплена за другую валюту |
/^[\w\W]{1,12}$/ |
|
contractIdentification |
(Нет) |
string |
Идентификатор для однозначного определения валютного контракта |
/^[\w\W]{1,35}$/ |
|
quotationDate |
(Нет) |
string; format: date-time |
Дата и время обменного курса |
|
DataBalanceResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Balance |
(Нет) |
|
|
DataStatementInitRequest|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Statement |
(Да) |
Объект запроса на создание ресурса выписки |
|
DataStatementInitResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Statement |
(Да) |
Ресурс выписки |
|
GenericIdentification32|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
identification |
(Да) |
string |
Идентификатор субъекта |
/^[\w\W]{1,35}$/ |
|
type |
(Нет) |
|
|
IdentificationType|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
Наименование идентификационной схемы юридического или физического лица |
|
|
|
identification |
(Да) |
string |
Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. |
/^[\w\W]{1,35}$/ |
Links|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
self |
(Да) |
string; format: uri |
Текущая ссылка |
|
|
first |
(Нет) |
string; format: uri |
Первая ссылка |
|
|
prev |
(Нет) |
string; format: uri |
Предыдущая ссылка |
|
|
next |
(Нет) |
string; format: uri |
Следующая ссылка |
|
|
last |
(Нет) |
string; format: uri |
Последняя ссылка |
|
Meta|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
totalPages |
(Нет) |
integer; format: int32 |
Указывает на количество передаваемых страниц |
|
NumberAndSumOfTransactions|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
numberOfEntries |
(Нет) |
string |
Колличество записей |
/^\d{1,15}$/ |
|
sum |
(Да) |
string |
Общая сумма всех записей |
/^\d{1,15}.\d{2,4}$/ |
|
currency |
(Да) |
string |
Код валюты, соответствующий международному стандарту ISO 4217 |
/^[A-Z]{3,3}$/ |
OBRUCreditLine|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
included |
(Да) |
boolean |
Показывает включена или нет кредитная линия в расчет остатка |
|
|
Amount |
(Да) |
Значение лимита внутридневного кредитования (ВДК) |
|
OBRUError|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
errorCode |
(Да) |
Низкоуровневое описание ошибки |
|
|
|
message |
(Да) |
string |
Описание ошибки |
/^[\w\W]{1,500}$/ |
|
path |
(Нет) |
string |
Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, но не обязательное поле |
/^[\w\W]{1,500}$/ |
|
url |
(Нет) |
string; format: uri |
URL для помощи в устранении проблемы, Также через URL можно предоставлять дополнительную информацию |
|
OBRUErrorResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
code |
(Да) |
string |
Высокоуровневый текстовый код ошибки, необходимый для классификации |
/^[a-zA-Z0-9-]{1,40}$/ |
|
id |
(Нет) |
string |
Уникальный идентификатор ошибки, для целей аудита, в случае неизвестных / не классифицированных ошибок |
/^[a-zA-Z0-9-]{1,40}$/ |
|
message |
(Да) |
string |
Краткое сообщение об ошибке. Например, «что-то не так с предоставленными параметрами запроса» |
/^[\w\W]{1,500}$/ |
|
Errors |
(Да) |
|
|
OrganizationIdentificationType|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
schemeName |
(Да) |
|
|
|
|
identification |
(Да) |
string |
Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. |
/^[\w\W]{1,35}$/ |
PartyChoice|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Agent |
(Нет) |
Информация об участнике, используемая для идентификации финансовой организации |
|
|
|
Party |
(Нет) |
Информация об участнике, используемая для идентификации юридического или физического лица |
|
PartyIdentification|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
name |
(Да) |
string |
Наименование организации или Ф.И.О. |
/^[\w\W]{1,160}$/ |
|
mobileNumber |
(Нет) |
string |
Номер мобильного телефона |
/^\d{11,15}$/ |
|
countryOfResidence |
(Нет) |
string |
Страна проживания |
/^[A-Z]{2,2}$/ |
|
countryOfBirth |
(Нет) |
string |
Место рождения (страна) |
/^[A-Z]{2,2}$/ |
|
provinceOfBirth |
(Нет) |
string |
Место рождения (область). |
/^[\w\W]{1,35}$/ |
|
cityOfBirth |
(Нет) |
string |
Место рождения (город) |
/^[\w\W]{1,35}$/ |
|
birthDate |
(Нет) |
string; format: date-time |
Дата рождения |
|
|
Identification |
(Да) |
Идентификация юридического или физического лица. |
|
|
|
PostalAddress |
(Нет) |
|
|
PaymentCard4|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
PlainCardData |
(Нет) |
Конфиденциальные данные, связанные с выполнением операции по карте |
|
|
|
cardCountryCode |
(Нет) |
string |
Код страны, присвоенный карте эмитентом карты |
/^[0-9]{3}$/ |
|
CardBrand |
(Нет) |
Брендовое наименование карты |
|
|
|
additionalCardData |
(Нет) |
string |
Дополнительные сведения, специфичные для эмитента карты |
/^[\w\W]{1,70}$/ |
PaymentTypeInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
localInstrument |
(Нет) |
(Номер реквизита 5) Вид платежного распоряжения. |
|
|
|
categoryPurpose |
(Нет) |
(Номер реквизита 15.3) Очередность платежа. Применение: Поле может принимать значение в диапазоне 0-5. Значение поля должно быть равно 0, если в соответствии с нормативными актами Банка России очередность платежа не применяется |
[0, 1, 2, 3, 4, 5] |
|
|
serviceLevel |
(Нет) |
(Номер реквизита 15.1) Вид платежа |
|
PlainCardData1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
PAN |
(Да) |
string |
Основной учетный номер карты (PAN) или номер карты |
/^[*0-9]{4,28}$/ |
|
cardSequenceNumber |
(Нет) |
string |
Идентификатор карты среди множества карт с одинаковым номером карты (PAN) |
/^[0-9]{2,3}$/ |
|
effectiveDate |
(Нет) |
string |
Дата, начиная с которой карту можно использовать |
/^(1[0-2]|0[1-9]|\d)\/([2-9]\d[1-9]\d|[1-9]\d)$/ |
|
expiryDate |
(Да) |
string |
Дата окончания срока действия карты |
/^(1[0-2]|0[1-9]|\d)\/([2-9]\d[1-9]\d|[1-9]\d)$/ |
|
serviceCode |
(Нет) |
string |
Услуги по карте в соответствии с ISO 7813 |
/^[0-9]{3}$/ |
|
TrackData |
(Нет) |
Данные магнитной дорожки платежной карты или их эквивалент |
|
|
|
CardSecurityCode |
(Нет) |
Код безопасности карты (CSC), связанный с выполнением операции по карте |
|
PointOfInteraction1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Identification |
(Да) |
Уникальный и однозначный идентификатор (карты/POI-терминала), присвоенный идентифицирующей организацией |
|
|
|
systemName |
(Нет) |
string |
Общее название, присвоенное эквайером POI-системе |
/^[\w\W]{1,70}$/ |
|
groupIdentification |
(Нет) |
string |
Идентификатор, присвоенный торгово-сервисной организацией, идентифицирующий множество POI-терминалов, выполняющих некоторые категории операций |
/^[\w\W]{1,35}$/ |
|
Component |
(Нет) |
Данные, относящиеся к компоненту POI, выполняющему операцию |
|
PointOfInteractionComponent1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
POIComponentType |
(Да) |
|
|
|
|
manufacturerIdentification |
(Нет) |
string |
Идентификатор поставщика программного обеспечения, аппаратной части или системы компонента POI-терминала |
/^[\w\W]{1,35}$/ |
|
model |
(Нет) |
string |
Идентификатор модели компонента POI-терминала для определенного производителя |
/^[\w\W]{1,35}$/ |
|
versionNumber |
(Нет) |
string |
Версия компонента, являющегося частью определенной модели |
/^[\w\W]{1,16}$/ |
|
serialNumber |
(Нет) |
string |
Серийный номер компонента |
/^[\w\W]{1,35}$/ |
|
approvalNumber |
(Нет) |
string |
Уникальный регистрационный номер компонента, предоставленный органом сертификации |
/^[\w\W]{1,70}$/ |
PostalAddress|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
addressType |
(Нет) |
Тип адреса |
|
|
|
addressLine |
(Нет) |
string |
Строка адреса |
/^[\w\W]{1,140}$/ |
|
streetName |
(Нет) |
string |
Наименование улицы или проспекта |
/^[\w\W]{1,70}$/ |
|
buildingNumber |
(Нет) |
string |
Номер, который определяет положение здания на улице |
/^[\w\W]{1,16}$/ |
|
postCode |
(Нет) |
string |
Почтовый индекс |
/^[\w\W]{6,16}$/ |
|
townName |
(Нет) |
string |
Наименование населённого пункта или территории, находящейся вне границ поселений |
/^[\w\W]{1,35}$/ |
|
countrySubDivision |
(Нет) |
string |
Наименование и тип субъекта Российской Федерации |
/^[\w\W]{1,35}$/ |
|
country |
(Нет) |
string |
Название страны в кодированной форме |
/^[A-Z]{2,2}$/ |
Product2|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
productCode |
(Да) |
string |
Код продукта |
/^[\w\W]{1,70}$/ |
|
unitOfMeasure |
(Нет) |
|
|
|
|
productQuantity |
(Нет) |
string |
Количество товара |
/^[0-9]{1,18}$|^[0-9]{1,18}[.][0-9]{1,18}$/ |
|
unitPrice |
(Нет) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
productAmount |
(Нет) |
string |
Сумма денежных средств |
/^\d{1,15}.\d{2,4}$/ |
|
taxType |
(Нет) |
string |
Код причины постановки на учет (КПП) |
/^\d{9}$/ |
|
additionalProductInformation |
(Нет) |
string |
Дополнительная информация о товаре |
/^[\w\W]{1,35}$/ |
ReferredDocumentInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
type |
(Нет) |
string |
Тип связанного документа. Для указания Даты составления распоряжения (реквизит 4) в relatedDate в данном поле указывается значение "POD" (Payment Order Date). Допустимо использовать иные коды по договоренности участников обмена. |
/^[\w\W]{1,35}$/ |
|
number |
(Нет) |
string |
Номер связанного документа |
/^[\w\W]{1,35}$/ |
|
relatedDate |
(Нет) |
string; format: date |
Дата связанного документа |
|
RemittanceInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
unstructured |
(Да) |
string |
Текстовое назначение платежа |
/^[\w\W]{1,210}$/ |
|
ReferredDocumentInformation |
(Нет) |
Информация о связанном документе. В первом повторении секции ReferredDocumentInformation указывается Дата составления распоряжения. По договоренности участников обмена могут быть указаны иные коды связанных документов в последующих повторениях секции ReferredDocumentInformation. |
|
|
|
CreditorReferenceInformation |
(Нет) |
Информация от получателя денежных средств |
|
|
|
TaxRemittance |
(Нет) |
Информация о платеже, которая связана с оплатой налогов |
|
ReportEntry|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
transactionIdentification |
(Нет) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации операции по счету |
/^[a-zA-Z0-9-]{1,40}$/ |
|
instructionIdentification |
(Нет) |
string |
Уникальный идентификатор, присвоенный инструктирующей стороной для инструктируемой стороны для однозначного определения инструкции |
/^[\w\W]{1,35}$/ |
|
endtoendIdentification |
(Нет) |
string |
Уникальный идентификатор, присвоенный инструктирующей стороной для инструктируемой стороны для однозначного определения инструкции |
/^[\w\W]{1,40}$/ |
|
uetr |
(Нет) |
string |
Указывается идентификатор, присваиваемый при передаче распоряжения с использованием системы SWIFT, в соответствии со стандартом RFC 4122 (IETF) |
/[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}/ |
|
purpose |
(Нет) |
(Номер реквизита 15.5 Код вида дохода) Причина, по которой осуществляется платеж. |
|
|
|
creditDebitIndicator |
(Да) |
Определяет является ли операция дебетовая или кредитовая |
|
|
|
status |
(Да) |
Статус операции по счету |
|
|
|
bookingDateTime |
(Да) |
string; format: date-time |
Дата и время, когда запись об операции по счету публикуется на счете в бухгалтерской книге обслуживающей организации. Используется стандарт ISO8601 |
|
|
valueDateTime |
(Нет) |
string; format: date-time |
Дата и время, когда активы становятся доступными владельцу счета в случае ввода кредита или перестают быть доступными владельцу счета в случае ввода дебетовой операции по счету |
|
|
Amount |
(Да) |
Информация о сумме и валюте операции по счету для данной записи (Примечание - TransactionAmount,ChargeAmount,InstructedAmount - это детали данного реквизита) |
|
|
|
TransactionAmount |
(Нет) |
Сумма в валюте исходной операции по счету |
|
|
|
ChargeAmount |
(Нет) |
Комиссия за операции по счету |
|
|
|
InstructedAmount |
(Нет) |
Сумма денег и информации об обменом курсе, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной в случае, если указанная сумма и/или валюта отличаются от суммы и/или валюты операции по счету |
|
|
|
BankTransactionCode |
(Нет) |
Подробная информация для полной идентификации собственного банковского кода операции по счету |
|
|
|
PaymentTypeInformation |
(Нет) |
Информация о типе платежа |
|
|
|
UltimateDebtor |
(Нет) |
Фактический плательщик |
|
|
|
Debtor |
(Нет) |
Плательщик |
|
|
|
DebtorAgent |
(Нет) |
Финансовое организация, обслуживающая счет плательщика |
|
|
|
DebtorAgentAccount |
(Нет) |
Однозначная идентификация счета плательщика у обслуживающего его банка в платежной цепочке |
|
|
|
DebtorAccount |
(Нет) |
Уникальная идентификация счета плательщика, на котором будет сделана дебетовая запись в результате операции |
|
|
|
IntermediaryAgent |
(Нет) |
Банк-посредник, находящийся между банком плательщика и банком получателя денежных средств |
|
|
|
IntermediaryAgentAccount |
(Нет) |
Счет банка-посредника |
|
|
|
CreditorAgent |
(Нет) |
Финансовое организация, обслуживающая счет получателя денежных средств |
|
|
|
CreditorAccount |
(Нет) |
Идентификатор счета получателя средств, на котором будет проведена запись о кредите в результате операции |
|
|
|
CreditorAgentAccount |
(Нет) |
Однозначная идентификация счета банка получателя денежных средств у обслуживающего его банка, по которому будет выполнена кредитовая запись в результате платежной операции |
|
|
|
Creditor |
(Нет) |
Получатель денежных средств |
|
|
|
UltimateCreditor |
(Нет) |
Фактический получатель денежных средств |
|
|
|
CardTransaction |
(Нет) |
Предоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте |
|
|
|
RemittanceInformation |
(Нет) |
Предоставляемая информация, позволяющая сопоставить запись с позициями, для которых предназначен перевод, такими как коммерческие счета в системе дебиторской задолженности |
|
Statement|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
statementId |
(Да) |
string |
Идентификатор ресурса выписки |
/^[a-zA-Z0-9-]{1,40}$/ |
|
accountId |
(Да) |
string |
Уникальный и неизменный идентификатор, используемый для идентификации ресурса accounts |
/^[a-zA-Z0-9-]{1,40}$/ |
|
fromBookingDateTime |
(Да) |
string; format: date-time |
Дата и время начала выписки |
|
|
toBookingDateTime |
(Да) |
string; format: date-time |
Дата и время окончания выписки |
|
|
creationDateTime |
(Да) |
string; format: date-time |
Дата и время создания ресурса |
|
|
Balance |
(Нет) |
Информация об остатках по счету (например, в массиве можно указать значения на начало и конец операционного дня) |
|
|
|
TransactionsSummary |
(Нет) |
Обороты по кредиту и дебету |
|
|
|
Entry |
(Нет) |
Список операций |
|
StatementAccountIdResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Раздел данных полезной нагрузки ответа |
|
|
|
Links |
(Нет) |
Раздел для указания ссылок |
|
|
|
Meta |
(Нет) |
Раздел метаданных |
|
StatementInitRequest|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
|
|
StatementInitResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Раздел данных полезной нагрузки ответа |
|
|
|
Links |
(Нет) |
Раздел для указания ссылок |
|
|
|
Meta |
(Нет) |
Раздел метаданных |
|
StatementInitResponseType|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
statementId |
(Да) |
string |
Идентификатор ресурса выписки |
/^[a-zA-Z0-9-]{1,40}$/ |
|
accountId |
(Нет) |
string |
Идентификатор ресурса счета |
/^[a-zA-Z0-9-]{1,40}$/ |
|
fromBookingDateTime |
(Да) |
string; format: date-time |
Дата и время начала выписки |
|
|
toBookingDateTime |
(Да) |
string; format: date-time |
Дата и время окончания выписки |
|
StatementInitType|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
accountId |
(Да) |
string |
Идентификатор ресурса счета |
/^[a-zA-Z0-9-]{1,40}$/ |
|
fromBookingDateTime |
(Да) |
string; format: date-time |
Дата и время начала расчетов, представленных в выписке |
|
|
toBookingDateTime |
(Да) |
string; format: date-time |
Дата и время окончания расчетов, представленных в выписке |
|
StatementStatementIdResponse|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
Data |
(Да) |
Раздел данных полезной нагрузки ответа |
|
|
|
Links |
(Нет) |
Раздел для указания ссылок |
|
|
|
Meta |
(Нет) |
Раздел метаданных |
|
TaxAmount|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
rate |
(Нет) |
string |
Ставка НДС (Номер реквизита 14.3) |
/^\d{1,2}$/ |
|
totalAmount |
(Нет) |
string |
Сумма НДС (Номер реквизита 14.4) |
/^\d{1,15}.\d{2,4}$/ |
TaxInformation|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
administrationZone |
(Нет) |
string |
Реквизит 105. Код по Общероссийскому классификатору территорий муниципальных образований ОКТМО |
/^\d{1,11}$/ |
|
referenceNumber |
(Нет) |
string |
Реквизит 108. Номер налогового документа |
/^[\w\W]{1,140}$/ |
|
date |
(Нет) |
string; format: date-time |
Реквизит 109. Дата налогового документа |
|
|
creditor |
(Нет) |
Налоговая информация о получателе средств |
|
|
|
debtor |
(Нет) |
Налоговая информация о плательщике |
|
|
|
Record |
(Нет) |
Дополнительные налоговые реквизиты |
|
TaxParty|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
taxType |
(Нет) |
string |
Код причины постановки на учет (КПП) |
/^\d{9}$/ |
|
registrationIdentification |
(Нет) |
string |
Реквизит 107. Код таможенного органа (Поле заполняется для распоряжений по уплате таможенных платежей) |
/^[\w\W]{1,35}$/ |
TaxPeriod|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
year |
(Нет) |
string |
Год, к которому относится налог |
/^([1-9][0-9]{3}|0[0-9]{3})-01-01$/ |
|
type |
(Нет) |
Тип налогового периода (реквизит 107) |
|
|
|
fromDate |
(Нет) |
string; format: date-time |
Дата уплаты налогового платежа |
|
|
toDate |
(Нет) |
string; format: date-time |
Дата уплаты налогового платежа |
|
TaxRecord|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
type |
(Нет) |
string |
Реквизит 110. Код выплат |
/^[\w\W]{1,35}$/ |
|
category |
(Нет) |
string |
Реквизит 106. Основание налогового платежа |
/^[\w\W]{1,35}$/ |
|
categoryDetails |
(Нет) |
string |
Код бюджетной классификации |
/^[\w\W]{1,35}$/ |
|
debtorStatus |
(Нет) |
string |
Статус налогоплательщика |
/^[\w\W]{1,35}$/ |
|
Period |
(Нет) |
(Номер реквизита 14.2) Налоговый период |
|
|
|
TaxAmount |
(Нет) |
Информация о НДС |
|
TrackData1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
trackNumber |
(Нет) |
string |
Номер дорожки карты |
/^[0-9]$/ |
|
trackValue |
(Да) |
string |
Содержание дорожки карты или его эквивалент |
/^[\w\W]{1,140}$/ |
TransactionIdentifier1|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
transactionDateTime |
(Да) |
string; format: date-time |
Дата и время основной операции (присвоенные POI-терминалом (точкой взаимодействия) |
|
|
transactionReference |
(Да) |
string |
Идентификатор операции, который должен быть уникальным в течение периода времени |
/^[\w\W]{1,35}$/ |
TransactionsSummary|
Наименование |
Обязательность |
Тип |
Описание |
Шаблон/Список |
|---|---|---|---|---|
|
TotalCreditEntries |
(Нет) |
Обороты по кредиту |
|
|
|
TotalDebitEntries |
(Нет) |
Обороты по дебету |
|
В рамках текущей спецификации определены статические типы данных в виде кодов, и динамические типы данных, представляющие собой расширяемый список значений. В случае необходимости ПУ может расширить список значений динамических данных, опубликовав информацию на портале разработчиков. Значения динамических типов данных располагаются в соответствующих пространствах имен, для идентификации источника, использующего расширение. Стандартные динамические значения представлены в данном стандарте и с префиксом RU.CBR. При добавлении собственных значений в справочники участники помещают такие значения в пространство имен, состоящее из двухбуквенного кода страны (код ISO 3166-1 Alpha-2), наименование организации в виде кода и значения справочного кода, разделенных между собой точкой, например:
AccountIdentificationCodeСхема идентификации банковского счета
|
Значение |
Описание |
|---|---|
RU.CBR.BBAN |
Базовый номер банковского счета (RUCBRAccountIdentifier) |
RU.CBR.EPID |
Идентификатор электронного средства платежа |
RU.CBR.PAN |
Идентификатор счета по номеру карты |
RU.CBR.MTEL |
Идентификатор счета по номеру телефона |
RU.CBR.ORID |
Иной идентификатор (номер, однозначно идентифицирующий счет стороны) |
AccountStatusСтатус банковского счета
|
Значение |
Описание |
|---|---|
Enabled |
Cчет доступен и может использоваться |
Disabled |
Cчет не доступен и не может использоваться, временно или навсегда |
Deleted |
Счет удален и не может использоваться |
AccountTypeТип банковского счета
|
Значение |
Описание |
|---|---|
Business |
Cчет юридического лица |
Personal |
Cчет юридического лица |
AddressTypeCodeТип адреса
|
Значение |
Описание |
|---|---|
Business |
Адрес, указанный в едином государственном реестре юридических лиц |
Correspondence |
Адрес для корреспонденции |
DeliveryTo |
Адрес доставки |
MailTo |
Почтовый ящик |
POBox |
Абонентский ящик |
Postal |
Фактический/почтовый адрес местонахождения юридического лица |
Residential |
Адрес постоянной регистрации физического лица (прописка) |
Statement |
Адрес временной регистрации физического лица (регистрация временного пребывания) |
BalanceTypeТип остатка
|
Значение |
Описание |
|---|---|
ClosingAvailable |
Конечный остаток суммы денег, которая находится в распоряжении владельца счета на указанную дату |
ClosingBooked |
Остаток по счету на конец предварительно согласованного отчетного периода. Это сумма начального зарегистрированного баланса в начале периода и всех записей, зачисленных на счет в течение предварительно согласованного отчетного периода |
ClosingCleared |
Конечный остаток суммы денег, которая очищается в указанную дату |
Expected |
Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса |
OpeningAvailable |
Начальный баланс суммы денег, которая находится в распоряжении владельца счета на указанную дату |
OpeningBooked |
Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета |
OpeningCleared |
Начальный баланс, который очищается в указанную дату |
PreviouslyClosedBooked |
Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу |
InterimAvailable |
Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса. |
CSCManagement1CodeУправление кодом безопасности карты (CSC) в связи с операцией
|
Значение |
Описание |
|---|---|
CSCPresent |
CSC (Card Security Code) присутствует и передан для операции |
CSCByPass |
Обход CSC для транзакции |
CSCUnread |
CSC нечитабельный (не может быть прочитан с карты) |
NoCSC |
CSC отсутствует |
CreditDebitCodeПризнак дебета/кредита
|
Значение |
Описание |
|---|---|
Credit |
Операция зачисления или положительный остаток на счете |
Debit |
Операция списания или отрицательный остаток на счете |
FinancialInstitutionIdentificationCodeСхема идентификации финансового учреждения
|
Значение |
Описание |
|---|---|
RU.CBR.BICFI |
BIC для финансовых учреждений согласно ISO 9362 |
RU.CBR.BIC |
Уникальный идентификатор банка, используемый в платежных документах на территории Российской Федерации |
LocalInstrumentCodeOBRUErrorResponseErrorCodeНизкоуровневое описание ошибки. ПУ должен заполнить сообщение детальным описанием ошибки, не раскрывая конфиденциальную информацию.
|
Код ошибки |
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 |
Данный код ошибки можно использовать при возникновении непредвиденной ошибки. |
OrganizationIdentificationCodeСхема идентификации юридического или физического лица
|
Значение |
Описание |
|---|---|
RU.CBR.TXID |
Используется в случае идентификационной схемы ИНН/КИО |
RU.CBR.LEI |
Код организации в соответствии с ISO 17442 |
RU.CBR.TAXT |
КПП |
RU.CBR.OGRN |
ОГРН |
RU.CBR.OKPO |
ОКПО |
POIComponentType1CodeУправление кодом безопасности карты (CSC) в связи с операцией
|
Значение |
Описание |
|---|---|
CSCPresent |
CSC (Card Security Code) присутствует и передан для операции |
CSCByPass |
Обход CSC для транзакции |
CSCUnread |
CSC нечитабельный (не может быть прочитан с карты) |
NoCSC |
CSC отсутствует |
PartyIdentificationCodeСхема идентификации юридического или физического лица
|
Значение |
Описание |
|---|---|
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 |
Идентификатор банковского счета |
PartyType3CodeТип субъекта в виде кода
|
Значение |
Описание |
|---|---|
OPOI |
Участник системы операций по платежам |
MERC |
Продавец или получатель платежа |
ACCP |
Принимающий платежи участник |
ITAG |
Эмитент тегов или идентификаторов |
ACQR |
Банк-эквайер для карточных операций |
CISS |
Центральная информационная служба системы |
DLIS |
Поставщик или агент по доставке |
PurposeCodeКод вида дохода - причина, по которой осуществляется платеж.
ServiceLevelCodeВид платежа:
TaxRecordPeriodCodeТип налогового периода (реквизит 107)
|
Значение |
Описание |
|---|---|
MM01 |
Январь |
MM02 |
Февраль |
MM03 |
Март |
MM04 |
Апрель |
MM05 |
Май |
MM06 |
Июнь |
MM07 |
Июль |
MM08 |
Август |
MM09 |
Сентябрь |
MM10 |
Октябрь |
MM11 |
Ноябрь |
MM12 |
Декабрь |
QTR1 |
Первый квартал |
QTR2 |
Второй квартал |
QTR3 |
Третий квартал |
QTR4 |
Четвертый квартал |
HLF1 |
Первое полугодие |
HLF2 |
Второе полугодие |
TransactionStatusCodeСтатус записи операции по счету
|
Значение |
Описание |
|---|---|
AcceptedCreditSettlementCompleted |
Расчет по счету Получателя средств завершен |
AcceptedSettlementCompleted |
Расчет по счету Плательщика завершен |
AcceptedSettlementInProcess |
Все предыдущие проверки, такие как техническая проверка и профиль клиента, были успешными, и поэтому запрос об инициировании платежа был принят к исполнению |
AcceptedWithoutPosting |
Платежная инструкция, включенная в перевод, принимается без зачисления на счет Получателя средств |
Pending |
Ожидается инициирование группы платежей или отдельного платежа, включенного в группу платежей |
Rejected |
Инициирование группы платежей или отдельного платежа, включенная в группу инициирования платежей, были отклонены |
UnitOfMeasure1CodeЕдиницы измерения
|
Значение |
Описание |
|---|---|
PIEC |
Штука |
TONS |
Тонна |
FOOT |
Фут |
GBGA |
Британский галлон |
USGA |
Американский галлон |
GRAM |
Грамм |
INCH |
Дюйм |
KILO |
Килограмм |
PUND |
Фунт |
METR |
Метр |
CMET |
Сантиметр |
MMET |
Миллиметр |
LITR |
Литр |
CELI |
Сантилитр |
MILI |
Миллилитр |
GBOU |
Британская жидкая унция |
USOU |
Американская жидкая унция |
SQFO |
Квадратный фут |
SQME |
Квадратный метр |
CMMT |
Кубический сантиметр |
CBMT |
Кубический метр |
Для получения остатка на счете СПУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_le) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsВ случае необходимости предоставления детальной информации о счете, согласие должно иметь разрешение ReadAccountsDetail.
Вызов GET /accounts является первым шагом после авторизации запроса на доступ к счету. Это позволит ПУ обнаружить, какие счета связаны с авторизацией согласия. Разрешение ReadAccountsDetail было предоставлено.
GET /accounts HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Account": [
{
"accountId": "200200",
"status": "Enabled",
"statusUpdateDateTime": "2023-09-12T08:30:00+00:00",
"currency": "RUB",
"accountType": "Personal",
"accountDescription": "Основной счет",
"AccountDetails": [
{
"name": "Расчетный счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570001"
}
],
"Owner": {
"name": "ООО Организация",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240000"
},
{
"schemeName": "RU.CBR.OGRN",
"identification": "1027700130000"
}
],
"PostalAddress": {
"addressType": "Postal",
"addressLine": "ул. Садовая, 11",
"postCode": "123456",
"townName": "Москва",
"country": "RU"
}
},
"Servicer": {
"name": "МойБанк1",
"BankIdentification": [
{
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
}
],
"OrganizationIdentification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"CorrespondentAccount": {
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"PostalAddress": {
"addressLine": "Адрес отделения в виде строки"
}
}
},
{
"accountId": "200201",
"status": "Enabled",
"statusUpdateDateTime": "2023-09-12T08:30:00+00:00",
"currency": "RUB",
"accountType": "Personal",
"accountDescription": "Дополнительный счет",
"AccountDetails": [
{
"name": "Сберегательный счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570002"
}
],
"Owner": {
"name": "ООО Организация",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240000"
},
{
"schemeName": "RU.CBR.OGRN",
"identification": "1027700130000"
}
],
"PostalAddress": {
"addressLine": "ул. Садовая, 11, Москва, 123456, RU"
}
},
"Servicer": {
"name": "МойБанк1",
"BankIdentification": [
{
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
}
],
"OrganizationIdentification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"CorrespondentAccount": {
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"PostalAddress": {
"addressLine": "Адрес отделения в виде строки"
}
}
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-le/accounts"
},
"Meta": {
"totalPages": 1
}
}
Разрешение ReadAccountsDetail было предоставлено.
GET /accounts/200200 HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Account": [
{
"accountId": "200200",
"status": "Enabled",
"statusUpdateDateTime": "2021-06-05T15:15:13+00:00",
"currency": "RUB",
"accountType": "Personal",
"accountDescription": "Основной счет",
"AccountDetails": [
{
"name": "Расчетный счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
}
],
"Owner": {
"name": "ООО Организация",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240000"
},
{
"schemeName": "RU.CBR.OGRN",
"identification": "1027700130000"
}
],
"PostalAddress": {
"addressType": "Postal",
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
}
},
"Servicer": {
"name": "МойБанк1",
"BankIdentification": [
{
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
}
],
"OrganizationIdentification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"CorrespondentAccount": {
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"PostalAddress": {
"addressLine": "Адрес отделения в виде строки"
}
}
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200"
},
"Meta": {
"totalPages": 1
}
}
Разрешение ReadAccountsDetail не было предоставлено.
GET /accounts/200200 HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Account": [
{
"accountId": "200200",
"status": "Enabled",
"statusUpdateDateTime": "2021-06-05T15:15:13+00:00",
"currency": "RUB",
"accountType": "Personal",
"accountDescription": "Основной счет"
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-le/accounts/200200"
},
"Meta": {
"totalPages": 1
}
}
При получении информации о балансе необходимо учитывать следующие условия наличия элемента CreditLine и значение его свойства included:
CreditLine означает, что Пользователю предоставлена кредитная линия или овердрафт.included равно false, то это означает, что данная сумма доступна Пользователю для операций (предоставляемый кредитный лимит или овердрафт), не была использована и не отражается на остатке по счету (Balance/Amount).included равно true, то это означает, что данная сумма была использована Пользователем и это уже отражено на остатке по счету.При предоставлении информации Пользователю, следует указывать, является ли сумма доступных средств на счете остатком собственных средств, либо учитывает наличие кредитной линии.
creditDebitIndicatorВ сообщениях об остатке на счете параметр creditDebitIndicator указывает, является ли сумма дебетовой или кредитовой по отношению к счету. Если остаток на счете положительный, то он считается кредитовым, и в этом случае значение параметра creditDebitIndicator должно быть Credit.
Таким образом следует указывать:
Credit — если остаток положительный (кредитовый);Debit — если остаток отрицательный (дебетовый).Для получения остатка на счете СПУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_le) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsReadBalancesДанный пример показывает положительный остаток на счете 200200 в 800 рублей и 200201 в 100 рублей, которые доступны Пользователю для совершения операций. При этом на обоих счетах отсутствует кредитная линия или овердрафт.
GET /balances HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"accountId": "c",
"type": "interimAvailable",
"Amount": {
"amount": "800.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00"
},
{
"accountId": "200201",
"type": "interimAvailable",
"Amount": {
"amount": "100.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00"
}
]
},
"Links": {
"self": "https://sb.example.ru/v2.0/aisp-le/balances"
},
"Meta": {
"totalPages": 1
}
}
Данный пример показывает положительный остаток на счете в 800 рублей, которые доступны Пользователю для совершения операций. При этом на счете отсутствует кредитная линия или овердрафт.
GET /accounts/200200/balances HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"accountId": "200200",
"type": "interimAvailable",
"Amount": {
"amount": "800.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00"
}
]
},
"Links": {
"self": "https://sb.example.ru/v2.0/aisp-le/accounts/200200/balances"
},
"Meta": {
"totalPages": 1
}
}
Данный пример показывает положительный остаток на счете 800 рублей, но при этом ему предоставлена кредитная линия в 500 рублей, которую он не использовал. При этом пользователю доступно 1300 рублей для совершения операций.
GET /accounts/200200/balances HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"accountId": "200200",
"type": "interimAvailable",
"Amount": {
"amount": "800.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00",
"CreditLine": [
{
"included": false,
"Amount": {
"amount": "500.00",
"currency": "RUB"
}
}
]
}
]
},
"Links": {
"self": "https://sb.example.ru/v2.0/aisp-le/accounts/200200/balances"
},
"Meta": {
"totalPages": 1
}
}
Данный пример показывает отрицательный остаток на счете в 100 рублей и при этом у него имеется кредитная линия в 500 рублей, часть которой (400 рублей) он использовал и это отражено в остатке на счете. Это означает, что у Пользователя на счете доступно 400 рублей свободных средств при отрицательном остатке собственных средств в 100 рублей.
GET /accounts/200200/balances HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"Balance": [
{
"accountId": "200200",
"type": "interimAvailable",
"Amount": {
"amount": "100.00",
"currency": "RUB"
},
"creditDebitIndicator": "Debit",
"dateTime": "2021-06-05T15:15:13+00:00",
"CreditLine": [
{
"included": true,
"Amount": {
"amount": "400.00",
"currency": "RUB"
}
},
{
"included": false,
"Amount": {
"amount": "500.00",
"currency": "RUB"
}
}
]
}
]
},
"Links": {
"self": "https://sb.example.ru/v2.0/aisp-le/accounts/200200/balances"
},
"Meta": {
"totalPages": 1
}
}
Для получения выписки по счету СПУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_le) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsReadTransactionsBasicМассив разрешений должен также включать одно из следующих значений permission:
ReadTransactionsCreditsReadTransactionsDebitsВ случае необходимости предоставления детальной выписки по счету согласие должно иметь разрешение ReadTransactionsDetail.
Разрешение ReadTransactionsDetail было предоставлено.
GET /accounts/200200/statements HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2021 15:15:01 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"statementId": "this-is-a-slug-format-statement-id",
"accountId": "200200",
"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",
"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": "NURG"
},
"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",
"streetName": "Садовая",
"buildingNumber": "11",
"postCode": "0100010",
"townName": "Бигсити",
"countrySubDivision": "Мой край",
"country": "RU"
}
},
"Debtor": {
"Agent": {
"name": "Наименование организации",
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
}
},
"DebtorAgent": {
"name": "Наименование организации",
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
},
"DebtorAgentAccount": {
"name": "Основной счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"DebtorAccount": {
"name": "Основной счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"IntermediaryAgent": {
"name": "Наименование организации",
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
},
"IntermediaryAgentAccount": {
"name": "Основной счет",
"schemeName": "RU.CBR.BBAN",
"identification": "40817810621234570000"
},
"CreditorAgent": {
"name": "Наименование организации",
"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": "Наименование организации",
"schemeName": "RU.CBR.BIC",
"identification": "9612123"
}
},
"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": "1",
"trackValue": "B1234567890123456^CARDHOLDER/JOHN^2512101000000000000000123000000"
}
],
"CardSecurityCode": {
"CSCManagement": "CSCByPass",
"CSCValue": "123"
}
},
"cardCountryCode": "643",
"CardBrand": {
"identification": "pc001",
"type": "ACCP"
},
"additionalCardData": "Дополнительные сведения"
},
"POI": {
"Identification": {
"identification": "pc001",
"type": "ACCP"
},
"systemName": "POI-sysname",
"groupIdentification": "pi001",
"Component": [
{
"POIComponentType": "CHIT",
"manufacturerIdentification": "manufacturerIdentification",
"model": "model",
"versionNumber": "versionNumber",
"serialNumber": "serialNumber",
"approvalNumber": "approvalNumber"
}
]
},
"Transaction": {
"transactionCategory": "^w$",
"sequenceNumber": "01",
"TransactionIdentification": {
"transactionDateTime": "2021-06-05T15:15:13+00:00",
"transactionReference": "tr-0011"
},
"Product": [
{
"productCode": "code-01-ac",
"unitOfMeasure": "KILO",
"productQuantity": "10.2",
"unitPrice": "200.00",
"productAmount": "200.00",
"taxType": "991230001",
"additionalProductInformation": "Дополнительная информация о товаре"
}
],
"authorizationCode": "123"
}
},
"RemittanceInformation": {
"unstructured": "Назначение платежа - оплата за товары или услуги",
"ReferredDocumentInformation": [
{
"type": "0",
"number": "0",
"relatedDate": "2021-06-05"
}
],
"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/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": {
"totalPages": 1
}
}