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

Редакція OpenBanking Ukraine

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

Пояснення стовпців таблиці

У таблиці нижче стовпці означають:

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

Умовні позначення

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

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

Вимоги до request та response

Вимоги, наведені у таблиці, застосовуються лише до позитивних відповідей (HTTP 2xx). У разі помилки загальна інформація про помилку надається разом із кодом відповіді HTTP 40x або 50x.

Примітка: усі параметри header, які підтримуються для ініціювання транзакції, визначено в Протоколі функцій та заходів безпеки. Ці параметри застосовуються до всіх Transaction Initiation Requests, тобто транзакцій, які потребують авторизації в рамках API відкритого банкінгу, і наведені тут для кращої читабельності.

Примітка: опціональні та умовні атрибути у request та response, якщо їх значення відсутнє (дорівнює null), — не передаються.

Огляд атрибутів та їх розташування

Елемент даних	Код атрибуту	Path	Header	Body	QWAC	Init Req.	Init Resp.	Stat. Req.	Stat. Resp.
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 (received from the ASPSP server)	`paymentId`	x					m
Transaction Fees	`transactionFees`			x			o
Transaction Fee Indicator	`transactionFeeIndicator`			x			o
Access Token (from optional OAuth2)	`Authorization`		x			c		c
Further signature related data	`Digest`		x			c		c
API Client Electronic Signature	`x-jws-signature`		x			c		c
Transaction Status	`transactionStatus`			x			m		m
Funds Availability Flag	`fundsAvailable`			x					c
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		c
Corporate ID Type	`PSU-Corporate-ID-Type`		x			c		c
IP Address PSU			x			m		o
IP Port PSU	`PSU-IP-Port`		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
ASPSP-SCAApproach	`ASPSP-SCA-Approach`		x				c
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
SCA Approach Preference	`Client-SCA-ApproachPreference`		x			o
Redirect URI TPP	`Client-Redirect-URI`		x			c
	`Client-Nok-Redirect-URI`		x			o
Authorisation Preference	`Client-ExplicitAuthorisation-Preferred`		x			o
Client Notification URI	`Client-Notification-URI`		x			o
Client Notfication Content Preference	`Client-NotificationContent-Preferred`		x			o
Client Brand Information	`Client-Brand-LoggingInformation`		x			o
Payment Product	`payment-product`	x				m