| Expand | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Author | |
|---|---|
Version | 1.0 |
Status | CBUAE Internal |
Hub
...
Datasets
The OFP will provide hub-level consolidated data to Mercury.
Other than the API Log dataset (which consists of “raw” data for each API call), the datasets below will provide a “roll-up” consolidation for each day.
Raw API Log Data
Field | Description | Data type |
timestamp | Timestamp when the API call was received | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration |
URL | The generic (This is the url without any url parameters specified) | Enumeration |
HTTP Response Code Group | The response code group for the API calls
| Enumeration |
Execution time | Time in (ms) required to execute the API | Integer (ms) |
interaction id | Unique identifier for this api call | String (uuidv4) |
API Call Volume & Billing
This dataset provides the API call volumes
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration |
URL | The generic (This is the url without any url parameters specified) | Enumeration |
HTTP Response Code Group | The response code group for the API calls
| Enumeration |
Total number of calls | Count of API calls | Integer (count) |
Performance
This dataset minimum, maximum and average time taken for API calls
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration |
URL | The generic (This is the url without any url parameters specified) | Enumeration |
HTTP Response Code Group | The response code group for the API calls
| Enumeration |
Max Response time | The maximum response time from start to finish for responding to the API | integer (ms) |
Min Response time | The minimum response time from start to finish for responding to the API | integer (ms) |
Average Response time | The average response time from start to finish for responding to the API | integer (ms) |
Max LFI Response time | The maximum response time used by the LFI to responsd to OFP requests for the API | integer (ms) |
Min LFI Response time | The minimum response time used by the LFI to responsd to OFP requests for the API | integer (ms) |
Average LFI Response time | The average response time used by the LFI to responsd to OFP requests for the API | integer (ms) |
Availability
OFP Availability
Provides information of planned and unplanned downtime of the OFP.
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
Total Time | The total number of minutes in the given time period of the report | Integer (minutes) |
Total Uptime | The number of minutes of uptime in the given time period. | Integer (minutes) |
Planned Downtime | The total number of minutes that were scheduled as downtime in the time period | Integer (minutes) |
Unplanned Downtime | The percentage of time that the OFP was unavailable for use or not functioning correctly during a period when downtime was not planned | Integer (minutes) |
Total Downtime |
| Integer (minutes) |
% Uptime | The percentage of time that the OFP was available for use and functioning correctly.
| Integer (percentage) |
% Downtime | The percentage of time that the OFP was unavailable for use or not functioning correctly
| Integer (percentage) |
% Unplanned Downtime | The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime
| Integer (percentage) |
LFI Availability
Provides information of planned and unplanned downtime of the LFI’s Ozone Connect interface.
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
Total Time | The total number of minutes in the given time period of the report | Integer (minutes) |
Total Uptime | The number of minutes of uptime in the given time period. | Integer (minutes) |
Planned Downtime | The total number of minutes that were scheduled as downtime in the time period | Integer (minutes) |
Unplanned Downtime | The percentage of time that the LFI’s Ozone Connect interface was unavailable for use or not functioning correctly during a period when downtime was not planned | Integer (minutes) |
Total Downtime |
| Integer (minutes) |
% Uptime | The percentage of time that the LFI’s Ozone Connect was available for use and functioning correctly.
| Integer (percentage) |
% Downtime | The percentage of time that the LFI’s Ozone Connect was unavailable for use or not functioning correctly
| Integer (percentage) |
% Unplanned Downtime | The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime
| String |
Consents
Consent Authorisation
This report provides data on the state of new consents during the given time period.
...
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Consent Status
Field | Description | Datatype |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
Authentication channel | App, Web | Enumeration |
Consent type | The type of consent (e.g. payments, accounts) | Enumeration |
Consent State | The consent state that this record relates to | Enumeration |
Count at start | Number of consents in the given consent state at the start of the period | Integer (count) |
Count at end | Number of consents in the given consent state at the end of the period | Integer (count) |
Consent revocations
Field | Description | Datatype |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
Authentication channel | App, Web | Enumeration |
Consent type | The type of consent (e.g. payments, accounts) | EnumerationRevokedBy |
Revocation Reason Code | The reason code for the consent revocation for the given row | Enumeration |
Count | Number of consents revoked with the revocation reason code during the period | Integer (count) |
Consent users
Field | Description | Datatype |
|---|---|---|
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
Authentication channel | App, Web | Enumeration |
Consent type | The type of consent (e.g. payments, accounts) | Enumeration |
Unique User Count at Start | Total number of unique users at the start of the period associated with | Integer (count) |
Unique User Count at End | Total number of unique users at the end of the period associated with | Integer (count) |
Change in user base |
| Integer (count) |
Usage & Uptake
Account Information
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
Resource Name | Balance, Transactions, Direct debit, etc. | Enumeration |
Status | HTTP Status code for the request | No |
Total Requests | The number of combined successful / unsuccessful API requests during the selected reporting time period. | Integer (count) |
Rows | Number of “rows” of information for successful requests | Integer (count) |
...
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Additional usage reports will be added as new standards are introduced
Event Notifications
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | Datetime |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration |
Event Name | The event name that was delivered to the TPP | Enumeration |
HTTP Response Code Group | The response code group received back from the TPP
| Enumeration |
Total number of calls | Count of API calls | Integer (count) |
Hub Dashboard Pre-configured Reports
Extended Summary - https://docs.google.com/document/d/16Cm0yQRrsiYtC1G7kQ565qYgqFA5Qu3a7SdHzx8NDnY/edit
Availability & Performance Report - Report will contain Availability (planned/unplanned) of Hub, of Ozone Connector at FI side, Performance rate and error rate per endpoint.
Volume and Billing Report - Report will contain volume of API calls per endpoint
Consent Report - Report will indicate numbers of the consent types and stages (Authorised, non-auth, etc)
Consent users Report - will indicate number of the Payment Service users
Usage Report - Report Will indicate nr of requests per product (AIS (balance, transactions) PIS (single domestic, VRTP, etc.))
Notification Report - Reports which will contain information about event notifications and callbacks.
TPP Report - will indicate general numbers around TPP activity (consents, PSUs, etc)
LFI Reports
Admin Portal Dashboard Widgets
Activity Widget:
Monitors and displays current service activity, providing real-time insights into ongoing transactions and usage patterns.
Availability Widget:
Tracks the availability of services, helping users ensure that systems are operational and accessible.
Performance Widget:
Measures the performance of services by displaying metrics such as response times.
Requests Widget:
Displays the number and types of requests made to the services.
Top 10 TPPs Widget:
Lists the top 10 Third-Party Providers (TPPs) consuming the platform’s APIs. This widget helps identify the most active TPPs.
Admin Portal Pre-configured Reports
Availability & Performance Report - Report will contain Availability (planned/unplanned) of Hub, of Ozone Connector at FI side, Performance rate and error rate per endpoint.
Volume and Billing Report - Report will contain volume of API calls per endpoint
Consent Report - Report will indicate numbers of the consent types and stages (Authorised, non-auth, etc)
Consent users Report - will indicate number of the Payment Service users
Usage Report - Report Will indicate nr of requests per product (AIS (balance, transactions) PIS (single domestic, VRTP, etc.))
Notification Report - Reports which will contain information about event notifications and callbacks.
...
LFI Reports
Admin Portal Dashboard Widgets
<TODO>
This section identifies the widgets that will be provided on the admin portal dashboard to provide an overview of the current performance and state of the OFP for a given LFI
Pre-configured Reports
<TODO>
Dynamic Reports
For each of the reports below, the LFI will be able to:
...