Consent API

Структура згоди, життєвий цикл consent, статуси, скасування та пов'язані use cases.

Цей розділ специфікації Consent API (Версія 2.1) описує створення та використання згоди PSU на надання AISP доступу до інформації по рахунку(ах) у ASPSP. Документ є українською адаптацією специфікації Berlin Group, підготовленою Open API Group (EMA Association), та поширюється за ліцензією CC BY-ND 4.0.

У розділі висвітлено такі ключові теми:

  1. Загальна інформація про згоду: призначення consent, базова структура та основні поняття.
  2. Прикладний рівень та керівні принципи: практичні вимоги до реалізації та взаємодії сторін.
  3. Огляд передачі даних: як відбувається обмін даними в рамках згоди.
  4. Життєвий цикл consent:
    • встановлення згоди PSU (Establish Consent);
    • отримання та інтерпретація статусу (Consent Status);
    • відкликання/скасування згоди (Cancellation of a Consent).
  5. Use cases: типові сценарії надання, перегляду та відкликання згоди (в застосунку AISP та/або ASPSP).
  6. Примітки, посилання та додатки, включно з прикладом тест-кейсів для контрактного тестування.

Сторінки розділу

1. Вступ

Документ описує адаптований переклад Berlin Group Consent API для Open Banking Ukraine та фіксує обов’язкові параметри (рахунки, consent type, SCA, старт авторизації) і сценарії використання для створення, перегляду та відкликання згод.

2. Загальна інформація про згоду

Згода PSU у відкритому банкінгу: призначення, види (разова/множинна; явна/неявна), категорія “account-access” та використання consentId як токена згоди.

3. Прикладний рівень: керівні принципи

Методи доступу до Consent API, правила для мультивалютних рахунків та опис статусів згоди (consentStatus) протягом ініціації та життєвого циклу.

4. Огляд передачі даних

Описано модель даних Consent API, умовні позначення та матрицю атрибутів для запитів/відповідей Establish Consent і Consent Status.

5. Встановлення згоди PSU на отримання інформації по рахунку (Establish Consent)

Опис POST /v2/consents/account-access для створення ресурсу згоди на доступ до інформації по рахунку PSU, включно з опціями для recurringIndicator, параметрами запиту/відповіді та прикладами JSON.

6. Отримання статусу згоди (Consent Status)

Описано два GET-виклики: отримання вмісту об’єкта згоди категорії account-access (включно зі статусом) та отримання лише статусу згоди.

7. Відкликання згоди PSU на отримання інформації по рахунку

DELETE /v2/consents/{consent-category}/{consentId} — припиняє дію згоди (HTTP 204).

8. Use Case 1. Надання згоди PSU на отримання AISP інформації по рахунку PSU у ASPSP

Опис сценарію надання згоди PSU на доступ AISP до інформації по рахунку в ASPSP із варіантами Redirect SCA та Decoupled SCA, включно з кроками основного та альтернативних сценаріїв.

9. Use Case 2. Перегляд PSU згод на отримання інформації по рахунку PSU у ASPSP

Опис Use Case 2 для Consent API: перегляд PSU згод на отримання інформації по рахунку PSU у ASPSP.

10. Use Case 3. Відкликання PSU згоди на отримання AISP інформації по рахунку PSU у ASPSP (у платіжному застосунку AISP)

Описує кроки відкликання чинної згоди AISP (статус valid) через виклик DELETE /v2/consents/{consent-category}/{consentId} та встановлення статусу terminatedByTpp.

11. Use Case 4. Відкликання PSU згоди на отримання AISP інформації по рахунку PSU у ASPSP (у платіжному застосунку ASPSP)

Use Case 4 описує, як PSU у платіжному застосунку ASPSP ініціює відкликання діючої згоди на AISP доступ, внаслідок чого статус згоди змінюється на revokedByPsu.

12. Примітки

Примітки щодо перевірок статусів згоди, строків дії, валідності redirect-лінку для SCA, використання базових/комерційних API в межах однієї згоди та поведінки згоди при закритті рахунку.

13. Документи і посилання

Джерела та довідкові матеріали, використані під час підготовки специфікації.

Додатки

Перелік додатків: діаграми активностей для сценаріїв надання/відкликання згоди та приклад тест-кейсів для контрактного тестування.

Додаток 5. Приклад тест-кейсів для контрактного тестування

Набір прикладів тест-кейсів для контрактного тестування Consent API: створення згоди, авторизація ресурсу згоди, перевірка статусу та відкликання згоди.