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

Редакція OpenBanking Ukraine

Цей розділ надає технічний огляд моделі даних для Consent API та показує, де саме (path, query, header, body тощо) розміщуються атрибути, а також у яких запитах/відповідях вони використовуються.

Пояснення стовпців

У таблиці нижче наведено:

Елемент даних — назва елементу даних.
Кодування атрибуту — кодування атрибуту (наприклад, назва HTTP-заголовка або параметра).
Розташування — де розміщуються відповідні елементи даних: HTTP-параметри тощо. Для параметрів HTTP path включає host, порт і path API.
Використання — використання елементів даних у request або response.

У цьому розділі наведений перелік обов’язкових атрибутів та деяких умовних/опціональних атрибутів. Повний перелік атрибутів можна знайти в YAML-файлі специфікації.

Вимоги до response поширюються лише на позитивні відповіді (тобто з HTTP-кодом 2xx). Інформація про помилку передається відповідно до розділу 5 Протоколу функцій та заходів безпеки.

Примітки

ПРИМІТКА: усі параметри header, які підтримуються для ініціювання транзакції, визначено в Протоколі функцій та заходів безпеки. Ці параметри застосовуються до всіх Transaction Initiation Requests (транзакції, які потребують авторизації в рамках API відкритого банкінгу) і наведені тут для кращої читабельності.
Примітка: функції на кшталт GET .../{consentId} і Cancellation Request не охоплюються таблицею нижче.
Примітка: опціональні та умовні атрибути у request та response, якщо їх значення відсутнє (дорівнює null), не передаються.

Умовні позначення в таблиці

x — місцезнаходження атрибуту;
m — обов’язковий параметр;
o — опціональний (не обов’язковий) параметр;
c — умовний параметр (умова зазначається у описах атрибутів API).

Елемент даних	Кодування атрибуту	Path	Header	Body	QWAC	Establ. Cons. Req.	Establ. Cons. Resp.	Cons. Status Req.	Cons. Status Resp.
Provider Identification		x					m		m
TPP Registration Number					x		m		m
TPP Name					x		m		m
TPP Role					x		m		m
TPP National Competent Authority					x		m		m
Request Identification	`X-Request-ID`		x			m	m	m	m
Resource ID	`consentId`	x					m
Resource ID			x					m
Access Token (from optional OAuth2)	`Authorization`		x			c		c
API Client Signing Certificate Data	`Client-Signature-Certificate`		x			c		c
API Client Signing Electronic Signature	`Signature`		x			c		c
Further signature related data	`Digest`		x			c		c
ASPSP-SCA-Approach	`ASPSP-SCA-Approach`		x				c
ASPSP Multiple Consents Support	`ASPSP-Multiple-Consent-Support`		x				c
Transaction Status	`consentStatus`			x			m		m
SCA Status	`scaStatus`			x					o
PSU Message Information	`psuMessage`			x			o		o
API Client Message Information	`apiClientMessages`			x			o		o
PSU Identification	`PSU-ID`		x			c
PSU Identification Type	`PSU-ID-Type`		x			c
Corporate Identification	`PSU-Corporate-ID`		x			c
Corporate Type	`PSU-Corporate-IDType`		x			c
IP Address PSU	`PSU-IP-Address`		x			m		o
PSU IP Port	`PSU-IP-Port`		x			o		o
Further PSU related Information	`PSU-Accept`		x			o		o
	`PSU-Accept-Charset`		x			o		o
	`PSU-Accept-Encoding`		x			o		o
	`PSU-Accept-Language`		x			o		o
	`PSU-Http-Method`		x			o		o
	`PSU-Device-ID`		x			o		o
PSU User Agent	`PSU-User-Agent`		x			o		o
GEO Information	`PSU-Geo-Location`		x			o		o
Redirect URL ASPSP	`_links.scaRedirect`			x			c
SCA Approach Preference	`Client-SCA-Approach-Preference`		x			o
Redirect URL TPP	`Client-Redirect-URI`		x			c
Authorisation Preference	`Client-Explicit-Authorisation-Preferred`		x			o
Client Notification URI	`Client-Notification-URI`		x			o
Client Notification Content Preference	`Client-Notification-Content-Preferred`		x			o
Client Brand Information	`Client-Brand-Logging-Information`		x			o
PSU Account Access	`access`			x		m
Consent Type	`consentType`
Validity Period	`validTo`			x		m
Frequency	`frequencyPerDay`			x		m
Recurring Indicator	`recurringIndicator`			x		m

Пояснення стовпців

Примітки

Умовні позначення в таблиці

Матриця атрибутів Consent API