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

Редакція OpenBanking Ukraine

Цей розділ описує, як отримати вміст об’єкта згоди (включно зі статусом) або окремо статус згоди за її ідентифікатором.

6.1. Отримання вмісту об’єкту згоди

Виклик

GET /v2/consents/account-access/{consentId}

Повертає вміст об’єкта згоди категорії account-access, включаючи статус згоди.

Path parameters

Атрибут	Тип	Опис
consentId	String	ID відповідного об’єкта згоди, отриманого у Establish Consent Request

Query parameters

Немає параметрів запиту.

Request headers

Атрибут	Тип	Умова	Опис
X-Request-ID	UUID	Mandatory	ID запиту, унікальний для виклику, визначений стороною-ініціатором.
Authorization	String	Conditional	Міститься, лише якщо SCA на основі OAuth2 було виконано у відповідній транзакції згоди або якщо OAuth2 використовувався на попередньому кроці.

Request body

Немає.

Response

Response code: 200

Response headers

Атрибут	Тип	Умова	Опис
X-Request-ID	UUID	Mandatory	ID запиту, унікальний для виклику, визначений стороною-ініціатором.

Response body

Атрибут	Тип	Умова	Опис
access	Extended Account Access	Mandatory	В цих атрибутах передаються значення, які були вказані при створенні згоди.
consentType	Consent Type	Mandatory	-
recurringIndicator	Boolean	Mandatory	-
validTo	ISODate	Mandatory	-
frequencyPerDay	Integer	Mandatory	-
consentStatus	Consent Status	Mandatory	Статус ресурсу згоди.

Примітка: для категорії згоди account-access, ASPSP надає всі посилання на рахунок і права доступу за згодою після позитивного проходження SCA PSU в межах вказаного об’єкта згоди. Крім того, додаються гіперпосилання на всі рахунки, які наведені у згоді. Таким чином, TPP може зчитувати з об’єкта згоди всі відповідні відомості з рахунку як ярлик для отримання прямого доступу до всіх доступних рахунків.

Приклад

{
  "access": {
    "payments": [
      {
        "account": {
          "iban": "UA233077700000026205011558000",
          "currency": "UAH"
        },
        "rights": [
          "accountDetails",
          "balances",
          "transactions"
        ]
      }
    ]
  },
  "consentType": "detailed",
  "recurringIndicator": true,
  "frequencyPerDay": 3,
  "validTo": "2024-05-25",
  "consentStatus": "received"
}

6.2. Отримання статусу згоди

Виклик

GET /v2/consents/{consent-category}/{consentId}/status

Отримує статус згоди.

Path parameters

Атрибут	Тип	Опис
consent-category	String	Тип згоди. На даний момент підтримується тип згоди: `account-access`.
consentId	String	Ідентифікатор згоди, присвоєний створеному ресурсу.

Query parameters

Немає.

Request headers

Атрибут	Тип	Умова	Опис
X-Request-ID	UUID	Mandatory	ID запиту, унікальний для виклику, визначений стороною-ініціатором.
Authorization	String	Conditional	Міститься, лише якщо використовувався метод SCA OAuth2 у відповідній транзакції згоди або якщо OAuth2 використовувався на попередньому кроці.

Request body

Немає.

Response

Response code: 200

Response headers

Атрибут	Тип	Умова	Опис
X-Request-ID	UUID	Mandatory	ID запиту, унікальний для виклику, визначений стороною-ініціатором.

Response body

Атрибут	Тип	Умова	Опис
consentStatus	Consent Status	Mandatory	Статус життєвого циклу згоди.
psuMessage	Max500Text	Optional	Текст для PSU. Для Decoupled SCA рекомендовано надсилати обов’язково.

Приклад

{
  "consentStatus": "received",
  "psuMessage": "Перейдіть в додаток А24 для підтвердження згоди."
}