ЦЕНТРАЛЬНЫЙ БАНК РОССИЙСКОЙ ФЕДЕРАЦИИ
СТАНДАРТ БАНКА РОССИИ
ОТКРЫТЫЕ БАНКОВСКИЕ ИНТЕРФЕЙСЫ
ПОЛУЧЕНИЕ ИНФОРМАЦИИ О СЧЕТЕ КЛИЕНТА ТРЕТЬЕЙ СТОРОНОЙ
Дата введения: 2020-10-23
2. Введение
Настоящий Стандарт содержит описание элементов, которые являются общими для всех API на получение информации о счете клиента третьей стороной.
2.1. Область применения
Настоящий Стандарт рекомендован к использованию организациями при обмене финансовыми сообщениями, связанными с получением информации о банковском счете.
Настоящий Стандарт предназначен для:
- участников получения информации о банковском счете (банки и их клиенты, а также Сторонние поставщики <1>);
--------------------------------
<1> Получают доступ к информации с согласия владельца счета.
- участников перевода денежных средств (банки и их клиенты, а также Сторонние поставщики <2>);
--------------------------------
<2> Получают доступ к счету с согласия владельца счета.
- разработчиков информационного и программного обеспечения.
Положения настоящего Стандарта применяются на добровольной основе.
По предложениям участников настоящий Стандарт может дополняться принятыми в международной практике ролями и сценариями.
2.2. Термины и определения
В настоящем Стандарте применяются следующие термины и определения:
Наименование | Описание |
API (Application Programming Interface) | Набор процедур, протоколов и инструментов для создания программных приложений. API определяет, как взаимодействуют программные компоненты |
Открытые банковские интерфейсы | Общедоступные интерфейсы прикладного программирования (API), которые предоставляют разработчикам программный доступ к финансовым данным в финансовых сервисах |
Пользователь | Физическое или юридическое лицо, являющееся плательщиком или получателем средств |
Сторонний поставщик | Юридическое лицо, использующее Открытые банковские интерфейсы для доступа к банковскому счету Пользователя в целях предоставления информационных услуг (СПИУ) или для осуществления переводов денежных средств (платежей) (СППУ) |
ППУ | Кредитная организация или ее филиал, обслуживающая счет Пользователя и публикующая Открытые банковские интерфейсы |
СПИУ | Сторонний Поставщик Информационных Услуг о банковском счете - юридическое лицо, предоставляющее Пользователю услугу получения информации о банковском счете (счетах) Пользователя |
СППУ | Сторонний Поставщик Платежных Услуг - юридическое лицо, предоставляющее Пользователю услугу по инициированию перевода денежных средств |
Среда Открытых банковских интерфейсов | Комплекс стандартов Открытых банковских интерфейсов, управление, системы, процессы, безопасность и процедуры, используемые для поддержки участников |
Участники среды Открытых банковских интерфейсов | Пользователи, банки, поставщики финансовых услуг и разработчики программного обеспечения, которые участвуют в создании и развитии среды Открытых банковских интерфейсов |
Плательщик | Пользователь, осуществляющий перевод денежных средств (либо от имени которого осуществляется перевод денежных средств) |
Получатель средств | Пользователь, в пользу которого осуществляется перевод денежных средств |
Стандарт ISO 20022 | Международный стандарт обмена электронными сообщениями между организациями финансовой отрасли |
Многофакторная аутентификация Пользователя | Аутентификация, которая основана на использовании двух или более элементов, классифицированных как знания, владение и неотъемлемость. Эти пункты являются независимыми, поскольку нарушение одного не угрожает надежности других |
Идемпотентность | Идемпотентность - это свойство объекта или операции при повторном применении операции к объекту давать тот же результат, что и при первом |
Ресурс | Ресурсом является представление любой сущности (например, перевод денежных средств, счет, транзакция) в определенном формате (например, JSON). Каждый ресурс идентифицируется посредством постоянного идентификатора, который не меняется при изменении состояния ресурса |
Полезная нагрузка | Часть пакета данных (сообщения) без служебной информации (без заголовка, битов синхронизации и т.п.). Детальное описание структуры полезной нагрузки находится в разделе 4.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 в ответах включают часовой пояс. Например:
2019-07-08T11:23:03+00:00 2019-05-03T18:13:23Z |
Таблица 3. Поля dateTime с часовым поясом
Все даты в параметрах query имеют формат dateTime стандарта ISO 8601 и не включают часовой пояс. Например:
2019-07-01T09:23:01 2019-02-07 |
Таблица 4. Поля dateTime с обрезанием часового пояса
Все даты в заголовках HTTP представлены как полные даты RFC 7231. Пример:
Mon, 26 Aug 2019 14:23:51 GMT |
Таблица 5. Формат представления полной даты
Все даты в параметрах claims JWT имеют формат number JSON, представляющего количество секунд с 1970-01-01T0:0:0Z, измеренное в GMT до текущей даты (dateTime).
//Mon, 26 Aug 2019 14:23:51 GMT 1987646700 |
Таблица 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. Заголовки запросов
Параметр header | Комментарий | POST-запрос | GET-запрос | DELETE-запрос | PUT-запрос |
x-fapi-auth-date | Время последнего входа Пользователя в систему с TTP. Значение предоставляется в виде HTTP-date, как в разделе 7.1.1.1 [RFC7231]. Например, x-fapi-auth-date: Mon, 26 Aug 2019 12:23:11 GMT | Необязательно | Необязательно | Необязательно | Не используется |
x-fapi-customer-ip-address | IP-адрес Пользователя, если Пользователь в данный момент подключен к Стороннему Поставщику (залогинен в приложении Стороннего Поставщика) | Необязательно | Необязательно | Необязательно | Не используется |
x-fapi-interaction-id | RFC4122 UID, используемый в качестве идентификатора корреляции. | Обязательно | Обязательно | Обязательно | Обязательно |
Если необходимо, то ППУ передает обратно значение идентификатора корреляции в заголовке ответа x-fapi-interaction-id |
Authorization | Стандартный заголовок HTTP. Позволяет предоставлять учетные данные серверу авторизации и (или) серверу ресурсов в зависимости от типа запрашиваемого ресурса. Для OAuth 2.0/OIDC включает в себя Basic или Bearer схемы аутентификации | Обязательно | Обязательно | Обязательно | Обязательно |
Content-Type | Стандартный заголовок HTTP. Представляет формат полезной нагрузки в запросе. | Обязательно | Не используется | Не используется | Обязательно |
Устанавливается значение application/json, за исключением конечных точек, которые поддерживают Content-Type, отличный от application/json (например, POST /file-payment-consents/ (consentId]/ file). |
Устанавливается значение application/jose+jwe для зашифрованных запросов. |
Сторонний Поставщик может предоставлять дополнительную информацию. |
Если установлено другое значение, то ППУ присылает ответ: 415 Unsupported Media Type |
Accept | Стандартный HTTP заголовок, определяющий тип контента, который требуется от сервера. | Необязательно | Необязательно | Не используется | Необязательно |
Если Сторонний Поставщик ожидает незашифрованный ответ, то он указывает явно, что только ответ в формате JSON принимается (передавая значение application/json) в качестве заголовка контента для всех конечных точек, которые отвечают в формате JSON. |
Если Сторонний Поставщик ожидает зашифрованный ответ, то он указывает явно, что принимается только ответ JWT (передавая значение application/jose+jwe) в качестве заголовка контента для всех конечных точек, которые отвечают JSON. |
Для конечных точек, которые не отвечают в формате JSON (например, GET ../statements/ (statementId]/ file), ППУ указывает доступные параметры на своем портале для разработчиков. |
Сторонний Поставщик может предоставлять дополнительную информацию. |
Если установлено недопустимое значение, то ППУ отвечает: 406 (Not Acceptable). |
Если значение не указано, по умолчанию используется application/json |
x-idempotency-key | Нестандартный HTTP-заголовок. Уникальный идентификатор запроса для поддержки идемпотентности. | Необязательно | Не используется | Не используется | Не используется |
Обязательно для запросов POST к конечным точкам идемпотентного ресурса. |
Для других запросов не указывается |
x-jws-signature | Указывает, что тело запроса подписано. | Условно (зависит от API) | Условно (зависит от API) | Условно (зависит от API) | Обязательно |
В документации на ресурсы отдельно определяется, когда это поле в заголовке указывается. |
x-customer-user-agent | В заголовке указывается тип устройства (user-agent), который использует Пользователь. | Необязательно | Необязательно | Необязательно | Необязательно |
Сторонний Поставщик может заполнить это поле значением типа устройства (user-agent), указанным Пользователем. |
Если Пользователь использует мобильное приложение Стороннего Поставщика, Сторонний Поставщик проверяет, что строка типа устройства (user-agent) отличается от строки типа устройства (user-agent) на основе браузера |
Таблица 7. Заголовки запросов
Наличие или отсутствие Пользователя определяется через заголовок x-fapi-customer-ip-address. Если указан IP-адрес Пользователя, то предполагается, что Пользователь присутствует во время взаимодействия.
Последствием этого является то, что ППУ полагаются на информацию, предоставленную СПИУ.
3.5.2. Заголовки ответов
Параметр header | Комментарий | Обязательность |
Content-Type | Стандартный параметр заголовка HTTP. Представляет формат полезной нагрузки, возвращаемой в ответе. | Обязательно |
ППУ возвращает значение Content-Type, равное application/json, в качестве заголовка для всех незашифрованных конечных точек. |
ППУ возвращает значение Content-Type, равное application/jwe, для всех зашифрованных конечных точек |
Retry-After | Параметр заголовка, указывающий время (в секундах), в течение которого Сторонний Поставщик ожидает перед повторением операции. | Необязательно |
ППУ следует включать этот заголовок вместе с ответами с кодом состояния HTTP 429 (Too Many Requests) |
x-fapi-interaction-id | RFC4122 UID, используемый в качестве идентификатора корреляции. | Обязательно |
ППУ заполняет параметр заголовка ответа x-fapi-interaction-id значением, полученным в соответствующем параметре заголовка запроса или значением UID RFC4122, если значение не было предоставлено в запросе для отслеживания взаимодействия |
x-jws-sig nature | Указывает, что тело ответа подписано. | Условно (зависит от API) |
В документации на ресурсы отдельно определяется, когда указывается это поле в заголовке |
Таблица 8. Заголовки ответов
3.6. Коды статусов HTTP
Ниже приведены коды ответов HTTP для различных методов HTTP всех конечных точек API.
Ситуация | HTTP статус | Комментарий | Для POST | Для GET | Для DELETE | Для PUT |
Запрос успешно выполнен | 200 OK | | нет | да | нет | да |
Операция создания выполнена успешно | 201 Created | Результатом операции является создание нового ресурса | да | нет | нет | нет |
Операция удаления успешно завершена | 204 No Content | | нет | нет | да | нет |
Запрос имеет неверные отсутствующее или несовместимое тело JSON, параметры URL или поля заголовка | 400 Bad Request | Запрошенная операция не будет выполнена | да | да | да | да |
Заголовок авторизации отсутствует или неверный токен | 401 Unauthorized | Операции было отказано в доступе. | да | да | да | да |
Повторная аутентификация Пользователя может привести к созданию соответствующего токена, который может быть использован |
Токен имеет неверную область действия или была нарушена политика безопасности | 403 Forbidden | Операции было отказано в доступе. | да | да | да | да |
Повторная аутентификация Пользователя может привести к созданию соответствующего токена, который может быть использован |
1. Сторонний Поставщик пытается получить ресурс, который указан в спецификации, но не реализован на стороне ППУ (например, ППУ решил не реализовывать конечную точку API статуса для внутренних запланированных платежей). | 404 (Not Found) | | да | да | да | да |
2. Сторонний Поставщик пытается получить ресурс, который не определен | | | | | | |
Сторонний Поставщик попытался получить доступ к ресурсу с помощью метода, который не поддерживается | 405 Method Not Allowed | | да | да | да | да |
Запрос содержал параметр заголовка Accept, отличный от разрешенных media types, и набор символов, отличный от UTF-8 | 406 Not Acceptable | | да | да | да | да |
Операция была отклонена, поскольку полезная нагрузка находится в формате, не поддерживаемом этим методом на целевом ресурсе | 415 Unsupported Media Type | | да | нет | нет | да |
Операция была отклонена, так как слишком много запросов было сделано в течение определенного периода времени | 429 Too Many Requests | ППУ ограничивают запросы, если они сделаны сверх их политики добросовестного использования. | да | да | да | да |
ППУ документируют свои политики добросовестного использования на своих порталах для разработчиков. |
ППУ отвечают этим статусом, если количество запросов в единицу времени было превышено. |
ППУ следует включать заголовок Retry-After в ответ, указывающий, как долго Сторонний Поставщик ожидает перед повторением операции |
Что-то пошло не так на стороне ППУ | 500 Internal Server Error | Операция не удалась | да | да | да | да |
Устаревшая версия сервиса | 503 Service Unavailable | Если API устарел и больше не поддерживается ППУ, его путь URI все еще может быть активным и принимать запросы. В этом контексте рекомендуется вернуть 503 Service Unavailable, чтобы TPP знал, что версия API находится в offline режиме | да | да | да | да |
Таблица 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 ресурса с идентификатором ресурса, который не существует, то ППУ отвечает 400 (неверный запрос), а не 404 (не найдено).
Например, если Сторонний Поставщик пытается выполнить запрос GET /payment/22289, где 22289 не является действительным paymentId, ППУ отвечает 400.
Если Сторонний Поставщик пытается получить доступ к URL-адресу ресурса, который не определен этими спецификациями (например, GET /card-accounts), то ППУ отвечает 404 (Not Found).
Если ППУ не реализовал конечную точку API, то он отвечает 404 (не найдено) для запросов к этому URL.
Таблица ниже иллюстрирует некоторые примеры предсказуемого поведения:
Ситуация | Запрос | Ответ |
Сторонний Поставщик пытается получить платеж с несуществующим идентификатором paymentId | GET /payments/1001 | 400 (Bad Request) |
Сторонний Поставщик пытается получить ресурс, который указан в спецификации, но не реализован на стороне ППУ. | GET /accounts/{accountId] /transactions | 404 (Not Found) |
Например, ППУ решил не реализовывать конечную точку API для получения транзакций по счету |
Сторонний Поставщик пытается получить ресурс, который не определен | GET /bulk | 404 (Not Found) |
Таблица 10. Возможные ситуации для ответов 400 (Bad Request) и 404 (Not Found)
3.6.2. 403 (Forbidden)
Когда Сторонний Поставщик пытается получить доступ к ресурсу, к которому у него нет разрешения, ППУ возвращает 403 (Forbidden) с необязательным телом ответа об ошибке.
Ситуация возможна в следующих случаях:
- Сторонний Поставщик использует токен доступа (access-token), который не имеет соответствующего scope для доступа к запрошенному ресурсу.
- Сторонний Поставщик попытался получить доступ к ресурсу с идентификатором, к которому у него нет доступа. Например, попытка получить доступ к GET /payments/1001, где платежный ресурс с идентификатором 1001 принадлежит другому Стороннему Поставщику.
- Сторонний Поставщик пытается получить доступ к ресурсу транзакции, а у Стороннего Поставщика нет согласия на авторизацию с правами доступа к запрашиваемому ресурсу.
- Сторонний Поставщик пытается получить доступ к ресурсу транзакции, а у Стороннего Поставщика нет согласия на авторизацию для accountId. Например, попытка получить доступ к GET /accounts/2001 или GET /accounts/2001/transactions, когда Пользователь не выбрал accountId 2001 для авторизации.
- Сторонний Поставщик пытается получить доступ к ресурсу, а ППУ решает повторно аутентифицировать Пользователя. ППУ отвечает соответствующим кодом ошибки, чтобы указать, что требуется повторная аутентификация.
3.6.3. 401 (Unauthorized)
Когда Сторонний Поставщик использует токен доступа с истекшим сроком, ППУ возвращает 401 (Unauthorized) без какого-либо сообщения об ошибке.
Ситуация возникает, если ППУ завершил срок действия токена доступа по любой из следующих причин:
1. Истек срок действия согласия.
2. Подозрительное использование токена доступа или подозрение в мошенничестве.
3. Плановая реализация многофакторной аутентификации.
Эта ошибка потенциально может быть исправлена, если Пользователь повторно пройдет аутентификацию или аутентифицируется с соответствующими разрешениями.
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. Фильтрация
ППУ обеспечивает ограниченную поддержку фильтрации для операций GET, которые возвращают множественные записи.
Параметры фильтра всегда разные для конкретного поля (полей) ресурса и следуют правилам/форматам, определенным в справочниках для ресурса.
Для параметров фильтра типа 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. Структура запроса
Структура верхнего уровня для запросов Открытых банковских интерфейсов имеет следующий вид:
┌─────────────────────────────────────────────────────────────────────────┐
│ { │
│ "Data": { │
│ ... │
│ }, │
│ "Risk": { │
│ ... │
│ } │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 11. Верхнеуровневая структура сообщений для запросов
Data
Раздел "Data" содержит данные запроса для конкретного запроса API.
Структура этого элемента отличается для каждой конечной точки API.
Risk
Раздел "Risk" содержит индикаторы риска для конкретного запроса API, предоставленного Сторонним Поставщиком.
Индикаторы риска, содержащиеся в этом элементе, могут отличаться для каждой конечной точки API.
4.2.2. Структура ответа
Структура верхнего уровня для ответов Открытых банковских интерфейсов имеет следующий вид:
┌─────────────────────────────────────────────────────────────────────────┐
│ { │
│ "Data": { │
│ ... │
│ }, │
│ "Risk": { │
│ ... │
│ }, │
│ "Links": { │
│ ... │
│ }, │
│ "Meta": { │
│ ... │
│ } │
│ │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 12. Верхнеуровневая структура сообщений для ответов
В соответствии с принципом API RESTful полный ресурс воспроизводится как часть ответа. В ответ включаются следующие дополнительные разделы высокого уровня:
- Links
- Meta
4.2.3. Структура ответа с ошибками
Структура для ответов с ошибками Открытых банковских интерфейсов имеет следующий вид:
┌─────────────────────────────────────────────────────────────────────────┐
│ { │
│ "code": "...", │
│ "id": "...", │
│ "message": "...", │
│ "Errors": [ │
│ { │
│ "errorCode": "...", │
│ "message": "...", │
│ "path": "...", │
│ "url": "..." │
│ } │
│ ] │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 13. Структура сообщений для ответов с ошибками
UML-диаграмма
Рисунок 1. UML-диаграмма для структуры ответов с ошибками
Спецификация данных
Наименование | Кратность | XPath | Подробное описание | Тип данных | Значения | Шаблон |
OBErrorResponse | | OBRUErrorResponse | Массив подробных кодов ошибок, сообщений и URL-адресов к документации для помощи в исправлении | OBRUErrorResponse | | |
code | 1..1 | OBRUErrorResponse/ Code | Высокоуровневый текстовый код ошибки, необходимый для классификации | Max40Text | | |
id | 0..1 | OBRUErrorResponse/Id | Уникальный идентификатор ошибки для целей аудита в случае неизвестных/неклассифицированных ошибок | Max40Text | | |
message | 1..1 | OBRUErrorResponse/ Message | Краткое сообщение об ошибке. Например, "что-то не так с предоставленными параметрами запроса" | Max500Text | | |
Errors | 1..n | OBRUErrorResponse/Errors | | OBRUError | | |
errorCode | 1..1 | OBRUErrorResponse/Errors/ErrorCode | Низкоуровневое текстовое описание ошибки. Например, RU.SBRF.Field.Missing | OBRUErrorResponseErrorCode | | |
message | 1..1 | OBRUErrorResponse/Errors/Message | Описание ошибки. Например, "Обязательное поле не указано". | Max500Text | | |
path | 0..1 | OBRUErrorResponse/Errors/Path | Путь к элементу с ошибкой в JSON объекте. Рекомендуемое, но не обязательное поле | Max500Text | | |
url | 0..1 | OBRUErrorResponse/Errors/Url | URL для помощи в устранении проблемы. Также через URL можно предоставлять дополнительную информацию | xs:anyURI | | |
Таблица 14. Детальное описание элементов ответа с ошибками
4.2.4. Необязательные поля
В объектах, где значение для необязательного поля не указано, поле исключается из полезной нагрузки JSON.
В объектах, где поле массива определено как имеющее значения 0..n, поле массива включается в полезную нагрузку с пустым массивом.
┌─────────────────────────────────────────────────────────────────────────┐
│ { │
│ "name": "", // Неправильно. Поле "Name" нужно исключить │
│ из полезной нагрузки. │
│ "age": 0, // Неправильно. Значение "0" не используется│
│ для указания неопределенного возраста. │
│ "creditorAccount": {}, // Неправильно. Поле "creditorAccount" │
│ нужно исключить. │
│ "balances": [] // Правильно. Таким образом передается │
│ пустой массив. │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 15. Примеры передачи необязательных полей
4.2.5. Ссылки
Раздел "Links" является обязательным и всегда будет содержать абсолютные URI для связанных ресурсов.
Ссылка "self" является обязательной.
┌─────────────────────────────────────────────────────────────────────────┐
│ "Links": { │
│ "self" "https://api.bank.ru/open-banking/v3.1/payments/58923" │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 16. Пример передачи одинарной ссылки "Self"
При передаче большого количества данных раздел Links может также содержать элементы First, Prev, Next и Last.
┌─────────────────────────────────────────────────────────────────────────┐
│ "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" │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 17. Пример передачи всех элементов раздела Links
4.2.6. Метаданные
Раздел Meta обязателен, но может быть пустым. Необязательный элемент TotalPages, указывает на количество передаваемых страниц. Если передается более одной страницы, то элемент TotalPages обязательно присутствует.
┌─────────────────────────────────────────────────────────────────────────┐
│ "Meta": { │
│ "totalPages": 6 │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 18. Пример передачи раздела Meta
5. Примеры использования
Примеры использования для отдельных API задокументированы на соответствующих страницах. В этом разделе приведены примеры использования некоторых шаблонов.
5.1. Потоки с нумерацией страниц.
Приведенный ниже пример иллюстрирует, как ППУ может возвращать многостраничный ответ.
GET /accounts/34566/transactions HTTP/1.1 Authorization: Bearer Az567AOJtyue x-fapi-auth-date: Mon, 2 Sep 2019 12:33:12 GMT x-fapi-customer-ip-address: 10.5.412.45 x-fapi-interaction-id: 11bac543-d5de-3446-b687-880a5018434d Accept: application/json |
Таблица 19. Запрос списка транзакций
┌─────────────────────────────────────────────────────────────────────────┐
│ 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" │
│ } │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 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-го уровня есть уникальный идентификатор).
Ссылка | Ресурс | Конечная точка |
Согласие на доступ к счету, спецификация API - v1.2.1 | account-consents | POST /account-consents GET /account-consents/{consentId} DELETE /account-consents/{consentId} GET /account-consents/{consentId}/ retrieval-grant |
Счета, спецификация API - v1.2.1 | accounts | GET /accounts GET /accounts{accountId} |
Баланс, спецификация API - v1.2.1 | balances | GET /accounts/{accountId}/balances GET /balances |
Транзакции, спецификация API - v1.2.1 | transactions | GET /accounts/{accountId}/transactions GET /transactions |
Выписки, спецификация API - v1.2.1 | statements | POST /statements/{accountId} GET /accounts/{accountId}/statements/{statementId} GET /statements |
Таблица 21. Конечные точки для получения информации о счете
6.4. Безопасность и контроль доступа
6.4.1. Scopes
Токен доступа, требуемый для доступа к информации о счете, имеет как минимум следующий scope:
accounts: Возможность чтения информации о счете |
Таблица 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.
Разрешение (permission) | Конечная точка | Бизнес-логика | Описание кластера данных |
ReadAccountsBasic | /accounts /accounts/{accountId} | | Возможность чтения основной информации о счете |
ReadAccountsDetail | /accounts /accounts/{accountId} | Доступ к дополнительным элементам в полезной нагрузке | Возможность чтения детальной информации о счете |
ReadBalances | /balances /accounts/{accountId}/balances | | Возможность чтения информации о балансе счета |
ReadTransactionsBasic | /transactions /accounts/{accountId}/transactions | Массив разрешений также включает один из permission: - ReadTransactionsCredits - ReadTransactionsDebits | Возможность чтения основной информации о транзакциях |
ReadTransactionsDetail | /transactions /accounts/{accountId}/transactions | Доступ к дополнительным элементам в полезной нагрузке. Массив разрешений также включает один из permission: - ReadTransactionsCredits - ReadTransactionsDebits | Возможность чтения детальной информации о транзакциях |
ReadTransactionsCredits | /transactions /accounts/{accountId}/transactions | Доступ к кредитовым транзакциям. Массив разрешений также включает один из permission: - ReadTransactionsBasic - ReadTransactionsDetail | Возможность чтения только кредитовых транзакций |
ReadTransactionsDebits | /transactions /accounts/{accountId}/transactions | Доступ к дебетовым транзакциям. Массив разрешений также включает один из permission: - ReadTransactionsBasic - ReadTransactionsDetail | Возможность чтения только дебетовых транзакций |
Таблица 23. Базовые разрешения на доступ к кластерам данных
6.4.3.1.1.1. Детальные разрешения (permissions)
В этом разделе перечислены разрешения, которые являются детальными. Все остальные разрешения являются базовыми (основными).
Код детального разрешения | Наименование элемента данных (комплексного типа) | Кратность | Путь к элементу (XPath) |
ReadAccountsDetail | Account | 0..1 | Account/Data/Account/Account |
ReadAccountsDetail | Servicer | 0..1 | Account/Data/Account/Servicer |
ReadTransactionsDetail | TransactionInformation | 0..1 | Transaction/Data/Transaction/TransactionInformation |
ReadTransactionsDetail | Balance | 0..1 | Transaction/Data/Transaction/Balance |
ReadTransactionsDetail | MerchantDetails | 0..1 | Transaction/Data/Transaction/MerchantDetails |
ReadTransactionsDetail | CreditorAgent | 0..1 | Transaction/Data/Transaction/CreditorAgent |
ReadTransactionsDetail | CreditorAccount | 0..1 | Transaction/Data/Transaction/CreditorAccount |
ReadTransactionsDetail | DebtorAgent | 0..1 | Transaction/Data/Transaction/DebtorAgent |
ReadTransactionsDetail | DebtorAccount | 0..1 | Transaction/Data/Transaction/DebtorAccount |
Таблица 24. Детальные разрешения на доступ к кластерам данных
Пример применения разрешений (permission) для кодов ReadAccountsBasic и ReadAccountsDetail выглядит следующим образом:
Рисунок 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. Статус согласия на доступ к информации о счетах
Ресурс согласия на доступ к информации о счете имеет один из следующих кодов состояния после авторизации:
N | Status | Description |
1 | Authorised | Согласие на доступ к информации о счете было успешно авторизовано |
2 | Rejected | Согласие на доступ к информации о счете было отклонено |
3 | Revoked | Согласие на доступ к информации о счете было отозвано через интерфейс ППУ |
Таблица 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.
"Meta": { "totalPages": 15, "firstAvailableDateTime": "2019-05-03T00:00:00+00:00", "lastAvailableDateTime": "2019-12-03T00:00:00+00:00" } |
Таблица 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. Ресурсы
Каждый из ресурсов задокументирован на отдельной странице. Для каждого ресурса в документации есть:
- Список конечных точек API, доступных для ресурса.
- Модель данных:
- Определение ресурса.
- UML-диаграмма, отображающая структуру ресурса (состав данных).
- Разрешения (permissions), необходимые для доступа к ресурсу.
- Спецификация данных, содержащая подробное описание элементов, кратность элементов и используемые справочные значения.
- Примеры использования
6.5.4. Справочники
6.5.4.1. Статичные справочники
AccountStatusStaticType
Статус ресурса счета.
N | Значение | Описание |
1 | Enabled | Ресурс счета доступен и может использоваться |
2 | Disabled | Ресурс счета не доступен и не может использоваться, временно или навсегда |
3 | Deleted | Ресурс счета был удален и не может использоваться |
4 | Pending | Изменения ресурса счета ожидают одобрения |
Таблица 27. Статус ресурса счета
AccountTypeStaticType
Тип ресурса банковского счета.
N | Значение | Описание |
1 | Business | Тип ресурса счетов для юридических лиц |
2 | Personal | Тип ресурса счетов для физических лиц |
Таблица 28. Тип ресурса банковского счета
AccountSubTypeStaticType
Подтип ресурса банковского счета.
N | Значение | Описание |
1 | CreditCard | Кредитные карты |
2 | CurrentAccount | Текущие счета |
3 | Loan | Потребительские кредиты |
4 | Mortgage | Ипотека |
5 | PrePaidCard | Карты предоплаты |
6 | Savings | Депозиты |
Таблица 29. Подтип ресурса банковского счета
CreditDebitIndicatorStaticType
Индикатор дебетовой/кредитовой операции.
N | Значение | Описание |
1 | Credit | Кредитовая операция |
2 | Debit | Дебетовая операция |
Таблица 30. Индикатор дебетовой/кредитовой операции
BalanceTypeStaticType
Тип баланса.
N | Значение | Описание |
1 | ClosingAvailable | Конечный остаток суммы денег, которая находится в распоряжении владельца счета на указанную дату |
2 | ClosingBooked | Остаток по счету на конец предварительно согласованного отчетного периода. Это сумма начального зарегистрированного баланса в начале периода и всех записей, зачисленных на счет в течение предварительно согласованного отчетного периода |
3 | ClosingCleared | Конечный остаток суммы денег, которая очищается в указанную дату |
4 | Expected | Баланс, состоящий из забронированных записей и отложенных позиций, известных на момент расчета, который прогнозирует остаток на конец дня, если все зарезервировано на счете и никакая другая запись не публикуется |
5 | OpeningAvailable | Начальный баланс суммы денег, которая находится в распоряжении владельца счета на указанную дату |
6 | OpeningBooked | Баланс счета в начале отчетного периода. Он всегда равен балансу из предыдущего отчета |
7 | OpeningCleared | Начальный баланс, который очищается в указанную дату |
8 | PreviouslyClosedBooked | Остаток по счету за ранее закрытый отчетный период. Начальный зарегистрированный баланс на новый период равен этому балансу |
Таблица 31. Тип баланса
TransactionStatusStaticType
Статус записи транзакции.
N | Значение | Описание |
1 | Booked | Забронировано |
2 | Pending | В ожидании, бронирование еще не произошло |
Таблица 32. Статус записи транзакции
AddressTypeStaticCode
Тип адреса.
N | Значение | Описание |
1 | Business | Юридический адрес |
2 | Registration | Адрес регистрации |
3 | DeliveryTo | Адрес доставки |
4 | Actual | Фактический адрес |
6 | Postal | Почтовый адрес |
7 | Residential | Адрес прописки |
Таблица 33. Тип адреса
CardSchemeNameStaticType
Наименование схемы карты.
N | Значение | Описание |
1 | American Express | American Express |
2 | Diners | Diners |
3 | Discover | Discover |
4 | MasterCard | MasterCard |
6 | VISA | VISA |
7 | MIR | MIR |
Таблица 34. Наименование схемы карты
CardAuthorisationTypeStaticType
Тип авторизации карты.
N | Значение | Описание |
1 | ConsumerDevice | Устройство пользователя |
2 | Contactless | Бесконтактный |
3 | None | Отсутствует |
4 | PIN | PIN код |
Таблица 35. Тип авторизации карты
6.5.4.2. Справочники ISO
Следующие справочники ISO используются в API счетов и транзакций
N | Значение | Описание |
1 | ActiveOrHistoricCurrencyCode | https://www.iso20022.org/external_code_list.page |
2 | CountryCode | Стандарт ГОСТ 7.67.2003 (ИСО 3166-1:1997), alpha-2 code - http://docs.cntd.ru/document/1200035671. Таблица 1, двухзначный буквенный код на латинице |
3 | ExternalBankTransactionFamily1Code | https://www.iso20022.org/external_code_list.page |
4 | ExternalBankTransactionSubFamily1Code | https://www.iso20022.org/external_code_list.page |
5 | Min3Max4Text | https://www.iso.org/standard/33365.html |
Таблица 36. Международные и общероссийские справочники
6.6. Согласие на доступ к счету, спецификация API - v1.2.1
6.6.1. Конечные точки
N | Ресурс | Метод HTTP | Конечная точка | Scope | Grant Type | Ключ идемпотентности | Подписание | Объект запроса | Объект ответа |
1 | account-consents | POST | POST /account-consents | accounts | Client Credentials | No | | Consent | ConsentResponse |
2 | account-consents | GET | GET /account-consents/ {consentId} | accounts | Client Credentials | No | Подписывается ответ | | ConsentResponse |
3 | account-consents | DELETE | DELETE /account-consents/ {consentId} | accounts | Client Credentials | No | | | |
4 | account-consents | GET | GET /account-consents/ {consentId}/retrieval-grant | accounts | Client Credentials | No | Подписывается ответ | | RetrievalGrantResponse |
Таблица 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 имеет следующий статус:
N | Статус | Описание |
1 | AwaitingAuthorisation | Согласие на доступ к счету ожидает авторизации |
Таблица 38. Статус созданного ресурса согласия на доступ к счету
После авторизации ресурс account-consents имеет следующие статусы:
N | Статус | Описание |
1 | Rejected | Согласие на доступ к информации о счете было отклонено |
2 | Authorised | Согласие на доступ к информации о счете успешно авторизовано |
3 | Revoked | Согласие на доступ к информации о счете было отозвано через интерфейс ППУ |
Таблица 39. Возможные статусы ресурса согласия на доступ к счету
6.6.1.1.2. Смена состояний статуса
Диаграмма состояний для статуса согласия на доступ к информации о счете имеет следующий вид:
Рисунок 4. Диаграмма состояний ресурса согласия на доступ к счету
6.6.1.2. GET /account-consents/{consentId}
Конечная точка позволяет СПИУ получать созданный им ресурс согласия на доступ к информации о счете.
Конечная точка позволяет СПИУ проверять статус ресурса согласия на доступ к информации о счете.
Перед вызовом конечной точки СПИУ получает токен доступа на стороне ППУ с использованием потока Client Credentials Grant.
6.6.1.3. DELETE /account-consents/{consentId}
Если Пользователь отзывает согласие на доступ к данным для СПИУ, СПИУ удаляет ресурс account-consents на стороне ППУ до подтверждения отзыва согласия Пользователем.
- Для этого необходимо сделать вызов DELETE ресурса account-consents.
- Перед вызовом API СПИУ получает токен доступа, выдаваемый ППУ с использованием потока Client Credentials Grant.
6.6.1.4. GET /account-consents/{consentId}/retrieval-grant
Данный ресурс создается на ресурсном сервере ППУ после авторизации согласия на получение информации о счете Пользователем (после авторизации ресурса account-consents).
Период действия поручения на извлечение (ресурса retrieval-grant) совпадает с периодом действия согласия на получение информации о счете (ресурс account-consents).
6.6.2. Модель данных
6.6.2.1. Согласие на доступ к информации о счете - Запрос
Объект Consent используется в запросе к конечной точке:
- POST /account-consents
6.6.2.1.1. Диаграмма UML
Рисунок 5. Диаграмма объекта Consent
6.6.2.1.2. Состав данных объекта Consent:
Наименование | Кратность | Путь | Описание | Тип | Значения |
Consent | | Consent | | ConsentType | |
Data | 1..1 | Consent/Data | | DataType | |
permissions | 1..n | Consent/Data/permissions | Указание типов данных доступа к счетам Пользователя. Это список доменов данных, которые были одобрены Пользователем и запрошены для авторизации на стороне ППУ | PermissionsType | ReadAccountsBasic ReadAccountsDetail ReadBalances ReadTransactionsBasic ReadTransactionsCredits ReadTransactionsDebits ReadTransactionsDetail |
expirationDateTime | 0..1 | Consent/Data/expirationDateTime | Дата и время истечения срока действия разрешений. Если он не заполнен, разрешения будут с открытой датой | ISODateTime | |
transactionFromDateTime | 0..1 | Consent/Data/transactionFromDateTime | Дата и время начала периода запроса транзакции. Если он не заполнен, дата начала будет с открытой датой, и данные будут возвращены с самой ранней из доступных транзакций | ISODateTime | |
transactionToDateTime | 0..1 | Consent/Data/transactionToDateTime | Дата и время окончания периода запроса транзакции. Если он не заполнен, дата окончания будет открытой, и данные будут возвращены в самую последнюю доступную транзакцию | ISODateTime | |
Risk | 1..1 | Consent/Risk | Risk направляется инициирующей стороной в ППУ. Используется для указания дополнительной информации для скоринга рисков | RiskType | |
Таблица 40. Состав данных объекта Consent
6.6.2.2. Согласие на доступ к информации о счете - Ответ
Объект ConsentResponse используется в ответах при обращениях к следующим конечным точкам:
- GET /account-consents/ {consentId}
- POST /account-consents
6.6.2.2.1. Диаграмма UML
Рисунок 6. Диаграмма объекта ConsentResponse
6.6.2.2.2. Состав данных объекта ConsentResponse:
Наименование | Кратность | Путь | Описание | Тип | Значения |
ConsentResponse | | ConsentResponse | | ConsentResponseType | |
Data | 1..1 | ConsentResponse/Data | | DataConsentResponseType | |
consentId | 1..1 | ConsentResponse/Data/consentId | Уникальный идентификатор, предназначенный для идентификации ресурса согласия на доступ к счету | Max128Text | |
creationDateTime | 1..1 | ConsentResponse/Data/creationDateTime | Дата и время создания ресурса | ISODateTime | |
status | 1..1 | ConsentResponse/Data/status | Статус согласия | ConsentStatusType | Authorised AwaitingAuthorisation Rejected Revoked |
statusUpdateDateTime | 1..1 | ConsentResponse/Data/statusUpdateDateTime | Дата и время обновления статуса ресурса | ISODateTime | |
permissions | 1..n | ConsentResponse/Data/permissions | Указание типов данных доступа к счетам Пользователя. Это список доменов данных, которые были одобрены Пользователем и запрошены для авторизации на стороне ППУ | PermissionsType | ReadAccountsBasic ReadAccountsDetail ReadBalances ReadTransactionsBasic ReadTransactionsCredits ReadTransactionsDebits ReadTransactionsDetail |
expirationDateTime | 0..1 | ConsentResponse/Data/expirationDateTime | Дата и время истечения срока действия разрешений. Если он не заполнен, разрешения будут с открытой датой | ISODateTime | |
transactionFromDateTime | 0..1 | ConsentResponse/Data/transactionFromDateTime | Дата и время начала периода запроса транзакции. Если он не заполнен, дата начала будет с открытой датой, и данные будут возвращены с самой ранней из доступных транзакций | ISODateTime | |
transactionToDateTime | 0..1 | ConsentResponse/Data/transactionToDateTime | Дата и время окончания периода запроса транзакции. Если он не заполнен, дата окончания будет открытой, и данные будут возвращены в самую последнюю доступную транзакцию | ISODateTime | |
Risk | 1..1 | ConsentResponse/Risk | Risk направляется инициирующей стороной на сторону ППУ. Используется для указания дополнительной информации для скоринга рисков | RiskType | |
Таблица 41. Состав данных объекта ConsentResponse
6.6.2.3. Поручение на извлечение информации о счете - Ответ
Объект RetrievalGrantResponse используется в ответах при обращениях к следующим конечным точкам:
- GET /account-consents/{consentId}/retrieval-grant
6.6.2.3.1. Диаграмма UML
Рисунок 7. Диаграмма объекта RetrievalGrantResponse
6.6.2.3.2. Состав данных объекта RetrievalGrantResponse:
Наименование | Кратность | Путь | Описание | Тип | Значения |
RetrievalGrantResponse | | RetrievalGrantResponse | | RetrievalGrantResponseType | |
Data | 1.1 | RetrievalGrantResponse/Data | | DataConsentResponseType | |
consentId | 0..1 | RetrievalGrantResponse/Data/consentId | Уникальный идентификатор, предназначенный для идентификации ресурса согласия на доступ к счету | Max128Text | |
retrievalGrantId | 1.1 | RetrievalGrantResponse/Data/retrievalGrantId | Уникальный идентификатор, предназначенный для идентификации ресурса поручения на доступ к счету | Max128Text | |
documentType | 1..1 | RetrievalGrantResponse/Data/documentType | Тип документа. Пока передается фиксированное значение "Поручение на извлечение" | Max128Text | |
OGRN | 0..1 | RetrievalGrantResponse/Data/OGRN | ОГРН Стороннего поставщика. Поле может не передаваться, поскольку у Стороннего поставщика известен его ОГРН | Max13Text | |
creationDateTime | 1..1 | RetrievalGrantResponse/Data/creationDateTime | Дата и время создания ресурса | ISODateTime | |
expirationDateTime | 0..1 | RetrievalGrantResponse/Data/expirationDateTime | Дата и время истечения срока действия поручения на извлечение информации о счете. Дата и время совпадают с датой и временем для согласия на получение информации о счете | ISODateTime | |
Таблица 42. Состав данных объекта RetrievalGrantResponse
6.6.3. Пример использования
6.6.3.1. Установка согласия на доступ к информации о счете - все разрешения (permissions)
СПИУ создает на стороне ППУ ресурс согласия с разрешениями на доступ к кластерам данных "ReadAccountsDetail", "ReadBalances", "ReadBeneficiariesDetail", "ReadTransactionsCredits",
"ReadTransactionsDebits", "ReadTransactionsDetail" со сроком действия до 3 сентября 2019 года. Также задается диапазон дат с 3 мая 2019 года по 3 сентября 2019 года, в рамках которого доступны транзакции Пользователя.
Все параметры задаются Пользователем заранее на стороне СПИУ.
СПИУ создает на стороне ППУ ресурс согласия на доступ к информации о счете с разрешениями кластерных данных "ReadAccountsDetail", "ReadBalances", "ReadBeneficiariesDetail", "ReadTransactionsCredits", "ReadTransactionsDebits", "ReadTransactionsDetail" со сроком действия до 3 сентября 2019 года вызовом конечной точки API POST /accounts-consent.
В ответ от ППУ СПИУ получает согласие с идентификатором согласия (consentId) "urn-alphabank-intent-88379" со статусом ожидания авторизации "AwaitingAuthorisation" и с перечислением предоставленных ресурсов и сроков, в рамках которого доступны транзакции Пользователя.
┌─────────────────────────────────────────────────────────────────────────┐
│ 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": {} │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 43. Запрос на установку согласия на доступ к счету
┌─────────────────────────────────────────────────────────────────────────┐
│ 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 │
│ } │
│ } │
└─────────────────────────────────────────────────────────────────────────┘
Таблица 44. Ответ на установку согласия на доступ к счету
6.7. Счета, спецификация API - v1.2.1
6.7.1. Конечные точки
N | Ресурс | Метод HTTP | Конечная точка | Scope | Grant Type | Ключ идемпотентности | Параметры | Объект запроса | Объект ответа |
1 | accounts | GET | GET /accounts | accounts | Authorization Code | Нет | Нумерация страниц | | AccountResponse |
2 | accounts | GET | GET /accounts/{accountId} | accounts | Authorization Code | Нет | | | AccountResponse |
Таблица 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
Наименование | Кратность | Путь | Описание | Тип | Значения | Шаблон |
AccountResponse | | AccountResponse | | AccountResponseComplexType | | |
Data | 1..1 | AccountResponse/Data | | DataAccountResponseComplexType | | |
Account | 0..N | AccountResponse/Data/Account | Комплексный объект | AccountComplexType | | |
accountId | 1..1 | AccountResponse/Data/Account/accountId | Уникальный и неизменный идентификатор, используемый для идентификации ресурса "accounts" | Max40Text | | |
status | 0..1 | AccountResponse/Data/Account/status | Статус счета в форме кода | AccountStatusStaticType | Enabled Disabled Deleted Pending | |
statusUpdateDateTime | 0..1 | AccountResponse/Data/Account/statusUpdateDateTime | Дата и время изменения статуса счета. Используется стандарт ISO 8601 | ISODateTime | | YYYY-MM-DDThh:mm:ss+03:00 |
currency | 1..1 | AccountResponse/Data/Account/currency | Валюта ведения счета. Используется стандарт ISO 4217 | ActiveOrHistoricCurrencyCode | | |
