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

Редакція OpenBanking Ukraine

Цей розділ надає технічний огляд моделі передачі даних для AIS, включно з переліком атрибутів, їхнім кодуванням, розташуванням у повідомленні (HTTP-параметри, заголовки, тіло) та використанням у запитах/відповідях.

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

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

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

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

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

Примітки

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

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

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

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

Вимоги до request/response (позитивні відповіді)

Елемент даних	Кодування атрибуту	Path	Header	Body	QWAC	Read Data Req	Read Data Resp
Provider Identification		x				m
TPP Registration Number					x	m
TPP Name					x	m
TPP Role					x	m
TPP National Competent Authority					x	m
Request Identification	X-Request-ID		x			m	m
Consent ID	Consent-ID		x			m
Access Token (from optional OAuth2)	Authorization		x			c
API Client Signing Electronic Signature	x-jws-signature		x			c
Further signature related data	Digest		x			c
PSU Message Information	psuMessage			x			o
API Client Message Information	apiClientMessages			x			o
IP Address PSU	PSU-IP-Address		x			c
PSU IP Port	PSU-IP-Port		x			o
Further PSU related Information	PSU-Accept		x			o
	PSU-Accept-Charset		x			o
	PSU-Accept-Encoding		x			o
	PSU-Accept-Language		x			o
	PSU-Http-Method		x			o
	PSU-Device-ID		x			o
PSU User Agent	PSU-User-Agent		x			o
GEO Information	PSU-Geo-Location		x			o
PSU Account	accountId	x				c
PSU Account	account			x			m
Date From	dateFrom			x		c
Date To	dateTo			x		c
Booking Status	bookingStatus			x		o
With Balance Flag	withBalance			x		o
PSU Account List	Array of accountDetails			x			c
PSU Account Details	accountDetails			x			c
Balances	balances			x			c
Transactions	transactions			x			c