Стандарт Банка России «Открытые банковские интерфейсы. Получение информации о счете клиента третьей стороной»

(введен Банком России 23.10.2020)

Дата введения: 2020-10-23

2. Введение

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

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

В настоящем Стандарте применяются следующие термины и определения:

Таблица 1. Термины и определения

2.3. Принципы архитектуры

Архитектура среды Открытых банковских интерфейсов соответствует концепции RESTful API <3>.

<3> Детальное описание подхода можно посмотреть на сайте: https://restfulapi.net/.

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

2.3.1. Идентификаторы

Ресурс REST имеет уникальный идентификатор, который используется для идентификации ресурса. Эти уникальные идентификаторы используются для создания URL-адресов для идентификации и адресации конкретных ресурсов.

2.3.2. Коды статусов

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

• Код состояния HTTP отражает результат вызова API (операция HTTP на ресурсе);
• Поле состояния в некоторых полезных нагрузках ресурса отражает состояние ресурсов.

3. Основы

3.1. Роли участников

Среда Открытых банковских интерфейсов определяет следующих участников:

Пользователь — физическое или юридическое лицо, являющееся плательщиком или получателем средств.

Сторонний поставщик — юридическое лицо, использующее Открытые банковские интерфейсы для доступа к банковскому счету Пользователя в целях предоставления информационных услуг (СПИУ) или для осуществления переводов денежных средств (платежей) (СППУ).

ППУ (Поставщик Платежных Услуг) — кредитная организация или ее филиал, обслуживающая счет Пользователя и публикующая Открытые банковские интерфейсы.

Среда Открытых банковских интерфейсов определяет следующие роли участников:

СПИУ (Сторонний Поставщик Информационных Услуг о банковском счете) — юридическое лицо, предоставляющее Пользователю услугу получения информации о банковском счете (счетах) Пользователя.

СППУ (Сторонний Поставщик Платежных Услуг) — юридическое лицо, предоставляющее Пользователю услугу по инициированию перевода денежных средств.

Среда Открытых банковских интерфейсов определяет следующие взаимоотношения между участниками и ролями:

Таблица 2. Роли участников

Открытые банковские интерфейсы регламентируют взаимодействие только между следующими участниками:

- ППУ предоставляет Открытые банковские интерфейсы для Стороннего поставщика. Получает сообщения запросов через свои Открытые банковские интерфейсы и отправляет соответствующие ответные сообщения Стороннему поставщику.

- Сторонний поставщик может получить доступ к счету Пользователя, управляемому ППУ через Открытые банковские интерфейсы, при согласии Пользователя. Сторонний поставщик отправляет сообщения запроса через Открытые банковские интерфейсы ППУ и получает соответствующие ответные сообщения от этого ППУ.

3.2. Кодировка символов

Запросы и ответы API используют кодировку UTF-8. Это кодировка символов по умолчанию для JSON (RFC 7158 — раздел 8.1).

Однако нисходящая система ППУ может не принимать некоторые символы UTF-8, такие как символы emoji (например, идеограммы и смайлики могут не быть приемлемой ссылкой на платеж). Если ППУ отклоняет сообщение с символом UTF-8, которое не может быть обработано, то ППУ отвечает кодом состояния HTTP 400 (неверный запрос).

3.3. Формат даты

ППУ принимает в запросах все действующие форматы даты стандарта ISO 8601, включая его разрешенные вариации.

Все даты в полезных нагрузках JSON представлены в формате dateTime стандарта ISO 8601. Все поля dateTime в ответах включают часовой пояс. Например:

Таблица 3. Поля dateTime с часовым поясом

Все даты в параметрах query имеют формат dateTime стандарта ISO 8601 и не включают часовой пояс. Например:

Таблица 4. Поля dateTime с обрезанием часового пояса

Таблица 5. Формат представления полной даты

Таблица 6. Формат представления полной даты с секундами

3.4. Структура пути URI-ресурса

Путь URI соответствует следующей структуре:

- [participant-path-prefix]/open-banking/[version]/[resource]/[resource-id]/[sub-resource]

Структура URI пути состоит из следующих элементов:

• [participant-path-prefix]

Необязательный префикс ППУ.

• open-banking

Постоянное значение «open-banking».

• [version]

Версия API, выраженная в виде /v[major-version].[minor-version]/.

- [resource]/[resource-id]

Наименование ресурса и его идентификатор.

• [sub-resource]

Наименование подресурса (ресурса 2-го уровня).

ППУ использует один и тот же participant-path-prefix и host name для всех своих ресурсов.

Примеры:

https://bank.ru/oapi-channel/open-banking/v1.1/payments

https://bank.ru/oapi-channel/open-banking/v1.1/account-consents

https://bank.ru/oapi-channel/open-banking/v1.1/accounts

https://bank.ru/oapi-channel/open-banking/v1.1/accounts/1234

https://bank.ru/oapi-channel/open-banking/v1.1/accounts/1234/transactions

3.5. Заголовки сообщений (headers)

3.5.1. Заголовки запросов

Таблица 7. Заголовки запросов

Наличие или отсутствие Пользователя определяется через заголовок x-fapi-customer-ip-address. Если указан IP-адрес Пользователя, то предполагается, что Пользователь присутствует во время взаимодействия.

Последствием этого является то, что ППУ полагаются на информацию, предоставленную СПИУ.

3.5.2. Заголовки ответов

Таблица 8. Заголовки ответов

3.6. Коды статусов HTTP

Ниже приведены коды ответов HTTP для различных методов HTTP всех конечных точек API.

Таблица 9. Коды статусов HTTP

ППУ возвращают другие стандартные коды состояния HTTP (например, от шлюзов и других периферийных устройств), как описано в RFC 7231 — раздел 6.

ППУ отвечают ошибкой в потоке OAuth/OIDC с обязательным выравниванием кодов ошибок, указанных в разделе 3.1.2.6 OpenID Connect Core Specification.

ППУ отвечают на все некорректные запросы общей структурой ошибок Открытых банковских интерфейсов.

3.6.1. 400 (Bad Request) или 404 (Not Found)

Если Сторонний Поставщик пытается получить доступ к URL-адресу ресурса, который не определен этими спецификациями (например, GET /card-accounts), то ППУ отвечает 404 (Not Found).

Если ППУ не реализовал конечную точку API, то он отвечает 404 (не найдено) для запросов к этому URL.

Таблица ниже иллюстрирует некоторые примеры предсказуемого поведения:

Таблица 10. Возможные ситуации для ответов 400 (Bad Request) и 404 (Not Found)

3.6.2. 403 (Forbidden)

3.6.3. 401 (Unauthorized)

3.6.4. 429 (Too Many Requests)

Если Сторонний Поставщик пытается получить доступ к ресурсу слишком часто, то ППУ может вернуть 429 (Too Many Requests). Это нефункциональное требование, отдельные ППУ определяют метрику запросов в единицу времени.

Ситуация возникает, когда:

• Сторонний Поставщик решает реализовать функцию «Статус перевода денежных средств в реальном времени» для своих Пользователей и делает это некорректно, опрашивая конечную точку методом GET.
• Сторонний Поставщик решает использовать конечную точку для одиночного перевода денежных средств, как если бы она была конечной точкой пакетной оплаты, и отправляет большое количество запросов на оплату в очень короткий промежуток времени, так что это превышает политику использования ППУ.

3.7. Идемпотентность

Ключ идемпотентности используется для защиты от создания дубликатов ресурсов при использовании метода POST для конечных точек API.

Если для конечной точки API требуется ключ идемпотентности:

- Параметр заголовка x-idempotency-key содержит не более 40 символов. Если длина поля превышает 40 символов, то ППУ отклоняет запрос с кодом состояния 400 (Bad Request).

• Сторонний Поставщик не меняет тело запроса при использовании одинакового ключа x-idempotency-key. Если Сторонний Поставщик изменяет тело запроса, то ППУ не меняет конечный ресурс. ППУ рассматривает это как мошенническое действие.
• ППУ обрабатывает запрос как идемпотентный, если он получил запрос с существующим параметром x-idempotency-key от того же Стороннего Поставщика в течение 24 часов.
• ППУ не создает новый ресурс для запроса POST, если он определен как идемпотентный запрос.
• ППУ отвечает на запрос текущим статусом ресурса (или статусом, максимально близким к текущему, который можно получить в данный момент времени на существующем онлайн-канале) и кодом статуса HTTP 201 (Created).
• Сторонний Поставщик не использует ключ идемпотентности при опросе состояния ресурсов.
• ППУ использует подпись сообщения вместе с ключом идемпотентности, чтобы гарантировать, что тело запроса не изменилось.

