...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Id | Identifier of the TPP | String | |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc). | Enumeration | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes |
URL | The generic (This is the url without any url parameters specified.) | Enumeration | Yes |
Total Time | The total number of minutes in the given time period of the report. | Integer (minutes) | No |
Total Uptime | The number of minutes of uptime in the given time period. | Integer (minutes) | No |
Planned Downtime | The total number of minutes that were scheduled as downtime in the time period. | Integer (minutes) | No |
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) | No |
Total Downtime |
| Integer (minutes) | No |
% Uptime | The percentage of time that the OFP was available for use and functioning correctly.
| Integer (percentage) | No |
% Downtime | The percentage of time that the OFP was unavailable for use or not functioning correctly.
| Integer (percentage) | No |
% Unplanned Downtime | The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime.
| Integer (percentage) | No |
...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | YesAPI |
SetTPP Id | Group of APIs (e.g. Identifier of the TPP | String | |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc). | Enumeration | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes |
URL | The generic (This is the url without any url parameters specified) | Enumeration | Yes |
Total Time | The total number of minutes in the given time period of the report. | Integer (minutes) | No |
Total Uptime | The number of minutes of uptime in the given time period. | Integer (minutes) | No |
Planned Downtime | The total number of minutes that were scheduled as downtime in the time period. | Integer (minutes) | No |
Unplanned Downtime | The percentage of time that the LFI’s Ozone Connect was unavailable for use or not functioning correctly during a period when downtime was not planned. | Integer (minutes) | No |
Total Downtime |
| Integer (minutes) | No |
% Uptime | The percentage of time that the LFI’s Ozone Connect was available for use and functioning correctly.
| Integer (percentage) | No |
% Downtime | The percentage of time that the LFI’s Ozone Connect was unavailable for use or not functioning correctly.
| Integer (percentage) | No |
% Unplanned Downtime | The percentage of time that the LFI’s Ozone Connect was unavailable for use in the time period excluding planned downtime.
| String | No |
...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc). | Enumeration | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes |
URL | The generic (This is the url without any url parameters specified.) | Enumeration | Yes |
HTTP TPP Response Code Group | The response code group for the API calls:received back from the TPP
| Enumeration | Yes |
Max Response time | The maximum response time used by the OFP to respond to TPP requests for the API. | integer (ms) | No |
Min Response time | The minimum response time used by the OFP to respond to TPP requests for the API. | integer (ms) | No |
Average Response time | The average response time used by the OFP to respond to TPP requests for the API. | integer (ms) | No |
Number of calls | Count of API calls. | Integer (count) | No |
Error rate |
| RateString (percentage) |
1.4 LFI Performance Report
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc). | Enumeration | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes |
URL | The generic (This is the url without any url parameters specified.) | Enumeration | Yes |
HTTP TPP Response Code Group | The response code group for the API calls:received back from the TPP
| Enumeration | Yes |
Max Response time | The maximum response time used by the LFI to respond to OFP requests for the API. | integer (ms) | No |
Min Response time | The minimum response time used by the LFI to respond to OFP requests for the API. | integer (ms) | No |
Average Response time | The average response time used by the LFI to respond to OFP requests for the API. | integer (ms) | No |
Number of calls | Count of API calls. | Integer (count) | No |
Error rate |
| RateString (percentage) |
1.5 API Call Volume & Billing
Field | Description | Data type | Filter |
---|---|---|---|
Period Start | Date-time when the rollup period started. | Datetime | NA |
Period End | Date-time when the rollup period ended. | Datetime | NA |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc). | Enumeration | Yes |
HTTP Method | The technical The methods supported for each API call are specified in the standard. | Enumeration | Yes |
URL | The generic (This is the url without any url parameters specified.) | Enumeration | Yes |
HTTP TPP Response Code Group | The response code group for the API calls:received back from the TPP
| Enumeration | Yes |
Number of calls | Count of API calls. | Integer (count) | No |
...
Field | Description | Datatype | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientId, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Authentication channel | App, Web. | Enumeration | Yes |
Consent type | The type of consent (e.g. payments, accounts). | Enumeration | Yes |
Authorised Consents at Start Date | Total number of consents in an | Integer (count) | No |
Authorised Consents at End Date | Total number of consents in an This is computed as:
| Integer (count) | No |
Consents Created | Total number of new consents that were created during the reporting period. (This is the number of | Integer (count) | No |
Authorisation Requests | Total number of authorisation requests. (This is the number of | Integer (count) | No |
Successful Authorisation Requests | Total number of authorisation requests that were successful. (Requests to | Integer (count) | No |
Unsuccessful Authorisation Requests | Total number of authorisation requests that were not successful. (Requests to | Integer (count) | No |
Completed Authorisations | Total number of authorisation requests that were completed with a success or error. (This is the number of | Integer (count) | No |
Incomplete Authorisations | Authorisations that were started, but never completed. ( | Integer (count) | No |
Abandoned Authorisations | Consents for which a corresponding authorisation request was never made. ( | Integer (count) | No |
Insecure Authorisation Requests | Total number of authorisation requests that were completed, but without a redirect to the TPP as the TPP could not be identified. (This is the number of | Integer (count) | No |
Successful Authorisations | Total number of authorisation requests that were completed and resulted in the generation of an authorisation code. (This is measured as the number of | Integer (count) | No |
Unsuccessful Authorisations | Total number of authorisation requests that were unsuccessful. (This is measured as the number of | Integer (count) | No |
Access Denied Errors | Number of consents for which the customer denied authorisation explicitly. (This is measured as the number of | Integer (count) | No |
Other Unsuccessful Authorisations | Number of Unsuccessful Authorisations ending with an error other than | Integer (count) | No |
Consent Rejections | Number of consents that were This is the sum of:
| Integer (count) | No |
Consent Revocations | Number of consents that transitioned into | Integer (count) | No |
Consent Consumptions | Number of consents that transitioned into | Integer (count) | No |
Consent Expirations | Number of consents that transitioned into | Integer (count) | No |
...
Field | Description | Datatype | Filter | |
Period Start | Date-time when the reporting period started. | Datetime | N/A | |
Period End | Date-time when the reporting period ended. | Datetime | N/A | |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFILicensed Financial Institution | String | Yes | |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes | Authentication channel |
TPP Client Id | Client identifier of the TPP | String | ||
Authentication channel | App, Web. | Enumeration | Yes | |
Consent type | The type of consent (e.g. payments, accounts). | Enumeration | Yes | |
Consent State | The consent state that this record relates to. | Enumeration | Yes | |
Count at start | Number of consents in the given consent state at the start of the period. | Integer (count) | No | |
Count at end | Number of consents in the given consent state at the end of the period. | Integer (count) | No |
...
Field | Description | Datatype | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Authentication channel | App, Web. | Enumeration | Yes |
Consent type | The type of consent (e.g. payments, accounts). | Enumeration | Yes |
RevokedBy | The reason code for the consent revocation for the given row. | Enumeration | Yes |
Count | Number of consents revoked with the revocation reason code during the period. | Integer (count) | No |
...
Field | Description | Datatype | Filter |
---|---|---|---|
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) of Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Authentication channel | App, Web. | Enumeration | Yes |
Consent type | The type of consent (e.g. payments, accounts). | Enumeration | Yes |
Unique User Count at Start | Total number of unique users at the start of the period associated with | Integer (count) | No |
Unique User Count at End | Total number of unique users at the end of the period associated with | Integer (count) | No |
Change in user base |
| Integer (count) | No |
...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Resource Name | Balance, Transactions, Direct debit, etc. | Enumeration | Yes |
Status | HTTP Status code for the request. | Enumeration | Yes |
Total Requests | The number of combined successful / unsuccessful API requests during the selected reporting time period. | Integer (count) | No |
Attended Requests | The number of API requests attended by a user. | Integer (count) | No |
Unattended Requests | The number of unattended API requests. | Integer (count) | No |
RowsRecords | Number of “rows” “records” of information for successful requests. | Integer (count) | No |
1.11 Insurance Data Report
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Resource Name | e.g. Motor, etc. | Enumeration | Yes |
Status | HTTP Status code for the request. | Enumeration | Yes |
Total Requests | The number of combined successful / unsuccessful API requests during the selected reporting time period. | Integer (count) | No |
Attended Requests | The number of API requests attended by a user. | Integer (count) | No |
Unattended Requests | The number of unattended API requests. | Integer (count) | No |
RowsRecords | Number of “rows” “records” of information for successful requests. | Integer (count) | No |
1.12 Payment Volume Report
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Payment type | Payments SIP, Payments VRP, etc. | Enumeration | Yes |
Currency | The currency of the payment executed. | String | Yes |
Payment Purpose Code | The Purpose Code indicated during payment initiation. | Enumeration | Yes |
POST Request Count | The number of payments API This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc. | Integer (count) | No |
Successful POST Request Count | The number of successful payments API | Integer (count) | No |
Failed POST Request Count | The number of failed payments API | Integer (count) | No |
Completed Payment Count | The number of payments that have been completed (fully settled). | Integer (count) | No |
Failed Payment Count | The number of payments that failed to be settled. | Integer (count) | No |
Incomplete Payment Count | The number of payments that are incomplete (neither failed, nor settled). | Integer (count) | No |
...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
Payment type | Payments SIP, Payments VRP, etc. | Enumeration | Yes |
Currency | The currency of the payment executed. | String | Yes |
Payment Purpose Code | The Purpose Code indicated during payment initiation. | Enumeration | Yes |
POST Request Value | The number of payments API This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc. | Decimal (count) | No |
Successful POST Request Value | The number of successful payments API | Decimal (count) | No |
Failed POST Request Value | The number of failed payments API | Decimal (count) | No |
Completed Payment Value | The number of payments that have been completed (fully settled). | Decimal (count) | No |
Failed Payment Value | The number of payments that failed to be settled. | Decimal (count) | No |
Incomplete Payment Value | The number of payments that are incomplete (neither failed, nor settled). | Decimal (count) | No |
...
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) Identifier of the Licensed Financial Institution . | String |
TPP Org IdIdentifiers (such as name, clientid, orgId) Id | Identifier of the TPP | String |
TPP Client Id | Client identifier of the TPP. | String |
Payment type | Payments SIP, Payments VRP, etc. | Enumeration |
Currency | The currency of the payment executed. | String |
Payment Purpose Code | The Purpose Code indicated during payment initiation. | Enumeration |
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) |
...
Field | Description | Data type | Filter |
Period Start | Date-time when the reporting period started. | Datetime | N/A |
Period End | Date-time when the reporting period ended. | Datetime | N/A |
LFI Org Id | Identifiers (such as name, orgId) Identifier of the LFI.Licensed Financial Institution | String | Yes |
TPP Org Id | Identifiers (such as name, clientid, orgId) Identifier of the TPP. | String | Yes |
TPP Client Id | Client identifier of the TPP | String | |
API Set | Group of APIs (e.g. account information, payments, VRP etc.) | Enumeration | Yes |
Event Name | The event name that was delivered to the TPP. | Enumeration | Yes |
HTTP TPP Response Code Group | The response code group received back from the TPP:
| Enumeration | Yes |
Total number of calls | Count of API calls. | Integer (count) | No |
1.16 Confirmation of Payee Report
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 Id | Identifier of the Licensed Financial Institution | String |
TPP Id | Identifier of the TPP | String |
TPP Client Id | Client identifier of the TPP | String |
API Set | Group of APIs (e.g. payments) | Enumeration |
API Sub Set | COP | String |
Resource Name |
| String |
TTP Response Code Group | The response code group received back from the TPP
| Enumeration |
Total number of calls | Count of API calls | Integer (count) |
2. Admin Portal Dashboard Widgets
...