ПРИНЯТ И ВВЕДЕН в действие приказом Банка России от __ _____ 202_ года № ___ «О введении в действие стандарта СТО БР XXX xxx Банка России «Открытые программные интерфейсы. Получение информации о банковских счетах клиента. Методы для Физических Лиц. Спецификация API.
Настоящий Стандарт не может быть полностью или частично воспроизведен, тиражирован и распространен в качестве официального издания без разрешения Банка России.
Стандарт содержит описание конечных точек, модели данных и контроля доступа к данным, которые являются общими для всех API, определяющих взаимодействие между Сторонним поставщиком и Поставщиком услуг в процессе получения информации по банковским счетам Физических Лиц.
Стандарт рекомендован к использованию организациями при обмене финансовыми сообщениями, связанными с получением информации о банковском счете. Стандарт предназначен для:
Положения настоящего стандарта применяются на добровольной основе, если только в отношении конкретных положений обязательность их применения не установлена нормативными актами Банка России или условиями договоров. Положения настоящего стандарта применяются совместно со следующими документами:
В Стандарте применяются термины и определения в соответствии со стандартами ФАПИ.СЕК, ФАПИ.ПАОК, «Открытые программные интерфейсы. Общие положения» а также следующие:
Ресурс- Ресурсом является представление любой сущности (например, перевод денежных средств, счет, транзакция) в определенном формате (например JSON). Каждый ресурс идентифицируется посредством постоянного идентификатора, который не меняется при изменении состояния ресурса.Полезная нагрузка Часть пакета данных (сообщения) без служебной информации (без заголовка, битов синхронизации и т. п.).YAML - Формат сериализации данных, концептуально близкий к языкам разметки, но ориентированный на удобство ввода‑вывода типичных структур данных многих языков программирования.ППИУ - Поставщик платежных и информационных и услуг.СПИУ - Сторонний поставщик информационных услуг.Информационный сервис - Сервис предоставления информации о счетах Пользователя в режиме реального времени.Спецификация API определяет поток взаимодействия при получении информации о счете клиента третей стороной через информационный сервис Открытых банковских интерфейсов Среды Открытых банковских интерфейсов, которые позволяют СПИУ:
Сервер ресурсов в рамках данной спецификации должен предоставлять единственный URI, соответствующий следующей структуре:
- participant-path-prefix]/open-banking/[version]/[resource-group]/[resource]/[resource-id]/[sub-resource]
При этом параметр resource-group для данной спецификации должен иметь значение aisp-pe.
Спецификация API определяет следующие конечные точки
| Наименование API | Метод | Обязательность | Описание | Метод авторизации |
|---|---|---|---|---|
| Accounts | get /accounts |
Да | Получение списка счетов | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Accounts | get /accounts/{accountId} |
Да | Получение детальной информации о счете по его идентификатору accountId |
Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Balances | get /accounts/{accountId}/balances |
Да | Баланс банковского счета по идентификатору accountId | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Balances | get /balances |
Да | Остаток денежных средств по всем счетам | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| PaymentCards | get /accounts/{accountId}/payment-cards |
Да | Получение списка платежных карт по идентификатору счета | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| PaymentCards | get /payment-card-balances |
Да | Остаток денежных средств, доступный по всем платежным картам | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| PaymentCards | get /payment-cards |
Да | Получение списка платежных карт | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Products | get /products |
Да | Список приобретенных финансовых продуктов | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Transactions | get /accounts/{accountId}/transactions |
Да | Ресурс операции по счету с идентификатором accountId | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
| Transactions | get /transactions |
Да | Список операций по всем счетам | Client Authorization code flow; scopes: obru_accounts_pe: доступ к информации о счете |
get /accountsПолучение списка счетов (getAccounts )
Конечная точка позволяет СПИУ получать полный список счетов и их идентификаторы (accountId), которые были авторизованы Пользователем на стороне ППИУ
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | AccountResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /accounts/{accountId}Получение детальной информации о счете по его идентификатору accountId (getAccountsAccountId )
Конечная точка позволяет СПИУ получать детальную информацию о счете по идентификатору accountId (который был получен при вызове конечной точке списка счетов GET /accounts)
accountId (required)
Path Parameter — Идентификатор счета default: null
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | AccountResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /accounts/{accountId}/balancesБаланс банковского счета по идентификатору accountId (getAccountsAccountIdBalances )
Конечная точка позволяет СПИУ получать информацию об остатке на счете с идентификатором accountId
accountId (required)
Path Parameter — Идентификатор счета default: null
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | BalanceResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /balancesОстаток денежных средств по всем счетам (getBalances )
Конечная точка позволяет СПИУ получать остаток по всем счетам, которые были авторизованы Пользователем для доступа с помощью согласия
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | BalanceResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /accounts/{accountId}/payment-cardsПолучение списка платежных карт по идентификатору счета (getAccountPaymentCards )
Конечная точка позволяет получать информацию о платежных картах и их идентификаторы paymentCardId по идентификатору счета accountId.
accountId (required)
Path Parameter — Идентификатор счета default: null
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | AccountPaymentCardsResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /payment-card-balancesОстаток денежных средств, доступный по всем платежным картам (getPaymentCardBalances )
Конечная точка позволяет получить информацию об остатке денежных средств, в разрезе платежных карт по всем счетам Пользователя, по которым он дал согласие
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | PaymentCardBalancesResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /payment-cardsПолучение списка платежных карт (getPaymentCards )
Конечная точка позволяет получать информацию о платежных картах и их идентификаторы paymentCardId по всем счетам Пользователя на которые он дал согласие
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | AccountPaymentCardsResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /productsСписок приобретенных финансовых продуктов (getAccountsProductList )
Конечная точка позволяет получить информацию о финансовых продуктах по всем счетам, которые были авторизованы Пользователем для доступа с помощью согласия\
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | AccountsProductListResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /accounts/{accountId}/transactionsРесурс операции по счету с идентификатором accountId (getAccountsAccountIdTransactions )
Конечная точка извлекает ресурс операции по счету с идентификатором accountId
accountId (required)
Path Parameter — Идентификатор счета default: null
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | TransactionResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
get /transactionsСписок операций по всем счетам (getTransactions )
Конечная точка позволяет СПИУ получить список операций по всем счетам, которые авторизованы Пользователем с помощью согласия
| Наименование | Обязательность | Тип | Описание | Паттерн |
|---|---|---|---|---|
| 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):
Значение должно быть указано в параметре заголовка запроса Accept и возвращены в ответе с указанием в параметре заголовка Content-Type
| HTTP код | Тип ответа |
|---|---|
| 200 | TransactionResponse |
| 400 | OBRUErrorResponse |
| 401 | |
| 403 | OBRUErrorResponse |
| 405 | |
| 406 | |
| 429 | |
| 500 | OBRUErrorResponse |
| 501 | OBRUErrorResponse |
| 503 | OBRUErrorResponse |
Спецификация API определяет типы и форматы данных, значения по умолчанию, перечисления и справочную информацию.
AccountСчет
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса | /^[a-zA-Z0-9-]{1,40}$/ |
| status | (Да) | AccountStatus | Статус счета в форме кода | |
| statusUpdateDateTime | (Нет) | string; format: date-time | Дата и время изменения статуса счета | |
| currency | (Да) | string | Валюта ведения счета | /^[A-Z]{3,3}$/ |
| accountType | (Да) | AccountType | Тип счета (физическое или юридическое лицо) | |
| accountDescription | (Да) | string | Краткое описание назначения счета или продукта, привязанного к счету | /^[\w\W]{1,128}$/ |
| AccountDetails | (Нет) | array[CashAccount] | Идентификация счета | |
| Owner | (Нет) | PartyIdentification | Информация о владельце счета | |
| Servicer | (Нет) | BranchAndFinancialInstitutionInformationPE | Информация о кредитной организации, облужиывющий счет клиента |
BalanceОстаток на счете
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса счета | /^[a-zA-Z0-9-]{1,40}$/ |
| type | (Да) | BalanceType | Тип остатка | |
| Amount | (Да) | ActiveOrHistoricCurrencyAndAmount | Сумма остатка | |
| creditDebitIndicator | (Да) | CreditDebitCode | Определяет является остаток кредитовым или дебетовым | |
| dateTime | (Да) | string; format: date-time | Дата, на которую рассчитан остаток | |
| CreditLine | (Нет) | array[OBRUCreditLine] | Кредитная линия |
AccountPaymentCardsDataИнформация о платежной карте, связанной со сетом клиента
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса Счета | /^[a-zA-Z0-9-]{1,40}$/ |
| paymentCardId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации платежной карты | /^[a-zA-Z0-9-]{1,40}$/ |
| paymentCardType | (Да) | paymentCardType | Тип платежной карты | [Debit, Credit] |
| paymentCardName | (Да) | string | Наименование, ассоциированное с платежной картой конечного Пользователя | /^[\w\W]{1,64}$/ |
| PaymentCardData | (Да) | PlainCardData2 | ||
| cardScheme | (Да) | CardSchemeNameCode | ||
| iconUrl | (Нет) | string | URL-адрес для получения информации в виде значка (icon) | /^[\w\W]{1,2048}$/ |
| designUrl | (Нет) | string | URL-адрес для получения информации в виде изображения | /^[\w\W]{1,2048}$/ |
AccountPaymentCardsResponseСписок платежных карт и их идентификаторы
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | AccountPaymentCardsResponse_Data | ||
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
AccountPaymentCardsResponse_DataРаздел данных
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| PaymentCard | (Нет) | array[AccountPaymentCardsData] |
AccountProductListОбщая информация о продукте кредитной организации связанной со счетом Пользователя
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса Счета | /^[a-zA-Z0-9-]{1,40}$/ |
| productId | (Нет) | string | Уникальный идентификатор, присвоенный финансовым учреждением внутри ор каждому из банковских продуктов | /^[a-zA-Z0-9-]{1,40}$/ |
| productName | (Да) | string | Название продукта, используемого в маркетинговых целях | /^[\w\W]{1,64}$/ |
| productType | (Да) | ProductType | Тип продукта | |
| productVersion | (Нет) | string | Версия продукта | /^[1-9]{1,3}.\d{1,3}.[A-Za-z0-9-]{1,16}$/ |
| Brand | (Нет) | Brand |
AccountResponseСписок счетов и их идентификаторы
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | AccountResponse_Data | ||
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
AccountResponse_DataРаздел данных полезной нагрузки ответа на запрос о списке счетов
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Account | (Нет) | array[Account] |
AccountsProductListResponseОтвет на запрос о банковских продуктах по счетам Пользователя
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | AccountsProductListResponse_Data | ||
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
AccountsProductListResponse_DataРаздел данных
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Product | (Нет) | array[AccountProductList] | Информация о банковских продуктах по счетам Пользователя |
ActiveOrHistoricCurrencyAndAmountСумма денежных средств и код валюты
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| amount | (Да) | string | Сумма денежных средств | /^\d{1,15}.\d{2,4}$/ |
| currency | (Да) | string | Код валюты, соответствующий международному стандарту ISO 4217 | /^[A-Z]{3,3}$/ |
BalanceResponseОтвет на запрос об остатке на счете
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | DataBalanceResponse | Раздел данных полезной нагрузки ответа | |
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
BranchAndFinancialInstitutionIdentificationИдентификация финансового учреждения
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| schemeName | (Да) | FinancialInstitutionIdentificationCode | Наименование идентификационной схемы финансового учреждения | |
| identification | (Да) | string | Банковский идентификационный код (БИК) или другой идентификатор финансового учреждения | /^[\w\W]{1,35}$/ |
BranchAndFinancialInstitutionInformationPEИнформация о кредитной организации
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| name | (Да) | string | Наименование организации | /^[\w\W]{1,160}$/ |
| BankIdentification | (Да) | array[BranchAndFinancialInstitutionIdentification] | Идентификация финансового учреждения | |
| OrganizationIdentification | (Да) | array[IdentificationType] | Идентификация юридического лица. | |
| CorrespondentAccount | (Да) | BranchAndFinancialInstitutionInformationPE_CorrespondentAccount | ||
| PostalAddress | (Да) | BranchAndFinancialInstitutionInformationPE_PostalAddress |
BranchAndFinancialInstitutionInformationPE_CorrespondentAccountКорреспондентский счет
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| schemeName | (Да) | AccountIdentificationCode | Наименование схемы идентификации счета | |
| identification | (Да) | string | Идентификатор счета соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) | /^[\w\W]{1,256}$/ |
BranchAndFinancialInstitutionInformationPE_PostalAddressАдрес отделения, обслуживающего счет
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| addressLine | (Да) | string | Строка адреса | /^[\w\W]{1,140}$/ |
BrandТорговая марка продукта
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| brandName | (Да) | string | Наименование собственного брэнда продукта или брэнд организации, который используется для продвижения продукта | /^[\w\W]{1,140}$/ |
| applicationUri | (Да) | string | URL-адрес для получения информации об условиях приобретения продукта | /^[\w\W]{1,2048}$/ |
CardIndividualTransactionСведения об отдельной операции по карте, записанные на POI-терминале (точке взаимодействия)
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| authorizationCode | (Нет) | string | Код авторизации операции | /^[\w\W]{3,35}$/ |
CardTransactionПредоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Card | (Нет) | PaymentCard | ||
| Transaction | (Нет) | CardIndividualTransaction | Сведения об отдельной операции по карте, записанные на POI-терминале (точке взаимодействия) |
CashAccountИдентификация счета
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| name | (Нет) | string | Наименование счета, присвоенное учреждением, обслуживающим счет, по согласованию с владельцем счета для обеспечения дополнительных средств идентификации счета | /^[\w\W]{1,70}$/ |
| schemeName | (Да) | AccountIdentificationCode | Наименование схемы идентификации счета | |
| identification | (Да) | string | Идентификатор счета, соответствующий схеме идентификации, известный владельцу счета (номер банковского счета, номер карты, номер телефона ...) | /^[\w\W]{1,256}$/ |
DataBalanceResponseРаздел данных полезной нагрузки ответа на запрос об остатке на счете
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Balance | (Нет) | array[Balance] |
DataTransactionResponseРаздел данных полезной нагрузки ответа на запрос об операциях по счету
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Transaction | (Нет) | array[TransactionHistory] | Список операций по счету |
IdentificationTypeИдентификация физического лица
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| schemeName | (Да) | PartyIdentificationCode | Наименование идентификационной схемы юридического или физического лица | |
| identification | (Да) | string | Уникальный и однозначный идентификатор участника, присвоенный идентифицирующей организацией. | /^[\w\W]{1,35}$/ |
LinksПоставщик услуг предоставляет постраничный ответ для операций GET, которые возвращают множественные записи.
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| self | (Да) | string; format: uri | Текущая ссылка | |
| first | (Нет) | string; format: uri | Первая ссылка | |
| prev | (Нет) | string; format: uri | Предыдущая ссылка | |
| next | (Нет) | string; format: uri | Следующая ссылка | |
| last | (Нет) | string; format: uri | Последняя ссылка |
MerchantInfoИнформация о продавце
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| merchantId | (Нет) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса | /^[A-Z0-9]{1,40}$/ |
| merchantCategoryCode | (Нет) | string | Код категории соответствует ISO 18245 и относится к типу услуг или товаров, которые продавец предоставляет для транзакции | /^\d{3,4}$/ |
| acquirerId | (Нет) | string | Идентификатор эквайера, проводящего транзакцию. | /^[a-zA-Z0-9]{0,20}$/ |
| terminalId | (Нет) | string | Идентификатор терминала, через который проходит транзакция. | /^[a-zA-Z0-9]{0,20}$/ |
MetaДополнительные данные о запросе. «totalPages», указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент «totalPages» обязательно присутствует.
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| totalPages | (Нет) | integer; format: int32 | Указывает на количество передаваемых страниц |
OBRUCreditLineНабор элементов, используемых для предоставления подробной информации о кредитной линии
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| included | (Да) | boolean | Показывает включена или нет кредитная линия в расчет остатка | |
| Amount | (Да) | ActiveOrHistoricCurrencyAndAmount | Значение лимита внутридневного кредитования (ВДК) |
OBRUErrorКонтейнер с ошибкой
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| errorCode | (Да) | OBRUErrorResponseErrorCode | Низкоуровневое описание ошибки | |
| 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 | (Да) | array[OBRUError] |
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 | (Да) | array[IdentificationType] | Идентификация юридического или физического лица. | |
| PostalAddress | (Нет) | PostalAddress |
PaymentCardДанные по платежной карте
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| cardScheme | (Нет) | CardSchemeNameCode | ||
| additionalCardData | (Нет) | string | Дополнительные сведения, специфичные для эмитента карты | /^[\w\W]{1,70}$/ |
| PaymentCardData | (Нет) | PlainCardData |
PaymentCardBalanceОстаток на счете
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса | /^[a-zA-Z0-9-]{1,40}$/ |
| paymentCardId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации платежной карты | /^[a-zA-Z0-9-]{1,40}$/ |
| AvailableAmount | (Да) | ActiveOrHistoricCurrencyAndAmount | Сумма остатка | |
| creditDebitIndicator | (Да) | CreditDebitCode | Определяет является остаток кредитовым или дебетовым |
PaymentCardBalancesResponseОтвет на запрос об остатке денежных средств, в разрезе платежных карт по всем счетам Пользователя, по которым он дал согласие
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | PaymentCardBalancesResponse_Data | ||
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
PaymentCardBalancesResponse_DataРаздел данных полезной нагрузки ответа на запрос об остатке на счете по картам
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Balance | (Нет) | array[PaymentCardBalance] |
PlainCardDataДанные платежной карты, ассоциированной со счетом
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| PAN | (Да) | string | Маскированный учетный номер карты (PAN) или номер карты, ограниченный последними 4 цифрами. | /^[0-9]{4}$/ |
| expiryDate | (Нет) | string | Дата окончания срока действия карты | /^(1[0-2]|0[1-9]|\d)\/([2-9]\d[1-9]\d|[1-9]\d)$/ |
PlainCardData2Конфиденциальные данные платежной карты, ассоциированной со счетом
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| PAN | (Да) | string | Маскированный учетный номер карты (PAN) или номер карты, ограниченный последними 4 цифрами. | /^[0-9]{4}$/ |
| 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)$/ |
| cardStatus | (Да) | cardStatus |
Статус доступности карты:
|
[pending, active, blocked] |
PostalAddressПочтовый адрес
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| addressType | (Нет) | AddressTypeCode | Тип адреса | |
| 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}$/ |
TransactionHistoryОперация по счету
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| transactionId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации рессурса операции по счету | /^[a-zA-Z0-9-]{1,40}$/ |
| accountId | (Да) | string | Уникальный и неизменный идентификатор, используемый для идентификации ресурса accounts | /^[a-zA-Z0-9-]{1,40}$/ |
| groupId | (Нет) | string | Уникальный идентификатор, используемый для идентификации группы связанных операций по счету | /^[a-zA-Z0-9-]{1,40}$/ |
| transactionInformation | (Нет) | string | Сообщение отправителя получателю денежных средств | /^[\w\W]{1,240}$/ |
| Amount | (Нет) | ActiveOrHistoricCurrencyAndAmount | Информация о сумме и валюте операции по счету | |
| creditDebitIndicator | (Да) | CreditDebitCode | Определяет является ли операция дебетовая или кредитовая | |
| status | (Да) | TransactionStatusCode | Статус операции по счету | |
| BankTransactionCode | (Да) | BankTransactionCode | Подробная информация для полной идентификации собственного банковского кода операции по счету | |
| bookingDateTime | (Да) | string; format: date-time | Дата и время, когда запись об операции по счету публикуется на счете в бухгалтерской книге обслуживающей организации. Используется стандарт ISO8601 | |
| valueDateTime | (Нет) | string; format: date-time | Дата и время, когда активы становятся доступными владельцу счета в случае ввода кредита или перестают быть доступными владельцу счета в случае ввода дебетовой операции по счету | |
| ChargeAmount | (Нет) | ActiveOrHistoricCurrencyAndAmount | Комиссия за операциию по счету | |
| InstructedAmount | (Да) | ActiveOrHistoricCurrencyAndAmount | Сумма денег, подлежащая переводу между плательщиком и получателем денежных средств до вычета расходов, выраженная в валюте обозначенной инициирующей стороной | |
| Debtor | (Нет) | TransactionHistory_Debtor | ||
| DebtorAgent | (Нет) | BranchAndFinancialInstitutionIdentification | Финансовое организация, обслуживающая счет плательщика | |
| DebtorAccount | (Нет) | CashAccount | Уникальная идентификация счета плательщика, на котором будет сделана дебетовая запись в результате операции | |
| CreditorAgent | (Нет) | BranchAndFinancialInstitutionIdentification | Финансовое организация, обслуживающая счет получателя денежных средств | |
| CreditorAccount | (Нет) | CashAccount | Идентификатор счета получателя средств, на котором будет проведена запись о кредите в результате операции. Применение: должен быть указан, если значение параметра creditDebitIndicator равно Debit |
|
| Creditor | (Нет) | TransactionHistory_Creditor | ||
| CardTransaction | (Нет) | CardTransaction | Предоставляет данные по карте (номер, платежная система), терминалу (номер, идентификатор) и транзакционные данные, используемые для уникальной идентификации операции по карте Объект Transaction.CardTransaction не должен возвращаться, если нет отсутствует разрешение ReadPaymentCards |
|
| RemittanceInformation | (Нет) | TransactionHistory_RemittanceInformation | ||
| rejectionReason | (Нет) | string | Причина отказа по операции | ^[\w\W]{1,140}$ |
TransactionHistory_CreditorПолучатель денежных средств
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| name | (Да) | string | Наименование организации или Ф.И.О. | /^[\w\W]{1,160}$/ |
| Identification | (Нет) | array[IdentificationType] | Идентификация юридического или физического лица. | |
| MerchantInformation | (Нет) | MerchantInfo | ||
| PostalAddress | (Нет) | TransactionHistory_Debtor_PostalAddress |
TransactionHistory_DebtorПлательщик
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| name | (Да) | string | Наименование организации или Ф.И.О. | /^[\w\W]{1,160}$/ |
| Identification | (Нет) | array[IdentificationType] | Идентификация юридического или физического лица. | |
| MerchantInformation | (Нет) | MerchantInfo | ||
| PostalAddress | (Нет) | TransactionHistory_Debtor_PostalAddress |
TransactionHistory_Debtor_PostalAddressПочтовый адрес
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| townName | (Нет) | string | Наименование населённого пункта или территории, находящейся вне границ поселений | /^[\w\W]{1,35}$/ |
| country | (Нет) | string | Код страны в формате ISO 3166-1 alpha-3 | /^[A-Z]{3,3}$/ |
TransactionHistory_RemittanceInformationПредоставляемая информация, позволяющая сопоставить запись с позициями, для которых предназначен перевод, такими как коммерческие счета в системе дебиторской задолженности
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| unstructured | (Да) | string | Текстовое назначение платежа | /^[\w\W]{1,140}$/ |
TransactionResponseОтвет на запрос информации об операциях по счету
| Наименование | Обязательность | Тип | Описание | Шаблон/Список |
|---|---|---|---|---|
| Data | (Да) | DataTransactionResponse | Раздел данных полезной нагрузки ответа на запрос об операциях по счету | |
| Links | (Нет) | Links | Раздел для указания ссылок | |
| Meta | (Нет) | Meta | Раздел метаданных |
В рамках текущей спецификации определены статические типы данных в виде кодов, и динамические типы данных, представляющие собой расширяемый список значений. В случае необходимости Поставщик услуг может расширить список значений динамических данных, опубликовав информацию на портале разработчиков. Значения динамических типов данных располагаются в соответствующих пространствах имен, для идентификации источника, использующего расширение. Стандартные динамические значения представлены в данном стандарте и с префиксом RU.CBR. При добавлении собственных значений в справочники участники помещают такие значения в пространство имен, состоящее из двухбуквенного кода страны (код ISO 3166-1 Alpha-2), наименование организации в виде кода и значения справочного кода, разделенных между собой точкой, например:
AccountIdentificationCodeСхема идентификации банковского счета
| Значение | Описание |
|---|---|
| RU.CBR.BBAN | Базовый номер банковского счета (RUCBRAccountIdentifier) |
| RU.CBR.EPID | Идентификатор электронного средства платежа |
| RU.CBR.PAN | Идентификатор счета по номеру карты |
| RU.CBR.MTEL | Идентификатор счета по номеру телефона |
| RU.CBR.ORID | Иной идентификатор (номер, однозначно идентифицирующий счет стороны) |
| RU.CBR.OBCARDID | Уникальный и неизменный идентификатор, используемый для идентификации платежной карты |
AccountStatusСтатус банковского счета
| Значение | Описание |
|---|---|
| Enabled | Cчет доступен и может использоваться |
| Disabled | Cчет не доступен и не может использоваться, временно или навсегда |
| Deleted | Счет удален и не может использоваться |
AccountTypeТип банковского счета
| Значение | Описание |
|---|---|
| Business | Cчет юридического лица |
| Personal | Cчет юридического лица |
AddressTypeCodeТип адреса
| Значение | Описание |
|---|---|
| Business | Адрес, указанный в едином государственном реестре юридических лиц |
| Correspondence | Адрес для корреспонденции |
| DeliveryTo | Адрес доставки |
| MailTo | Почтовый ящик |
| POBox | Абонентский ящик |
| Postal | Фактический/почтовый адрес местонахождения юридического лица |
| Residential | Адрес постоянной регистрации физического лица (прописка) |
| Statement | Адрес временной регистрации физического лица (регистрация временного пребывания) |
BalanceTypeТип остатка
| Значение | Описание |
|---|---|
| Expected | Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса. |
| InterimAvailable | Доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса. |
| ClosingAvailable | Конечный остаток суммы денег, которая находится в распоряжении владельца счета на указанную дату |
| ClosingBooked | Остаток по счету на конец предварительно согласованного отчетного периода. Это сумма начального зарегистрированного баланса в начале периода и всех записей, зачисленных на счет в течение предварительно согласованного отчетного периода |
| ClosingCleared | Конечный остаток суммы денег, которая очищается в указанную дату |
| OpeningAvailable | Начальный баланс суммы денег, которая находится в распоряжении владельца счета на указанную дату |
| OpeningBooked | Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета |
| OpeningCleared | Начальный баланс, который очищается в указанную дату |
| PreviouslyClosedBooked | Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу |
BankTransactionCodeКод банковской операции
| Наименование | Описание |
|---|---|
| ObOtherPayment | Платеж |
| ObPayment | Оплата товара |
| ObPaymentByQrSBP | Оплата по QR-коду СБП |
| ObPaymentByBankDetails | Оплата по реквизитам |
| ObPaymentByQr | Оплата по QR-коду |
| ObTipsPayment | Оплата чаевых |
| ObPaymentInBank | Оплата в отделении банка |
| ObServicePayment | Оплата услуги |
| ObInsurancePayment | Страхование |
| ObSubscriptionPayment | Оплата подписки |
| ObSubscriptionAutoPayment | Автопродление подписки |
| ObPaymentRefund | Возврат покупки |
| ObTransferRefund | Отмена перевода |
| ObOtherRefund | Возврат |
| ObRecovery | Взыскание |
| ObTransfer | Перевод |
| ObTransferToOrganization | Перевод организации |
| ObTransferByNumber | Перевод по номеру телефона |
| ObTransferBySBP | Перевод по СБП |
| ObForeignTransfer | Иностранный перевод |
| ObTransferMe2meBySBP | Перевод между счетами по СБП |
| ObTransferMe2me | Перевод между счетами |
| ObAutoTransfer | Автоперевод |
| ObAutoTransferMe2me | Автоперевод между счетами |
| ObExternalTransfer | Межбанковский перевод |
| ObSalaryAdding | Зарплата |
| ObPensionAdding | Пенсия |
| ObCashWithdrawal | Выдача наличных |
| ObCashDeposit | Внесение наличных |
| ObBankServicePayment | Услуги банка |
| ObTransferFee | Комиссия за перевод |
| ObLoanRepayment | Погашение кредита |
| ObLoanPayment | Оплата по кредиту |
| ObDepositCapitalization | Капитализация по вкладу |
| ObDepositClose | Закрытие вклада |
| ObDepositOpen | Открытие вклада |
| ObDepositWithdrawal | Снятие со вклада |
| ObDepositAdding | Пополнение вклада |
| ObDepositProlongation | Пролонгация вклада |
| ObValuableMetals | Ценные металлы |
| ObSecurities | Ценные бумаги |
| ObInvestment | Инвестиции |
| ObDebtRepayment | Погашение задолженности |
| ObOtherDebiting | Списание |
| ObOtherReceipt | Поступление |
| ObCashback | Кэшбэк |
| ObSocialAdding | Социальные выплаты |
| ObCharityPayment | Благотворительный платеж (взнос) |
CardSchemeNameCodeНаименование платежной системы или схемы карты
| Значение | Описание |
|---|---|
| AmericanExpress | Международная платежная система AmericanExpress |
| ArCa | Армянская национальная платежная система ArCa |
| BELKART | Белорусская национальная платежная система BELKART |
| Diners | Международная платежная система Diners |
| Discover | Международная платежная система Discover |
| ELCART | Киргизская национальная платежная система ELCART |
| JCB | Платежная система Японии JCB |
| MasterCard | Международная платежная система MasterCard |
| MIR | Российская национальная платежная система |
| UnionPay | Национальная платежная система Китая UnionPay |
| VISA | Международная платежная система VISA |
CreditDebitCodeПризнак дебета/кредита
| Значение | Описание |
|---|---|
| Credit | Операция зачисления или положительный остаток на счете |
| Debit | Операция списания или отрицательный остаток на счете |
FinancialInstitutionIdentificationCodeСхема идентификации финансового учреждения
| Значение | Описание |
|---|---|
| RU.CBR.BICFI | BIC для финансовых учреждений согласно ISO 9362 |
| RU.CBR.BIC | Уникальный идентификатор банка, используемый в платежных документах на территории Российской Федерации |
OBRUErrorResponseErrorCodeНизкоуровневое описание ошибки. Поставщик услуг должен заполнить сообщение детальным описанием ошибки, не раскрывая конфиденциальную информацию.
| Код ошибки | 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 |
Данный код ошибки можно использовать при возникновении непредвиденной ошибки. |
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 | Идентификатор банковского счета |
ProductTypeТип банковского продукта
| Значение | Описание |
|---|---|
| DepositIndividual | Депозит физического лица |
| DepositLegalEntity | Депозит юридического лица |
| CAIndividual | Текущий счет физического лица |
| MCCAIndividual | Мультивалютный счет физического лица |
| CALegalEntity | Расчетный счет юридического лица |
| DebitCard | Дебетовая карта |
| CreditCard | Кредитная карта |
| LoanCar | Автокредит |
| LoanIndividual | Кредититование физичиского лица |
| LoanLegalEntity | Кредититование юридического лица |
| Mortgage | Ипотека |
| Investment | Инвестиционный продукт |
| Other | Другой продукт |
TransactionStatusCodeСтатус записи операции по счету
| Значение | Описание |
|---|---|
| AcceptedCreditSettlementCompleted | Расчет по счету Получателя средств завершен |
| AcceptedSettlementCompleted | Расчет по счету Плательщика завершен |
| AcceptedSettlementInProcess | Все предыдущие проверки, такие как техническая проверка и профиль клиента, были успешными, и поэтому запрос об инициировании платежа был принят к исполнению |
| AcceptedWithoutPosting | Платежная инструкция, включенная в перевод, принимается без зачисления на счет Получателя средств |
| Pending | Ожидается инициирование группы платежей или отдельного платежа, включенного в группу платежей |
| Rejected | Инициирование группы платежей или отдельного платежа, включенная в группу инициирования платежей, были отклонены |
Для получения остатка на счете СПИУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_pe) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (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": "Иванов Иван Иванович",
"mobileNumber": "79206001010",
"countryOfResidence": "RU",
"birthDate": "1985-04-12",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"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": "Иванов Иван Иванович",
"mobileNumber": "79206001010",
"countryOfResidence": "RU",
"birthDate": "1985-04-12",
"Identification": [
{
"schemeName": "RU.CBR.TXID",
"identification": "7728240240"
}
],
"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-pe/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": "Наименование организации или физического лица",
"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"
}
},
"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-pe/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-pe/accounts/200200"
},
"Meta": {
"totalPages": 1
}
}
При передаче информации об остатке на счете необходимо учитывать наличие у пользователя кредитной линии, в том числе предоставленного овердрафта, и передавать в ответе на запрос об информации об остатке счета с указанием соответствующего типа баланса (type):
Expected - доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания на момент запроса - передается в каждом ответе на запрос об информации об остатке счета физического лица.interimAvailablec - доступный баланс в течение операционного дня, учитывающий проведенные операции, ожидаемые поступления и списания, а также доступные кредитные линии или овердрафты на момент запроса - передается дополнительным элементом массива Balance при наличие кредитной линии, в том числе предоставленного овердрафта.Опционально, расширенная информация о кредитной линии может передаваться в блоке CreditLine, а ее использование определяет параметрincluded:
included равно false, то это означает, что данная сумма доступна Пользователю для операций (предоставляемый кредитный лимит или овердрафт), не была использована.included равно true, то это означает, что данная сумма была использована Пользователем.creditDebitIndicatorВ сообщениях об остатке на счете параметр creditDebitIndicator указывает, является ли сумма дебетовой или кредитовой по отношению к счету. Если остаток на счете положительный, то он считается кредитовым, и в этом случае значение параметра creditDebitIndicator должно быть Credit.
Таким образом следует указывать:
Credit — если остаток положительный (кредитовый);Debit — если остаток отрицательный (дебетовый).Для получения остатка на счете СПИУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_pe) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsReadBalancesОписание: У Пользователя два счета. На первом остаток 800 рублей, на втором 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": "Expected",
"Amount": {
"amount": "800.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00"
},
{
"accountId": "200201",
"type": "Expected",
"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-pe/balances"
},
"Meta": {
"totalPages": 1
}
}
Описание: У Пользователя счет с остатком 800 рублей и кредитной линией в размере 500 рублей, которая не была использована.
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": "Expected",
"Amount": {
"amount": "800.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00"
},
{
"accountId": "200200",
"type": "interimAvailable",
"Amount": {
"amount": "1300.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"dateTime": "2021-06-05T15:15:13+00:00",
}
]
},
"Links": {
"self": "https://sb.example.ru/v2.0/aisp-pe/accounts/200200/balances"
},
"Meta": {
"totalPages": 1
}
}
Описание: У Пользователя отрицательный остаток (-100 рублей). Он использовал 400 рублей из доступной кредитной линии в 500 рублей. У него остается 400 рублей доступных средств.
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": "Expected",
"Amount": {
"amount": "-100.00",
"currency": "RUB"
},
"creditDebitIndicator": "Debit",
"dateTime": "2021-06-05T15:15:13+00:00"
},
{
"accountId": "200200",
"type": "interimAvailable",
"Amount": {
"amount": "400.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"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-pe/accounts/200200/balances"
},
"Meta": {
"totalPages": 1
}
}
Для получения нформации о платежных картах СПИУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_pe) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsReadPaymentCardsДля получения информации об остатке денежных средств на карте (get /payment-card-balances) согласие должно иметь разрешение ReadBalances.
GET /payment-cards 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": {
"PaymentCard": [
{
"accountId": "200200",
"paymentCardId": "payment-card-id-001",
"paymentCardType": "Debit",
"paymentCardName": "Экономная карта",
"PaymentCardData": {
"PAN": "0001",
"effectiveDate": "12/2021",
"expiryDate": "12/2025",
"cardStatus": "active"
},
"cardScheme": "MIR"
},
{
"accountId": "200201",
"paymentCardId": "payment-card-id-002",
"paymentCardType": "Debit",
"paymentCardName": "Премиальная карта",
"PaymentCardData": {
"PAN": "0002",
"effectiveDate": "11/2021",
"expiryDate": "11/2025",
"cardStatus": "active"
},
"cardScheme": "VISA"
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-pe/payment-cards"
},
"Meta": {
"totalPages": 1
}
}
GET /accounts/200200/payment-cards 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": {
"PaymentCard": [
{
"accountId": "200200",
"paymentCardId": "payment-card-id-001",
"paymentCardType": "Debit",
"paymentCardName": "Экономная карта",
"PaymentCardData": {
"PAN": "0001",
"effectiveDate": "12/2021",
"expiryDate": "12/2025",
"cardStatus": "active"
},
"cardScheme": "MIR"
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-pe/accounts/200200/payment-cards"
},
"Meta": {
"totalPages": 1
}
}
Разрешение ReadBalances было предоставлено.
GET /payment-card-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",
"paymentCardId": "payment-card-id-001",
"AvailableAmount": {
"amount": "200.00",
"currency": "RUB"
},
"creditDebitIndicator": "Debit"
},
{
"accountId": "200201",
"paymentCardId": "payment-card-id-002",
"AvailableAmount": {
"amount": "1200.00",
"currency": "RUB"
},
"creditDebitIndicator": "Debit"
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-pe/"
},
"Meta": {
"totalPages": 1
}
}
Для получения информации об операциях по счету СПИУ должен предъявить в запросе (в параметре HTTP заголовка Authorization) действительный токен доступа, содержащий требуемую область доступа (scope должен содержать obru_accounts_pe) и быть связанным с авторизованным согласием, содержащим как минимум следующие разрешения (permissions):
ReadAccountsReadTransactionsBasicМассив разрешений должен также включать одно из следующих значений permission:
ReadTransactionsCreditsReadTransactionsDebitsВ случае необходимости предоставления детальной информации об операциях по счету согласие должно иметь разрешение ReadTransactionsDetail.
Разрешение ReadTransactionsDetail было предоставлено.
GET /accounts/200200/transactions 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": {
"Transaction": [
{
"transactionId": "transaction-01",
"accountId": "200200",
"Amount": {
"amount": "200.00",
"currency": "RUB"
},
"creditDebitIndicator": "Debit",
"status": "AcceptedSettlementCompleted",
"BankTransactionCode": {
"code": "Payments",
"subCode": "MerchantCardTransactions"
},
"bookingDateTime": "2021-06-05T15:15:13+00:00",
"valueDateTime": "2021-06-05T15:15:13+00:00",
"ChargeAmount": {
"amount": "2.00",
"currency": "RUB"
},
"InstructedAmount": {
"amount": "202.00",
"currency": "RUB"
},
"DebtorAccount": {
"name": "Моя карта",
"schemeName": "RU.CBR.PAN",
"identification": "**1234"
},
"Creditor": {
"name": "Пятерочка",
"Identification": [
{
"schemeName": "RU.CBR.BBAN",
"identification": "6574836428347453"
}
],
"PostalAddress": {
"townName": "Бигсити",
"country": "RUS"
},
"MerchantInformation": {
"merchantId": "19427360OFALLONMO",
"merchantCategoryCode": "1234"
}
},
"CardTransaction": {
"Card": {
"cardScheme": "MIR",
"additionalCardData": "Дополнительные сведения о карте",
"PaymentCardData": {
"PAN": "0001",
"expiryDate": "12/2025"
}
},
"Transaction": {
"authorizationCode": "1234"
}
},
"RemittanceInformation": {
"unstructured": "Назначение платежа - оплата за товары или услуги"
}
},
{
"transactionId": "transaction-02",
"accountId": "200200",
"transactionInformation": "Сообщение отправителя получателю денежных средств",
"Amount": {
"amount": "2000.00",
"currency": "RUB"
},
"creditDebitIndicator": "Credit",
"status": "AcceptedSettlementCompleted",
"BankTransactionCode": {
"code": "Payments",
"subCode": "ReceivedRealTimeCreditTransfers"
},
"bookingDateTime": "2021-06-05T16:15:13+00:00",
"InstructedAmount": {
"amount": "200.00",
"currency": "RUB"
},
"CreditorAccount": {
"name": "Моя карта",
"schemeName": "RU.CBR.PAN",
"identification": "**1234"
},
"Debtor": {
"name": "Андрей В."
}
}
]
},
"Links": {
"self": "https://sb.example.ru/open-banking/v2.0/aisp-pe/accounts/200200/transactions"
},
"Meta": {
"totalPages": 1
}
}