Если ключ идемпотентности не требуется для конечной точки API, но содержится в запросе, то ППУ игнорирует ключ идемпотентности.

3.8. Фильтрация

Параметры фильтра всегда разные для конкретного поля (полей) ресурса и следуют правилам/форматам, определенным в справочниках для ресурса.

Для параметров фильтра типа DateTime значения соответствуют стандарту ISO 8601. Если значение поля типа DateTime содержит часовой пояс, то ППУ игнорирует эту информацию.

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

3.9. Нумерация страниц

ППУ предоставляет постраничный ответ для операций GET, которые возвращают множественные записи.

В такой ситуации ППУ:

- Если существует следующая страница записей ресурсов, то ППУ предоставляет ссылку на следующую страницу ресурсов в поле Links.Next ответа. Отсутствие следующей ссылки будет означать, что текущая страница является последней страницей результатов.

• Если предыдущая страница записей ресурсов существует, то ППУ предоставляет ссылку на предыдущую страницу ресурсов в поле Links.Prev ответа. Отсутствие предыдущей ссылки указывает на то, что текущая страница является первой страницей результатов.

Для разбитых на страницы ответов ППУ гарантирует, что количество записей на странице находится в разумных пределах, минимум 25 записей (кроме последней страницы, где больше нет записей) и максимум 1000 записей.

Дополнительно ППУ предоставляет:

• Ссылку на первую страницу результатов в поле Links.First.
• Ссылку на последнюю страницу результатов в поле Links.Last.
• Общее количество страниц в поле Meta.TotalPages.

ППУ включает «self» ссылку на ресурс в поле Links.Self, как описано в разделе «Ссылки».

Этот стандарт не определяет, каким образом параметры перелистывания страниц передаются ППУ, и каждый ППУ может использовать свои собственные механизмы для разбивки ответа.

Если исходный запрос от СПИУ включал параметры фильтра, то в ответе возвращаются только те результаты (разбитые на страницы), которые соответствуют фильтру.

3.10. Архивирование

Архивация ресурсов будет определяться для ППУ на основе их внутренних требований.

В дополнение стоит отметить, что:

- ППУ удаляют просроченные идентификаторы согласия (consentId) только через 24 часа после создания.

• ППУ могут архивировать просроченные идентификаторы согласия.

3.11. Дополнительные данные

Ряд ресурсов в спецификации включает в себя раздел для дополнительных данных (Supplementary Data). Данный раздел позволит ППУ принимать или передавать данные, которые не предусмотрены основной структурой ресурса.

Раздел дополнительных данных определяется как пустой объект JSON в данной спецификации.

Если ППУ использует структуру с дополнительными данными (Supplementary Data), то он выкладывает детальное описание структуры у себя на портале для разработчиков.

ППУ не используют структуру Supplementary Data, если добавляемый туда элемент уже существует в текущей версии документа Открытых банковских интерфейсов.

4. Модель данных

4.1. Справочники и перечисления

Спецификации Открытых банковских интерфейсов содержат поля со справочными данными.

Справочники бывают двух видов:

• фиксированные;
• гибкие.

В случае фиксированных справочников — все возможные значения будут задаваться статично в стандарте Открытых банковских интерфейсов.

В случае гибких справочников — начальные возможные значения будут задаваться в стандарте Открытых банковских интерфейсов, но каждый ППУ может динамично управлять ими, расширяя своими кастомизированными значениями. Кастомизированные значения, которые используют ППУ, могут в будущем включаться в список начальных возможных значений для гибких справочников.

И фиксированные, и гибкие справочники находятся в разделе «Справочники и перечисления».

4.2. Общая структура полезной нагрузки

В этом разделе приводится обзор структуры верхнего уровня для полезных нагрузок Открытых банковских интерфейсов.

Данные, которые содержатся в разделе «Data», документируются для каждой отдельно взятой конечной точки API.

4.2.1. Структура запроса

Структура верхнего уровня для запросов Открытых банковских интерфейсов имеет следующий вид:

Таблица 11. Верхнеуровневая структура сообщений для запросов

Data

Раздел «Data» содержит данные запроса для конкретного запроса API.

Структура этого элемента отличается для каждой конечной точки API.

Risk

Раздел «Risk» содержит индикаторы риска для конкретного запроса API, предоставленного Сторонним Поставщиком.

Индикаторы риска, содержащиеся в этом элементе, могут отличаться для каждой конечной точки API.

4.2.2. Структура ответа

