...
Author | |
|---|---|
Version | 1.0 |
Status | CBUAE Internal |
1. 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.
1.1 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) |
1.2 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) |
1.3 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) |
1.4 Availability
1.4.1 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) |
1.4.2 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 |
1.5 Consents
1.5.1 Consent Authorisation
This report provides data on the state of new consents during the given time period.
...
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1.5.2 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) |
1.5.3 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) | Enumeration |
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) |
1.5.4 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) |
1.6 Usage & Uptake
1.6.1 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) |
1.6.2 Payments
Payment Volume
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 |
Payment type | Payments SIP, Payments VRP, etc. | Enumeration |
Currency | The currency of the payment executed. | String |
POST Request Count | The number of payments API This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc | Integer (count) |
Successful POST Request Count | The number of successful payments API | Integer (count) |
Failed POST Request Count | The number of failed payments API | Integer (count) |
Completed Payment Count | The number of payments that have been completed (fully settled) | Integer (count) |
Failed Payment Count | The number of payments that failed to be settled | Integer (count) |
Incomplete Payment Count | The number of payments that are incomplete (neither failed, nor settled) | Integer (count) |
...
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 |
Payment type | Payments SIP, Payments VRP, etc. | Enumeration |
Currency | The currency of the payment executed. | String |
Average API Call Response Time | The average time in ms taken by the payment API call | Integer (ms) |
Maximum API Call Response Time | The maximum time in ms taken by the payment API call | Integer (ms) |
Minimum API Call Response Time | The minimum time in ms taken by the payment API call | Integer (ms) |
Average Payment processing time | The average time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI | Integer (ms) |
Maximum Payment processing time | The maximum time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI | Integer (ms) |
Minimum Payment processing time | The minimum time in ms taken between the creation of the payment record on the OFP and the receipt of the final settlement confirmation or failure event from the LFI | Integer (ms) |
1.6.3 Usage - Other
Additional usage reports will be added as new standards are introduced
1.7 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) |
2. LFI Reports
2.1 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
2.2 Pre-configured Reports
<TODO>
2.3 Dynamic Reports
For each of the reports below, the LFI will be able to:
select the time range for which they want to generate the report
Select the time period over which they want to “roll up” the information
Select the fields they want to group the information by
Select the fields they want to filter the information by
2.3.1 API Call Volume & Billing
This dataset provides the API call volumes.
Field | Description | Datatype | Filter | Group |
|---|---|---|---|---|
Period Start | Date-time when the rollup period started | Datetime | NA | NA |
Period End | Date-time when the rollup period ended | Datetime | NA | NA |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String | Yes | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String | Yes | Yes |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration | Yes | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes | Yes |
URL | The generic (This is the url without any url parameters specified) | Enumeration | Yes | Yes |
HTTP Response Code Group | The response code group for the API calls
| Enumeration | Yes | Yes |
Total number of calls | Count of API calls | Integer (count) | No | No |
2.3.2 Performance
This dataset minimum, maximum and average time taken for API calls
Field | Description | Datatype | Filter | Group |
|---|---|---|---|---|
Period Start | Date-time when the rollup period started | Datetime | NA | NA |
Period End | Date-time when the rollup period ended | Datetime | NA | NA |
LFI Org Id | Identifiers (such as name, orgId) of the Licensed Financial Institution | String | Yes | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) of the TPP | String | Yes | Yes |
API Set | Group of APIs (e.g. account information, payments, vrp etc.) | Enumeration | Yes | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes | Yes |
URL | The generic (This is the url without any url parameters specified) | Enumeration | Yes | Yes |
HTTP Response Code Group | The response code group for the API calls
| Enumeration | Yes | Yes |
Max Response time | The maximum response time from start to finish for responding to the API | integer (ms) | No | No |
Min Response time | The minimum response time from start to finish for responding to the API | integer (ms) | No | No |
Average Response time | The average response time from start to finish for responding to the API | integer (ms) | No | No |
Max LFI Response time | The maximum response time used by the LFI to responsd to OFP requests for the API | integer (ms) | No | No |
Min LFI Response time | The minimum response time used by the LFI to responsd to OFP requests for the API | integer (ms) | No | No |
Average LFI Response time | The average response time used by the LFI to responsd to OFP requests for the API | integer (ms) | No | No |
3. TPP Reports
The following reports will be made available through an API for TPPs
3.1 API Call Volume & Billing
This dataset provides the daily API call volumes
Field | Description | Data type |
Datetime | The date for which this report applies | 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) |
3.2 Performance
This dataset provides minimum, maximum and average time taken for API calls for a given day
...