Структура верхнего уровня для ответов Открытых банковских интерфейсов имеет следующий вид:

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    {                                                                    │
│      "Data": {                                                          │
│        ...                                                              │
│      },                                                                 │
│      "Risk": {                                                          │
│        ...                                                              │
│     },                                                                  │
│      "Links": {                                                         │
│         ...                                                             │
│     },                                                                  │
│      "Meta": {                                                          │
│         ...                                                             │
│     }                                                                   │
│                                                                         │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 12. Верхнеуровневая структура сообщений для ответов

В соответствии с принципом API RESTful полный ресурс воспроизводится как часть ответа. В ответ включаются следующие дополнительные разделы высокого уровня:

• Links
• Meta

4.2.3. Структура ответа с ошибками

Структура для ответов с ошибками Открытых банковских интерфейсов имеет следующий вид:

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    {                                                                    │
│      "code": "...",                                                     │
│      "id": "...",                                                       │
│      "message": "...",                                                  │
│      "Errors": [                                                        │
│        {                                                                │
│          "errorCode": "...",                                            │
│          "message": "...",                                              │
│          "path": "...",                                                 │
│          "url": "..."                                                   │
│        }                                                                │
│      ]                                                                  │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 13. Структура сообщений для ответов с ошибками

UML-диаграмма

Рисунок 1. UML-диаграмма для структуры ответов с ошибками

Спецификация данных

Таблица 14. Детальное описание элементов ответа с ошибками

4.2.4. Необязательные поля

В объектах, где значение для необязательного поля не указано, поле исключается из полезной нагрузки JSON.

В объектах, где поле массива определено как имеющее значения 0..n, поле массива включается в полезную нагрузку с пустым массивом.

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    {                                                                    │
│      "name": "",            // Неправильно. Поле "Name" нужно исключить │
│    из полезной нагрузки.                                                │
│      "age": 0,              // Неправильно. Значение "0" не используется│
│    для указания неопределенного возраста.                               │
│      "creditorAccount": {}, // Неправильно. Поле "creditorAccount"      │
│    нужно исключить.                                                     │
│      "balances": []         // Правильно. Таким образом передается      │
│    пустой массив.                                                       │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 15. Примеры передачи необязательных полей

4.2.5. Ссылки

Раздел «Links» является обязательным и всегда будет содержать абсолютные URI для связанных ресурсов.

Ссылка «self» является обязательной.

Таблица 16. Пример передачи одинарной ссылки «Self»

При передаче большого количества данных раздел Links может также содержать элементы First, Prev, Next и Last.

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    "Links": {                                                           │
│      "self": "http://rocks.ru/articles?page[number]=3&page[size]=25",   │
│      "first": "http://rocks.ru/articles?page[number]=1&page[size]=25",  │
│      "prev": "http://rocks.ru/articles?page[number]=2&page[size]=25",   │
│      "next": "http://rocks.ru/articles?page[number]=4&page[size]=25",   │
│      "last": "http://rocks.ru/articles?page[number]=6&page[size]=25"    │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 17. Пример передачи всех элементов раздела Links

4.2.6. Метаданные

Раздел Meta обязателен, но может быть пустым. Необязательный элемент TotalPages, указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент TotalPages обязательно присутствует.

Таблица 18. Пример передачи раздела Meta

5. Примеры использования

5.1 Потоки с нумерацией страниц.

Приведенный ниже пример иллюстрирует, как ППУ может возвращать многостраничный ответ.

Таблица 19. Запрос списка транзакций

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                      │
│    x-fapi-interaction-id: 11bac543-d5de-3446-b687-880a5018434d          │
│    Content-Type: application/json                                       │
│    {                                                                    │
│      "Data": {                                                          │
│        ...                                                              │
│      },                                                                 │
│      "Links": {                                                         │
│        "self": "https://bank.ru/open-banking/v3.l/accounts/98765/       │
│        transactions/",                                                  │
│        "last": "https://bank.ru/open-banking/v3.l/accounts/98765/       │
│        transactions?pg=6",                                              │
│        "first": "https://bank.ru/open-banking/v3.l/accounts/98765/      │
│        transactions/",                                                  │
│        "next": "https://bank.ru/open-banking/v3.1/accounts/98765/       │
│        transactions?pg=2"                                               │
│      },                                                                 │
│      "Meta": {                                                          │
│        "totalPages": 6,                                                 │
│        "firstAvailableDateTime": "2019-05-03T00:00:00+00:00",           │
│        "lastAvailableDateTime": "2019-12-03T00:00:00+00:00"             │
│      }                                                                  │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 20. Пример передачи всех элементов раздела Links

6. Счета и транзакции, спецификация API — v1.2.1

6.1. Введение

В данном разделе описываются потоки данных и полезные нагрузки для Открытых банковских интерфейсов по счетам и транзакциям.

Описанные здесь конечные точки API позволяют СПИУ:

- Создать согласие на доступ к информации о счете. Пользователь предоставляет доступ СПИУ к своим данным в ППУ. Для этого Пользователь:

• Выбирает, к каким данным он готов предоставить доступ, проставив разрешения (permissions);
• Выбирает срок действия разрешений на использование данных;
• Выбирает даты начала и окончания, которые будут использоваться при построении отчетов по спискам транзакций и выпискам.
• Получать данные по счетам и транзакциям.

6.2. Основы

В данном разделе описываются потоки данных с позиции бизнес-процессов. Детальное описание потоков данных находится в стандарте «Открытые банковские интерфейсы. Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID».

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

6.2.1.1. Пошаговое описание

Шаг 1 — Запрос информации о счете:

• Этот поток начинается с согласия Пользователя на предоставление СПИУ доступа к информации о счете.

Шаг 2 — Настройка согласия на доступ к информации о счете:

• Между СПИУ и сервером авторизации ППУ устанавливается защищенный канал связи в рамках стандарта «Открытые банковские интерфейсы. Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID».
• СПИУ с помощью потока Client Credentials Grant получает на сервере авторизации ППУ токен доступа (access-token).
• Между СПИУ и сервером ресурсов ППУ устанавливается защищенный канал связи в рамках стандарта «Открытые банковские интерфейсы. Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID».
• СПИУ подключается к ППУ, который обслуживает счет (счета) Пользователя и создает ресурс согласия на доступ к информации о счете. ППУ сообщается о том, что один из его Пользователей предоставляет доступ к информации о счете и информации о транзакциях для СПИУ. ППУ отвечает идентификатором ресурса (consentId). Этот шаг выполняется с помощью запроса POST к конечной точке/account-consents.

- Ресурс согласия на доступ к информации о счете будет включать в себя следующие поля, которые описывают данные, на которые Пользователь дал согласие для СПИУ:

- Permissions — список кластеров данных, которые были разрешены для доступа.

- Expiration Date — необязательное поле, означающее срок действия доступа СПИУ к данным Пользователя.

• Transaction Validity Period — необязательное поле, означающее диапазон дат, который определяет период для транзакций и выписок, к которым СПИУ может получить доступ.
• СПИУ может быть посредником для передачи данных другим сторонам, поэтому для Пользователя допустимо иметь несколько account-consents — ресурсов на доступ к информации о счете для одного и того же счета с разными параметрами согласия и (или) авторизации.

Шаг 3 — Авторизация согласия:

• СПИУ запрашивает у Пользователя авторизацию согласия. ППУ выполняет это с использованием потока перенаправления (redirection flow):
• СПИУ перенаправляет Пользователя на страницу к ППУ.
• Перенаправление содержит consentId, созданный на предыдущем шаге, что позволяет ППУ сравнить с идентификатором имеющегося у него ресурса согласия на доступ к информации о счете (account-consent).
• ППУ аутентифицирует Пользователя.
• ППУ обновляет статус ресурса согласия на доступ к информации о счете (account-consent), фиксируя, что согласие было авторизовано.
• Как только согласие было авторизовано, Пользователь перенаправляется обратно на сторону СПИУ с кодом авторизации (authorization-code).
• Между СПИУ и сервером авторизации ППУ устанавливается защищенный канал связи в рамках стандарта «Открытые банковские интерфейсы. Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID».
• СПИУ обменивает на сервере авторизации ППУ код авторизации (authorization-code) на токен доступа (access-token).
• Между Пользователем и СПИУ осуществляется управление согласием, поэтому на этом этапе не могут изменяться детали согласия на доступ к информации о счете (с ППУ). Пользователь может только полностью авторизовать или отклонить данные о согласии на доступ к информации о счете.
• Во время авторизации Пользователь выбирает счета, которые авторизованы для запросов СПИУ (в интерфейсе ППУ).

Шаг 4 — Запрос данных:

- Между СПИУ и сервером ресурсов ППУ устанавливается защищенный канал связи в рамках стандарта «Открытые банковские интерфейсы. Безопасность финансовых (банковских) операций. Прикладные программные интерфейсы обеспечения безопасности финансовых сервисов на основе протокола OpenID».

- СПИУ выполняет запрос данных с помощью запроса GET для соответствующего ресурса.

- Уникальные accountId(s), которые соответствуют согласию на доступ к информации о счетах (account-consent), будут возвращены при вызове GET /accounts. Это всегда будет первый вызов при наличии у СПИУ действующего токена доступа (access-token).

6.2.1.2. Диаграмма последовательности

Рисунок 2. Диаграмма последовательности для получения информации о счете

6.2.2. Идемпотентность

Конечные точки Открытых банковских интерфейсов, предназначенные для создания согласия на доступ к информации о счете/транзакциях, не являются идемпотентными.

Если возникает ошибка тайм-аута, то ППУ создает новый ресурс согласия на доступ к информации о счете, а не тот же ресурс.

6.2.3. Сохранение обратной совместимости между мажорными версиями

В этом разделе дается обзор принципов сохранения обратной совместимости между версиями Открытых банковских интерфейсов на получение информации о счете/транзакциях.

6.2.3.1. Ресурсы согласия на доступ к информации о счете

6.2.3.1.1. POST

• СПИУ не создает согласие в более новой версии спецификации и не использует его для конечных точек предыдущей версии спецификации
• То есть идентификатор consentId для созданного ресурса account-consent во 2-й версии не используется для доступа к конечным точкам 1-й версии.

6.2.3.1.2. GET

- СПИУ не получает доступ к ресурсу согласия в более старой версии через Id для ресурса согласия, созданного в более новой версии:

- ППУ разрешает доступ к ресурсу согласия в более новой версии.

- ППУ гарантирует, что набор разрешений (permissions), связанный с ресурсом согласия, не изменяется при доступе в другой версии.

- ППУ гарантирует инвариантность полей ресурса согласия от версии API.

- ППУ разрешает доступ к ресурсам согласия с истекшей датой действия в более новой версии.

• ППУ выбирает заполнение новых полей, добавленных в ресурсе, из значений по умолчанию предыдущей версии (если установлена обязательность) или не заполняет (если обязательность не установлена).

6.2.3.1.3. DELETE

- СПИУ не удаляет ресурс согласия в более старой версии с помощью идентификатора согласия, созданного в более новой версии:

- То есть, если ресурс согласия создан во 2-й версии, а запрос на удаление осуществляется в 1-й версии конечной точки, то удаление не происходит.

- ППУ поддерживает удаление ресурса согласия из предыдущей версии через конечные точки более новой версии:

• Например, ресурс согласия был создан в 1-й версии, а его удаление происходит через конечную точку 2-й версии.

6.2.3.2. Ресурсы для предоставления информации о счете/транзакциях

6.2.3.2.1. GET

• СПИУ может использовать токен, связанный с ресурсом согласия из предыдущей версии, для доступа к конечной точке более новой версии.
• СПИУ может использовать идентификатор ресурса согласия, созданного в предыдущей версии, для получения информации о счете в более новой версии.
• СПИУ не использует идентификатор ресурса согласия из более новой версии для доступа к ресурсам информации о счете в предыдущей версии.
• СПИУ не использует идентификатор ресурса согласия из предыдущей версии для доступа к ресурсу, представленному в более новой версии (согласие не будет иметь разрешений, необходимых для доступа к новому ресурсу).
• ППУ разрешает СПИУ использовать идентификатор ресурса согласия из предыдущей версии для доступа к конечным точкам ресурса информации о счете в более новой версии.
• ППУ отклоняет запрос на доступ к ресурсу, для которого набор разрешений согласия не соответствует.
• ППУ выбирает заполнение новых полей, добавленных в ресурсе, из значений по умолчанию из предыдущей версии (если установлена обязательность) или не заполняет.

6.3. Конечные точки

В этом разделе рассматривается список доступных конечных точек Открытых банковских интерфейсов для доступа к информации о счете/транзакциях.

Наличие ресурсов 2-го уровня (например, balances, transactions) поможет управлять этими ресурсами (у каждого ресурса 2-го уровня есть уникальный идентификатор).

Таблица 21. Конечные точки для получения информации о счете

6.4. Безопасность и контроль доступа

6.4.1. Scopes

Токен доступа, требуемый для доступа к информации о счете, имеет как минимум следующий scope:

Таблица 22. Scope для получения информации о счете

6.4.2. Grants Types

СПИУ использует поток Client Credentials Grant для получения токена доступа к ресурсу account-consents. В спецификациях этот тип предоставления называется «Client Credentials».

СПИУ использует Authorization Code Grant с потоком перенаправления (redirect flow) или с потоком разъединения (decoupled flow) для получения токена доступа ко всем другим ресурсам (кроме согласия). В спецификации этот тип предоставления называется «Authorization Code».

6.4.3. Авторизация согласия

СПИУ создает ресурс account-consent с помощью POST операции. Пока данный ресурс не будет авторизован Пользователем, его создание указывает лишь на факт, что между Пользователем и СПИУ есть предварительная договоренность на использование данных, которыми Пользователь обладает в ППУ (с определенными permissions).

При создании ресурса account-consent в ответе ППУ содержится идентификатор ресурса consentId, поскольку данный идентификатор будет использоваться в дальнейшем для авторизации Пользователя (верификации permissions).

В рамках процесса авторизации согласия:

• ППУ аутентифицирует Пользователя.

- ППУ передает согласие, зарегистрированное на стороне СПИУ, Пользователю для получения от него авторизации напрямую.

- Пользователь может подтвердить или отклонить согласие.

- ППУ предоставляет Пользователю список счетов, который соответствует согласию Пользователя. После этого ресурс согласия является авторизованным Пользователем.

6.4.3.1. Элементы согласия

Ресурс account-consent состоит из следующих элементов:

• Permissions: Набор кластеров данных, к которым СПИУ имеет доступ после согласия Пользователя.

- ExpirationDateTime: Дата, до которой согласие действительно. Срок действия согласия.

- TransactionFromDateTime: Начальная дата, с которой СПИУ имеет доступ к транзакциям Пользователя на стороне ППУ.

- TransactionToDateTime: Конечная дата, до которой СПИУ имеет доступ к транзакциям Пользователя на стороне ППУ.

6.4.3.1.1. Permissions (разрешения)

Коды permissions будут использоваться для ограничения данных, возвращаемых в ответ на запрос ресурса.

Разрешения (permissions) бывают базовыми и детальными. Если Пользователь дал доступ к детальным разрешениям, то соответствующие базовые разрешения считаются доступными по умолчанию.

Массив разрешений состоит как минимум из ReadAccountsBasic или ReadAccountsDetail разрешений.

Следующие комбинации разрешений являются недопустимыми, и ППУ отклонит такие ресурсы account-consents с 400 кодом в ответе:

• Согласие содержит пустой массив разрешений. Если ППУ не получил ни одного permission, то такой запрос отклоняется.
• Согласие содержит код permission, который не поддерживается ППУ (ожидается, что ППУ опубликуют, какие конечные точки API поддерживаются).
• Массив разрешений в согласии содержит ReadTransactionsBasic, но не содержит ни ReadTransactionsCredits, ни ReadTransactionsDebits.
• Массив разрешений в согласии содержит ReadTransactionsDetail, но не содержит ни ReadTransactionsCredits, ни ReadTransactionsDebits.
• Массив разрешений в согласии содержит ReadTransactionsCredits, но не содержит ни ReadTransactionsBasic, ни ReadTransactionsDetail.
• Массив разрешений в согласии содержит ReadTransactionsDebits, но не содержит ни ReadTransactionsBasic, ни ReadTransactionsDetail.

Таблица 23. Базовые разрешения на доступ к кластерам данных

6.4.3.1.1.1. Детальные разрешения (permissions)

В этом разделе перечислены разрешения, которые являются детальными. Все остальные разрешения являются базовыми (основными).

Таблица 24. Детальные разрешения на доступ к кластерам данных

Рисунок 3. Пример применения базового и детального разрешений на доступ к кластерам данных

6.4.3.1.1.2. Отмененные записи

Если Пользователь дал разрешение ReadTransactionsCredits, то ППУ включает все кредитовые транзакции, включая отмененные дебетовые.

Если Пользователь дал разрешение ReadTransactionsDebits, то ППУ включает все дебетовые транзакции, включая отмененные кредитовые.

6.4.3.1.2. Срок действия согласия

ExpirationDateTime является необязательным полем, которое определяет срок истечения действия согласия для СПИУ на доступ к данным Пользователя в ППУ.

Поле является необязательным, поскольку согласие СПИУ на доступ к данным Пользователя может быть бессрочным. На данный момент под бессрочным доступом понимается 90 дней.

ExpirationDateTime применяется ко всем разрешениям (кластерам данных), которые находятся в массиве ресурса согласия при его авторизации.

6.4.3.1.3. Начальная/конечная дата доступа к транзакциям

TransactionToDateTime и TransactionFromDateTime определяют согласие Пользователя на доступ к транзакциям в определенный период времени. Оба поля являются необязательными, и одно поле может быть указано без другого.

ППУ может ограничить доступ к транзакциям за рамками указанного временного периода при запросах к ресурсу transactions.

6.4.3.2. Статус согласия на доступ к информации о счетах

Ресурс согласия на доступ к информации о счете имеет один из следующих кодов состояния после авторизации:

Таблица 25. Статус согласия на доступ к информации о счете

6.4.3.3. Повторная аутентификация согласия

Согласие на доступ к информации о счете является долгосрочным согласием.

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

• Согласие имеет статус Authorised.
• Указан и не истек срок действия согласия (ExpirationDateTime).

Счета, связанные с ресурсом согласия, выбираются на стороне ППУ.

ППУ может позволить Пользователю изменить выбранные счета при повторной аутентификации.

6.4.4. Отмена согласия

Пользователь может отозвать согласие на доступ к информации о счете в любой момент времени.

Пользователь может отозвать авторизацию ресурса согласия напрямую на стороне ППУ. Механизмы для этого процесса для каждого отдельно взятого ППУ могут отличаться (реализация на стороне ППУ). Если Пользователь отозвал авторизацию согласия на доступ к информации о счете на стороне ППУ, то статус ресурса account-consents меняется на Revoked.

Пользователь может потребовать от СПИУ отозвать согласие. Если согласие будет отозвано на стороне СПИУ:

- СПИУ перестает обращаться к этой конечной точке.

- СПИУ выполняет операцию DELETE для ресурса account-consent (до подтверждения отзыва согласия Пользователя) для информирования ППУ об отзыве согласия.

6.4.5. Изменения информации о счетах

Пользователь выбирает счета, к которым применяется согласие, в момент авторизации согласия.

Кроме того, список выбранных счетов может меняться из-за внешних факторов. Например:

• Счет был закрыт.
• Счет был заморожен.
• Пользователь изменяет выбранные счета во время повторной аутентификации согласия.

В таких случаях только затронутый счет удаляется из списка. ППУ не отменяет авторизацию для других счетов.

6.4.6. Информация по оценке рисков

Информация для оценки рисков будет доступна:

- В заголовках FAPI.

- В дополнительных полях, передаваемых в разделе Risk полезной нагрузки объекта JSON.

6.5. Модель данных

6.5.1. Использование метаданных для определения доступности транзакционного периода

Для API, передающих данные о транзакциях и счетах, раздел «Meta» в ответе может содержать два дополнительных поля, определяющих диапазон дат, в пределах которых находятся возвращаемые данные.

Ответы API по транзакциям и выпискам могут не содержать данные в определенном ранее диапазоне дат, потому что:

• ППУ не предоставляет данные о транзакциях и (или) выписки по счету в указанном диапазоне дат.
• Пользователь не давал согласия на получение данных о транзакциях и (или) выписки по счету в указанном диапазоне дат.

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

Для гарантии правильной интерпретации данных ППУ может предоставить даты первой и последней доступных транзакций, как часть ответа в разделе «Meta» в полях FirstAvailableDateTime и LastAvailableDateTime.

Таблица 26. Пример заполнения раздела Meta

6.5.2. Связь со справочниками и стандартами

API для получения информации о счете там, где это возможно, брались из объекта camt.O52 стандарта ISO 20022. Однако они были адаптированы под принципы архитектуры, указанные в стандарте Открытых банковских интерфейсов.

Отклонения от camt.O52 XML объекта:

• Раздел заголовка и раздел с дополнительными данными объекта camt.O52 были удалены, поскольку они не требуются для RESTful API.
• Ресурсам были присвоены идентификаторы, и для этих ресурсов были разработаны структуры полезной нагрузки, а не бралось все сообщение camt.O52, которое охватывает все ресурсы в формате отчета. Это означает, что были разработаны отдельные конечные точки и полезные нагрузки для покрытия следующих ресурсов (1-го и 2-го уровня):
• accounts
• balances
• statements
• transactions
• Для ресурсов, не включенных в стандарт ISO 20022, разрабатывались новые полезные нагрузки.
• Элемент DateTime был использован вместо сложного элемента выбора Date и DateTime (для всех конечных точек API). Если элементы времени не существуют в системах ППУ, ожидается, что элемент DateTime по умолчанию будет иметь значение формата 00:00:00+00:00.
• Структура ресурса accounts:
• Стандартизирована в соответствии со структурами счетов API переводов денежных средств.
• Содержит элемент наименования счета (задается Пользователем).
• Структура ресурса balances:
• Добавлено поле type в раздел CreditLine для учета нескольких типов кредитных линий на доступный баланс.

- Элемент DateTime был указан вместо сложного выбора Date и DateTime.

- Структура ресурса transactions включает:

- Поле «entry» переименовано в «transaction» согласно практикам международного опыта: CMA Order и PSD2.

- Элемент DateTime был указан вместо сложного выбора Date и DateTime.

- Оптимизированы наборы кодов для BankTransactionCode и ProprietaryBankTransactionCode.

- Дополнительную информацию для разделов AddressLine, MerchantDetails.

6.5.3. Ресурсы

Каждый из ресурсов задокументирован на отдельной странице. Для каждого ресурса в документации есть:

6.5.4. Справочники

6.5.4.1. Статичные справочники

AccountStatusStaticType

Таблица 27. Статус ресурса счета

AccountTypeStaticType

Таблица 28. Тип ресурса банковского счета

AccountSubTypeStaticType

Таблица 29. Подтип ресурса банковского счета

CreditDebitIndicatorStaticType

Индикатор дебетовой/кредитовой операции.

Таблица 30. Индикатор дебетовой/кредитовой операции

BalanceTypeStaticType

Таблица 31. Тип баланса

TransactionStatusStaticType

Статус записи транзакции.

Таблица 32. Статус записи транзакции

AddressTypeStaticCode

Тип адреса.

Таблица 33. Тип адреса

CardSchemeNameStaticType

Наименование схемы карты.

Таблица 34. Наименование схемы карты

CardAuthorisationTypeStaticType

Тип авторизации карты.

Таблица 35. Тип авторизации карты

6.5.4.2. Справочники ISO

Следующие справочники ISO используются в API счетов и транзакций

Таблица 36. Международные и общероссийские справочники

6.6. Согласие на доступ к счету, спецификация API — v1.2.1

6.6.1. Конечные точки

Таблица 37. Конечные точки для ресурса согласия на доступ к счету

6.6.1.1. POST /account-consents

Для конечной точки должны выполняться следующие требования:

- Конечная точка позволяет СПИУ на стороне ППУ создавать новый ресурс согласия на доступ к информации о счете (ресурс account-consents).

- ППУ создает ресурс account-consents и отвечает сообщением, содержащим его уникальный идентификатор consentId.

- Для вызова конечной точки СПИУ получает токен доступа, выданный ППУ с использованием потока Client Credentials Grant.

6.6.1.1.1. Статус согласия на доступ к информации о счете

Для получения доступа к информации о счете Пользователь аутентифицируется на стороне ППУ и авторизует ресурс account-consents.

Успешно созданный ресурс account-consents имеет следующий статус:

Таблица 38. Статус созданного ресурса согласия на доступ к счету

Таблица 39. Возможные статусы ресурса согласия на доступ к счету

6.6.1.1.2. Смена состояний статуса

6.6.1.2. GET /account-consents/{consentId}

Конечная точка позволяет СПИУ получать созданный им ресурс согласия на доступ к информации о счете.

Конечная точка позволяет СПИУ проверять статус ресурса согласия на доступ к информации о счете.

Перед вызовом конечной точки СПИУ получает токен доступа на стороне ППУ с использованием потока Client Credentials Grant.

6.6.1.3. DELETE /account-consents/{consentId}

6.6.1.4. GET /account-consents/{consentId}/retrieval-grant

6.6.2. Модель данных

6.6.2.1. Согласие на доступ к информации о счете - Запрос

6.6.2.1.1. Диаграмма UML

Рисунок 5. Диаграмма объекта Consent

6.6.2.1.2 Состав данных объекта Consent:

Таблица 40. Состав данных объекта Consent

6.6.2.2. Согласие на доступ к информации о счете - Ответ

Объект ConsentResponse используется в ответах при обращениях к следующим конечным точкам:

- GET /account-consents/ {consentId}

• POST /account-consents

6.6.2.2.1. Диаграмма UML

6.6.2.2.2 Состав данных объекта ConsentResponse:

Таблица 41. Состав данных объекта ConsentResponse

6.6.2.3. Поручение на извлечение информации о счете - Ответ

Объект RetrievalGrantResponse используется в ответах при обращениях к следующим конечным точкам:

- GET /account-consents/{consentId}/retrieval-grant

6.6.2.3.1. Диаграмма UML

6.6.2.3.2 Состав данных объекта RetrievalGrantResponse:

Таблица 42. Состав данных объекта RetrievalGrantResponse

6.6.3. Пример использования

6.6.3.1. Установка согласия на доступ к информации о счете - все разрешения (permissions)

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    POST /account-consents HTTP/1.1                                      │
│    Authorization: Bearer 5YotnWEFEqr1zDsicMWpSS                         │
│    x-fapi-auth-date: Sun, 02 May 2019 19:43:31 GMT                      │
│    x-fapi-customer-ip-address: 18.25.212.99                             │
│    x-fapi-interaction-id: 21bac548-d2de-1237-b106-880a5018460d          │
│    Content-Type: application/json                                       │
│    Accept: application/json                                             │
│    {                                                                    │
│      "Data": {                                                          │
│        "permissions": [                                                 │
│          "ReadAccountsDetail",                                          │
│          "ReadBalances ",                                               │
│          "ReadBeneficiariesDetail",                                     │
│          "ReadTransactionsCredits",                                     │
│          "ReadTransactionsDebits",                                      │
│          "ReadTransactionsDetail",                                      │
│        ],                                                               │
│        "expirationDateTime": "2019-09-03T00:00:00+00:00",               │
│        "transactionFromDateTime": "2019-05-03T00:00:00+00:00",          │
│        "transactionToDateTime": "2019-09-03T00:00:00+00:00"             │
│      },                                                                 │
│      "Risk": {}                                                         │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 43. Запрос на установку согласия на доступ к счету

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 201 Created                                                 │
│    x-fapi-interaction-id: 21bac548-d2de-1238-b106-880a5018460d          │
│    Content-Type: application/json                                       │
│    {                                                                    │
│    "Data": {                                                            │
│        "consentId": "urn-alphabank-intent-88379",                       │
│        "status": "AwaitingAuthorisation",                               │
│        "statusUpdateDateTime": "2019-05-02T00:00:00+00:00",             │
│        "creationDateTime": "2019-05-02T00:00:00+00:00",                 │
│        "permissions": [                                                 │
│          "ReadAccountsDetail",                                          │
│          "ReadBalances",                                                │
│          "ReadBeneficiariesDetail",                                     │
│          "ReadTransactionsCredits",                                     │
│          "ReadTransactionsDebits",                                      │
│          "ReadTransactionsDetail",                                      │
│        ],                                                               │
│        "expirationDateTime": "2019-08-02T00:00:00+00:00",               │
│        "transactionFromDateTime": "2019-05-03T00:00:00+00:00",          │
│        "transactionToDateTime": "2019-09-03T00:00:00+00:00"             │
│    },                                                                   │
│    "Risk": {},                                                          │
│    "Links": {                                                           │
│        "self": "https://bank.ru/open-banking/v1.0/aisp/account-consents/│
│    bank-consent-88379"                                                  │
│    },                                                                   │
│    "Meta": {                                                            │
│        "totalPages": 1                                                  │
│    }                                                                    │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 44. Ответ на установку согласия на доступ к счету

6.7. Счета, спецификация API — v1.2.1

6.7.1. Конечные точки

Таблица 45. Конечные точки ресурса счета

6.7.1.1. GET /accounts

СПИУ предоставляется полный список счетов (с идентификаторами accountId), которые были авторизованы Пользователем на стороне ППУ.

6.7.1.2. GET /accounts/{accountId}

СПИУ получает детальную информацию о счете по идентификатору accountId (который был получен при вызове конечной точки списка счетов GET /accounts).

6.7.2. Модель данных

Объект AccountResponse используется в ответах при вызове конечных точек:

• GET /accounts
• GET /accounts/{accountId}

6.7.2.1. Описание ресурсов

Ресурс представляет собой банковский счет, на котором делаются кредитовые и дебетовые записи. Каждый ресурс счета будет иметь уникальный и неизменный идентификатор accountId.

6.7.2.2. UML-диаграмма

Рисунок 8. Диаграмма объекта AccountResponse

Структуры AccountDetails и ServiceProvider были спроектированы для соответствия структурам идентификации банковского счета Плательщика и идентификации банка Плательщика при использовании СПИУ.

Наличие элемента schemeName для деталей счета и поставщика сервиса (организация, в которой открыт счет) позволяет использовать разные типы идентификаторов. Например, операции могут осуществляться по номеру счета, номеру карты, номеру телефона.

6.7.2.3. Описание доступа к кластерам данных

Состав данных ресурса зависит от разрешений (ReadAccountsBasic and ReadAccountsDetail), которые используются для доступа к ресурсу. В случае, когда доступ к ресурсу выдан с обоими разрешениями ReadAccountsBasic и ReadAccountsDetail, то более детализированные разрешения будут использоваться (ReadAccountsDetail).

При работе с ресурсом accounts выполняются правила:

• Следующие объекты не возвращаются без разрешения ReadAccountsDetail:
• AccountResponse/Data/Account/AccountDetails
• AccountResponse/Data/Account/ServiceProvider

- Если Пользователь дал разрешение ReadAccountsDetail, то:

- Объект AccountResponse/Data/Account/AccountDetails возвращается (1..n)

- Объект AccountResponse/Data/Account/ServiceProvider может возвращаться (0..1)

6.7.2.4. Состав данных объекта AccountResponse

Таблица 46. Состав данных объекта AccountResponse

6.7.3. Примеры использования

6.7.3.1. Список - разрешение на детали

Вызов конечной точки API GET /accounts осуществляется первым после авторизации согласия. Это позволяет СПИУ узнать, какие счета соответствуют авторизованному согласию Пользователя.

СПИУ получает от ППУ текущий рублевый счет Пользователя с разрешением ReadAccountsDetail. Также ППУ возвращает идентификаторы ресурсов "23489" и "31820".

После авторизации согласия на доступ к счету СПИУ осуществляет запрос получения списка счетов вызовом конечной точки API GET /accounts.

В ответе от ППУ СПИУ получает список счетов Пользователя с идентификаторами ресурсов (AccountId) "23489" и "31820", соответствующие данному им авторизационному согласию с разрешением ReadAccountsDetail.

Таблица 47. Запрос получения списка счетов

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                      │
│    x-fapi-interaction-id: 93bac548-f5fe-6780-b106-880a5018460d          │
│    Content-Type: application/json                                       │
│                                                                         │
│    {                                                                    │
│      "Data": {                                                          │
│        "Account": [                                                     │
│          {                                                              │
│            "accountId": "23489",                                        │
│            "status": "Enabled",                                         │
│            "statusUpdateDateTime": "2019-01-01T06:06:06+00:00",         │
│            "currency": "RUB",                                           │
│            "accountType": "Personal",                                   │
│            "accountSubType": "CurrentAccount",                          │
│            "accountDetails": [                                          │
│                {                                                        │
│                     "schemeName": "RU.CBR.AccountNumber",               │
│                     "identification": "40817810621234567890",           │
│                     "name": "Основной текущий счет",                    │
│                }                                                        │
│            ]                                                            │
│          },                                                             │
│          {                                                              │
│            "accountId": "31820",                                        │
│            "status": "Enabled",                                         │
│            "statusUpdateDateTime": "2019-01-01T06:06:06+00:00",         │
│            "currency": "RUB",                                           │
│            "accountType": "Personal",                                   │
│            "accountSubType": "CurrentAccount",                          │
│            "accountDetails": [                                          │
│                {                                                        │
│                     "schemeName": "RU.CBR.AccountNumber",               │
│                     "identification": "40817810621234562345",           │
│                     "name": "Дополнительный текущий счет"               │
│                }                                                        │
│            ]                                                            │
│          }                                                              │
│        ]                                                                │
│      },                                                                 │
│      "Links": {                                                         │
│        "self": "https://bank.ru/open-banking/v3.1/aisp/accounts/"       │
│      }                                                                  │
│      "Meta": {                                                          │
│        "totalPages": 1                                                  │
│      }                                                                  │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 48. Ответ получения списка счетов

6.8. Баланс, спецификация API — v1.2.1

6.8.1. Конечные точки

Таблица 49. Конечные точки ресурса баланс

6.8.1.1. GET /accounts/{accountId}/balances

Конечная точка используется для получения информации о балансе банковского счета с идентификатором accountId.

6.8.1.2. GET /balances

Конечная точка используется для получения баланса по нескольким счетам Пользователя.

Баланс передается по всем банковским счетам, которые Пользователь авторизовал с помощью согласия с балансовыми разрешениями (permissions).

6.8.2. Модель данных

Объект BalanceResponse используется в ответах от конечных точек:

- GET /accounts/{accountId}/balances

- GET /balances

6.8.3. Описание ресурсов

Данный ресурс представляет собой отображение уменьшения или увеличения баланса счета с уникальным идентификатором (accountId) в определенный момент времени.

Банковский счет может иметь несколько типов баланса (выбранные типы баланса соответствуют пересечению стандарта ISO 20022 и потребностей российского рынка банковских услуг). Если ППУ включает кредитную линию в доступный баланс (available balance), то в структуре объекта баланса будет специальный раздел для суммы и типа кредитной линии.

6.8.3.1. UML-диаграмма

Рисунок 9. Диаграмма объекта BalanceResponse

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

У баланса с типом "доступный" (available balance) может быть несколько кредитных линий, соответственно объект баланса будет содержать несколько разделов CreditLine.

Если элементы времени не существуют в системах ППУ, часть времени элемента DateTime по умолчанию будет иметь значение 00:00:00+00:00.

6.8.3.2. Описание доступа к кластерам данных

Ресурс имеет разрешение ReadBalances.

6.8.3.3. Состав данных объекта BalanceResponse

Таблица 50. Состав данных объекта BalanceResponse

6.8.4. Примеры использования

Получение баланса по идентификатору счета.

Запрос получения баланса. СПИУ выполняет к ППУ запрос информации о балансе на счете с идентификатором (accountId) "11139" вызовом конечной точки GET /accounts/11139/balances без параметров.

Ответ получения баланса. ППУ возвращает СПИУ информацию о положительном балансе на указанном счете в размере 13 430,00 рублей и наличии включенной в него кредитной линии в размере 4000,00 рублей.

Таблица 51. Запрос получения баланса

┌──────────────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                               │
│    x-fapi-interaction-id: 23bac548-d2de-4567-b106-880a5018460d                   │
│    Content-Type: application/json                                                │
│                                                                                  │
│    {                                                                             │
│      "Data": {                                                                   │
│        "Balance": [                                                              │
│          {                                                                       │
│            "accountId": "11139",                                                 │
│            "Amount": {                                                           │
│              "amount": "13430.00",                                               │
│              "currency": "RUB"                                                   │
│            },                                                                    │
│            "CreditDebitIndicator": "Credit",                                     │
│            "Type": "OpeningAvailable",                                           │
│            "DateTime": "2019-09-15T14:33:07+00:00",                              │
│            "CreditLine": [                                                       │
│              {                                                                   │
│                "Included": true,                                                 │
│                "Amount": {                                                       │
│                  "Amount": "4000.00",                                            │
│                  "Currency": "RUB"                                               │
│                },                                                                │
│                "Type": "Pre-Agreed"                                              │
│              }                                                                   │
│            ]                                                                     │
│          }                                                                       │
│        ]                                                                         │
│      },                                                                          │
│      "Links": {                                                                  │
│         "Self": "https://api.alphabank.com/open-banking/v3.1/aisp/accounts/22289/│
│    balances/"                                                                    │
│      },                                                                          │
│      "Meta": {                                                                   │
│        "TotalPages": 1                                                           │
│      }                                                                           │
│    }                                                                             │</pre>
└──────────────────────────────────────────────────────────────────────────────────┘

Таблица 52. Ответ получения баланса

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

Запрос получения баланса по списку счетов. СПИУ выполняет запрос к ППУ информации о балансе по всем счетам, к которым Пользователь авторизовал согласие вызовом конечной точки GET /balances без параметров.

Ответ получения баланса по списку счетов. ППУ возвращает СПИУ список счетов с информацией о балансе:

«accountId»: «11139» имеет положительный баланс в размере 2345,00 рублей и наличие включенной в него кредитной линии в размере 1000,00 рублей;

«accountId»: «76533» имеет отрицательный баланс в размере 257,00.

Таблица 53. Запрос получения баланса по списку счетов

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                      │
│    x-fapi-interaction-id: 23bac548-d2de-4567-b106-880a5018460d          │
│    Content-Type: application/json                                       │
│                                                                         │
│    {                                                                    │
│      "Data": {                                                          │
│       "Balance": [                                                      │
│          {                                                              │
│            "accountId": "11139",                                        │
│            "Amount": {                                                  │
│              "amount": "2345.00",                                       │
│              "currency": "GBP"                                          │
│            },                                                           │
│            "creditDebitIndicator": "Credit",                            │
│            "type": "OpeningAvailable",                                  │
│            "dateTime": "2017-04-05T10:43:07+00:00",                     │
│            "CreditLine": [                                              │
│              {                                                          │
│                "included": true,                                        │
│                "Amount": {                                              │
│                  "amount": "1000.00",                                   │
│                  "currency": "GBP"                                      │
│                },                                                       │
│                  "type": "Pre-Agreed"                                   │
│              }                                                          │
│            ]                                                            │
│          },                                                             │
│          {                                                              │
│            "AccountId": "76533",                                        │
│            "Amount": {                                                  │
│              "Amount": "257.00",                                        │
│              "Currency": "GBP"                                          │
│            },                                                           │
│              "CreditDebitIndicator": "Debit",                           │
│              "Type": "OpeningAvailable",                                │
│              "DateTime": "2019-09-15T14:22:09+00:00"                    │
│           }                                                             │
│         ]                                                               │
│      },                                                                 │
│      "Links": {                                                         │
│         "Self": "https://bank.ru/open-banking/v1.0/aisp/balances/"      │
│      },                                                                 │
│      "Meta": {                                                          │
│       "TotalPages": 1                                                   │
│      }                                                                  │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 54. Ответ получения баланса по списку счетов

6.9. Транзакции, спецификация API — v1.2.1

6.9.1. Конечные точки

Таблица 55. Конечные точки ресурса транзакция

6.9.1.1. GET /accounts/{accountId}/transactions

6.9.1.2. GET /transactions

6.9.2. Модель данных

6.9.2.1. Описание ресурсов

6.9.2.2. UML-диаграмма

Вместо элемента комплексного типа "Entrty", который используется для транзакций в стандарте ISO 20022, в Открытых банковских интерфейсах используется элемент "Transaction" комплексного типа.

Вместо элемента сложного типа выбора Date и DateTime в Открытых банковских интерфейсах используется элемент DateTime. Если элементы времени не существуют в системах ППУ, часть времени элемента DateTime по умолчанию будет иметь значение 00:00:00+00:00.

Все ППУ предоставляют поле "BookingDateTime" для разбивки на страницы и для фильтрации, поэтому поле является обязательным для пересылки. BookingDateTime - это дата, когда транзакция забронирована (или проведена) и становится неизменной, а не дата совершения транзакции.

6.9.2.3. Фильтрация

Для ограничения списка транзакций, которые возвращает ППУ, используются следующие параметры запроса при обращении к ресурсу:

Таблица 56. Фильтрация транзакций

ППУ рассматривает следующее как допустимый ввод:

• Нерабочие дни (например, воскресенье или праздничные дни) или любые другие дни, когда транзакции не регистрируются.
• Даты, выходящие за пределы диапазона, для которого информация о транзакциях предоставляется через API.
• Даты, выходящие за пределы диапазона, для которого Пользователь авторизовал согласие.
• Часовой пояс может быть включен в запрос фильтра, но игнорируется ППУ. ППУ использует локальный часовой пояс.

В вышеуказанных ситуациях ППУ возвращает данные за оставшийся действительный период, указанный фильтром.

Таблица 57. Пример фильтрации транзакций

6.9.2.4. Описание доступа к кластерам данных

Объект с данными, который ППУ возвращает, зависит от разрешений (ReadTransactionsBasic и ReadTransactionsDetail), используемых для доступа к ресурсу. В случае если к ресурсу обращаются как с помощью ReadTransactionsBasic, так и ReadTransactionsDetail, то используется самый подробный уровень ReadTransactionsDetail.

- Следующие разделы (комплексные типы) и элементы (простые типы) не возвращаются без разрешения ReadTransactionsDetail:

• TransactionResponse/Data/Transaction/transactionInformation
• TransactionResponse/Data/Transaction/Balance
• TransactionResponse/Data/Transaction/MerchantDetails
• TransactionResponse/Data/Transaction/CreditorAgent
• TransactionResponse/Data/Transaction/CreditorAccount
• TransactionResponse/Data/Transaction/DebtorAgent
• TransactionResponse/Data/Transaction/DebtorAccount

6.9.2.5. Состав данных объекта TransactionResponse

Таблица 58. Состав данных объекта TransactionResponse

6.9.3. Примеры использования

6.9.3.1. Получение списка транзакции по идентификатору счета

Запрос получения списка транзакций. СПИУ выполняет к ППУ запрос получения списка транзакций на счете с идентификатором (accountId) "87659" вызовом конечной точки GET /accounts/87659/transactions без параметров.

Ответ получения списка транзакций. ППУ возвращает СПИУ информацию о транзакциях на указанном счете (одна кредитовая транзакция "transactionId": "234" в размере 1000,00 рублей).

Таблица 59. Запрос получения списка транзакций

┌─────────────────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                                  │
│    x-fapi-interaction-id: 23bac548-d2de-7633-b106-880a5018460d                      │
│    Content-Type: application/json                                                   │
│                                                                                     │
│    {                                                                                │
│      "Data": {                                                                      │
│        "Transaction": [                                                             │
│          {                                                                          │
│            "accountId": "87659",                                                    │
│            "transactionId": "234",                                                  │
│            "transactionReference": "Ref 1",                                         │
│            "Amount": {                                                              │
│              "amount": "1000.00",                                                   │
│              "currency": "RUB"                                                      │
│            },                                                                       │
│            "creditDebitIndicator": "Credit",                                        │
│            "status": "Booked",                                                      │
│            "bookingDateTime": "2019-09-15T7:33:07+00:00",                           │
│            "valueDateTime": "2019-09-15T7:35:07+00:00",                             │
│            "transactionInformation": "Деньги от Льва",                              │
│            "BankTransactionCode": {                                                 │
│              "code": "ReceivedCreditTransfer",                                      │
│              "subcode": "DomesticCreditTransfer"                                    │
│            },                                                                       │
│            "ProprietaryBankTransactionCode": {                                      │
│              "code": "Transfer",                                                    │
│              "issuer": "AlphaBank"                                                  │
│            },                                                                       │
│            "Balance": {                                                             │
│              "Amount": {                                                            │
│                "amount": "10000.00",                                                │
│                "currency": "RUB"                                                    │
│              },                                                                     │
│              "CreditDebitIndicator": "Credit",                                      │
│            "Type": "OpeningAvailable"                                               │
│            }                                                                        │
│          }                                                                          │
│        ]                                                                            │
│      },                                                                             │
│      "Links": {                                                                     │
│        "Self": "https://bank.ru/open-banking/v3.1/aisp/accounts/87659/transactions/"│
│      },                                                                             │
│      "Meta": {                                                                      │
│        "TotalPages": 1,                                                             │
│        "FirstAvailableDateTime": "2019-09-15T00:00:00+00:00",                       │
│        "LastAvailableDateTime": "2019-09-15T21:00:00+00:00"                         │
│      }                                                                              │
│    }                                                                                │</pre>
└─────────────────────────────────────────────────────────────────────────────────────┘

Таблица 60. Ответ получения списка транзакций

Получение списка транзакций по всем авторизованным счетам Пользователя.

В данном примере транзакции приходят по всем счетам, к которым Пользователь авторизовал согласие.

Запрос получения списка транзакций. СПИУ выполняет к ППУ запрос получения списка транзакций по всем счетам, к которым Пользователь авторизовал согласие вызовом конечной точки GET /transactions без параметров.

Ответ получения списка транзакций. ППУ возвращает СПИУ список счетов с информацией о транзакциях:

«accountId»: «12345» одна кредитовая транзакция «transactionId»: «123» в размере 100,00 рублей;

«accountId»: «98765» одна дебетовая транзакция «transactionId»: «345» в размере 100,00 рублей.

Таблица 61. Запрос получения списка транзакций

┌─────────────────────────────────────────────────────────────────────────┐
<pre class="legal-pre">│    HTTP/1.1 200 OK                                                      │
│    x-fapi-interaction-id: 23bac548-d2de-7633-b106-880a5018460d          │
│    Content-Type: application/json                                       │
│                                                                         │
│    {                                                                    │
│      "Data": {                                                          │
│        "Transaction": [                                                 │
│          {                                                              │
│            "AccountId": "12345",                                        │
│            "TransactionId": "123",                                      │
│            "TransactionReference": "Ref 123",                           │
│            "Amount": {                                                  │
│              "Amount": "100.00",                                        │
│              "Currency": "RUB"                                          │
│            },                                                           │
│            "CreditDebitIndicator": "Credit",                            │
│            "Status": "Booked",                                          │
│            "BookingDateTime": "2019-09-15T10:43:07+00:00",              │
│            "ValueDateTime": "2019-09-15T10:45:22+00:00",                │
│            "TransactionInformation": "Деньги от друга",                 │
│            "BankTransactionCode": {                                     │
│              "Code": "ReceivedCreditTransfer",                          │
│              "SubCode": "DomesticCreditTransfer"                        │
│            },                                                           │
│            "ProprietaryBankTransactionCode": {                          │
│              "Code": "Transfer",                                        │
│              "Issuer": "Bank"                                           │
│            },                                                           │
│            "Balance": {                                                 │
│              "Amount": {                                                │
│                "Amount": "230.00",                                      │
│                "Currency": "RUB"                                        │
│              },                                                         │
│              "CreditDebitIndicator": "Credit",                          │
│              "Type": "OpeningAvailable"                                 │
│            }                                                            │
│          },                                                             │
│          {                                                              │
│            "AccountId": "98765",                                        │
│            "TransactionId": "345",                                      │
│            "TransactionReference": "Ref 124",                           │
│            "Amount": {                                                  │
│              "Amount": "100.00",                                        │
│              "Currency": "GBP"                                          │
│            },                                                           │
│            "CreditDebitIndicator": "Debit",                             │
│            "Status": "Booked",                                          │
│            "BookingDateTime": "2019-09-15T14:22:09+00:00",              │
│            "ValueDateTime": "2019-09-15T14:22:09+00:00",                │
│            "TransactionInformation": "Оплата коммунальных услуг",       │
│            "AddressLine": "Шлюзовая",                                   │
│            "BankTransactionCode": {                                     │
│              "Code": "IssuedCreditTransfer",                            │
│              "Subcode": "AutomaticTransfer"                             │
│            },                                                           │
│            "ProprietaryBankTransactionCode": {                          │
│              "Code": "DirectDebit",                                     │
│              "Issuer": "Bank"                                           │
│            },                                                           │
│            "Balance": {                                                 │
│              "Amount": {                                                │
│                "Amount": "1257.36",                                     │
│                "Currency": "RUB"                                        │
│              },                                                         │
│              "CreditDebitIndicator": "Debit",                           │
│              "Type": "OpeningAvailable"                                 │
│            }                                                            │
│          }                                                              │
│        ]                                                                │
│       },                                                                │
│      "Links": {                                                         │
│         "Self": "https://bank.ru/open-banking/v3.1/aisp/transactions/"  │
│      },                                                                 │
│      "Meta": {                                                          │
│        "TotalPages": 1,                                                 │
│        "FirstAvailableDateTime": "2019-09-15T00:00:00+00:00",           │
│        "LastAvailableDateTime": "2019-09-15T21:00:00+00:00"             │
│      }                                                                  │
│    }                                                                    │</pre>
└─────────────────────────────────────────────────────────────────────────┘

Таблица 62. Ответ получения списка транзакций

6.9.3.2. Отказано в доступе

СПИУ не имеет доступа для вызова конечной точки списка транзакций.

Запрос получения списка транзакций. СПИУ выполняет к ППУ запрос получения списка транзакций на счете с идентификатором (accountId) «87659» вызовом конечной точки GET /accounts/87659/transactions без параметров.

Ответ получения списка транзакций. ППУ возвращает СПИУ ошибку 403 — отказ в доступе.

Таблица 63. Запрос получения списка транзакций

Таблица 64. Ответ получения списка транзакций

6.10. Выписки, спецификация API — v1.2.1

6.10.1. Конечные точки

Таблица 65. Конечные точки ресурса выписка

6.10.1.1. POST /statements

6.10.1.2 GET /accounts/{accountId}/statements/{statementId}

6.10.1.3. GET /statements

6.10.2. Модель данных

6.10.2.1. Описание ресурсов

Данный ресурс представляет собой выписку по счету с уникальным идентификатором (accountId) в определенный момент времени или выписки по всем авторизованным Пользователем счетам в определенный момент времени.

6.10.2.2. UML-диаграмма

Рисунок 11. Диаграмма объекта StatementInitRequest

Рисунок 12. Диаграмма объекта StatementInitResponse

Рисунок 13. Диаграмма объекта StatementResponse

Все ППУ предоставляют поле «BookingDateTime» для разбивки на страницы и для фильтрации, поэтому поле является обязательным для пересылки. BookingDateTime — это дата, когда транзакция забронирована (или проведена) и становится неизменной, а не дата совершения транзакции.

6.10.2.3. Фильтрация

Для ограничения списка транзакций, которые возвращает ППУ, используются следующие параметры запроса при обращении к ресурсу:

Таблица 66. Фильтрация транзакций для выписки

ППУ рассматривает следующее как допустимый ввод:

• Нерабочие дни (например, воскресенье или праздничные дни) или любые другие дни, когда транзакции не регистрируются.

- Даты, выходящие за пределы диапазона, для которого информация о транзакциях предоставляется через API.

- Даты, выходящие за пределы диапазона, для которого Пользователь авторизовал согласие.

- Часовой пояс может быть включен в запрос фильтра, но игнорируется ППУ. ППУ использует локальный часовой пояс.

6.10.2.4. Состав данных объекта StatementInitRequest

Таблица 67. Состав данных объекта StatementInitRequest

6.10.2.5. Состав данных объекта StatementInitResponse

Таблица 68. Состав данных объекта StatementInitResponse

Таблица 69. Состав данных объекта StatementResponse

7. Динамические справочники в пространствах имен — v1.2.1

7.1. Введение

Спецификация определяет поля только с фиксированным набором возможных значений, а дальнейшее добавление значений требует изменения спецификации.

В рамках текущей версии определены новые типы данных, представляющие собой расширяемый список значений. Любые расширения этого стандартного списка значений могут быть сделаны ППУ с соответствующей документацией на их порталах для разработчиков.

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

7.2. Основы

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

7.2.1. Принципы проектирования

При добавлении собственных значений в справочники участники пространства Открытых банковских интерфейсов с ролью ППУ помещают такие значения в пространство имен, состоящее из двухбуквенного кода страны (код ISO 3166-1 Alpha-2), после которого ставится точка, после которой следует наименование организации. Например:

- RU.SBRF.Int-payments

7.2.2. Управление версиями

В данном разделе будут описываться требования к обратной совместимости при разработке последующих версий Стандарта.

7.3. Общие справочники

AccountIdentificationDynamicType

Таблица 70. Идентификатор счета

FinancialInstitutionIdentificationDynamicType

Таблица 71. Идентификатор финансового учреждения

OBRUErrorResponseErrorCode

Тип данных, который дает низкоуровневый текстовый код ошибки для ее классификации. Применяется также код ответа HTTP.

Таблица 72. Низкоуровневая классификация ошибок