...
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 report provides statistics on API volumes that can be used for billing, statistics also show a breakdown of methods and response code groups.
...
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.)
An API can belong to only one group that will be determined as part of the specifications.
...
Enumeration
...
HTTP Method
...
The technical method that was used for the API call.
The methods supported for each API call are specified in the standard.
Enumeration
...
URL
...
The generic url template for the API call.
(This is the url without any url parameters specified)
...
Enumeration
...
HTTP Response Code Group
...
The response code group for the API calls
2xx(successful)4xx(Rejected with client error)5xx(Failed with server error)
...
Enumeration
...
Total number of calls
...
Count of API calls
...
Integer (count)
1.3 Availability
...
Resource Name | apiLog.context.apiContext.resource | |
Status | apiLog.context.downstreamResponseCode Note: Still under discussion | |
Attended / Unattended Requests | apiLog.context.attendedRequest For all API calls, we will set This will then be available in | |
Rows |
Only populated for AIS and insurance | |
API group |
| |
API method |
| |
API endpoint |
| |
TPP Identifier |
| |
Payment Type | In POST /payment, we will store This will then be available in Only populated for payments | |
Merchant Id | In POST /payment, we will store This will then be available in Only populated for payments | |
Is Large Corporate | In POST /payment, all Insurance GET calls and all AIS GET calls, we will store This will then be available in | |
User Type | In all AIS GET calls, we will store This will then be available in Only populated for AIS | |
Purpose | In all AIS and Insurance GET calls, we will store This will then be available in Only populated for AIS and insurance |
1.2 API Call Volume & Billing
This report provides statistics on API volumes that can be used for billing, statistics also show a breakdown of methods and response code groups.
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 Availability
1.3.1 OFP Availability
This report provides statistics on the time that the OFP was available for use and functioning correctly, including planned/unplanned downtime and providing a percentage figure.
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 |
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 |
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.3.2 LFI Availability
This report provides statistics on the time that the OFP Ozone Connect implementation at LFI end was available for use and functioning correctly, including planned/unplanned downtime and providing a percentage figure.
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 |
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 |
Total Time | The total |
Integer (minutes)
Total Uptime
number of minutes |
in the given |
Integer (minutes)
Planned Downtime
time period |
Integer (minutes)
Unplanned Downtime
of |
the report | Integer (minutes) |
Total |
Total Downtime = Planned Downtime - Unplanned Downtime
Total Downtime = Total Time - Total Uptime
Uptime | The number of minutes of uptime in the given time period. | Integer (minutes) |
Planned Downtime | The |
total number of |
minutes that |
% Uptime = Total Uptime / Total Time
Integer (percentage)
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 |
% Downtime = Total Downtime / Total Time
Integer (percentage)
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) |
1.3.2 LFI Availability
...
% Downtime | The percentage of time that the LFI’s Ozone Connect |
...
was |
...
unavailable for use |
...
or not functioning correctly |
...
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
...
API Set
...
Group of APIs (e.g. account information, payments, vrp etc.)
An API can belong to only one group that will be determined as part of the specifications.
...
Enumeration
...
HTTP Method
...
The technical method that was used for the API call.
The methods supported for each API call are specified in the standard.
Enumeration
...
URL
...
The generic url template for the API call.
(This is the url without any url parameters specified)
...
Enumeration
...
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
...
Total Downtime = Planned Downtime - Unplanned Downtime
Total Downtime = Total Time - Total Uptime
...
Integer (minutes)
...
% Uptime
...
The percentage of time that the LFI’s Ozone Connect was available for use and functioning correctly.
% Uptime = Total Uptime / Total Time
...
Integer (percentage)
...
% Downtime
...
The percentage of time that the LFI’s Ozone Connect was unavailable for use or not functioning correctly
% Downtime = Total Downtime / Total Time
...
Integer (percentage)
...
% Unplanned Downtime
...
The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime
% Unplanned Downtime = Total Downtime / (Total Time - Planned Downtime)
...
String
1.4 Performance
...
| Integer (percentage) | |
% Unplanned Downtime | The percentage of time that the OFP was unavailable for use in the time period excluding planned downtime
| String |
1.4 Performance
1.4.1 OFP Performance
This report provides statistics on the response time used by the OFP to respond to TPP requests for the API, including minimum, maximum and average to monitor performance.
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 used by the OFP to respond to TPP requests for the API | integer (ms) |
Min Response time | The minimum response time used by the OFP to respond to TPP requests for the API | integer (ms) |
Average Response time | The average response time used by the OFP to respond to TPP requests for the API | integer (ms) |
Total number of calls | Count of API calls | Integer (count) |
Error rate |
| Integer (percentage) |
1.4.2 LFI Performance
This report provides statistics on the response time used by the OFP Ozone Connect implementation at LFI end to respond to TPP OFP requests for the API, including minimum, maximum and average to monitor performance.
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 used by the |
LFI to respond to |
OFP requests for the API | integer (ms) |
Min Response time | The minimum response time used by the |
LFI to respond to |
OFP requests for the API | integer (ms) |
Average Response time | The average response time used by the |
LFI to respond to |
OFP requests for the API | integer (ms) | |
Total number of calls | Count of API calls | Integer (count) |
Error rate |
| Integer (percentage) |
1.
...
5 Consents
1.5.1 Consent Authorisation
This report provides statistics on the response time used by the Ozone Connect implementation at LFI end to respond to OFP requests for the API, including minimum, maximum and average to monitor performance.
...
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.)
An API can belong to only one group that will be determined as part of the specifications.
...
Enumeration
...
HTTP Method
...
The technical method that was used for the API call.
The methods supported for each API call are specified in the standard.
Enumeration
...
URL
...
The generic url template for the API call.
(This is the url without any url parameters specified)
...
Enumeration
...
HTTP Response Code Group
...
The response code group for the API calls
2xx(successful)4xx(Rejected with client error)5xx(Failed with server error)
...
Enumeration
...
Max Response time
...
The maximum response time used by the LFI to respond to OFP requests for the API
...
integer (ms)
...
Min Response time
...
The minimum response time used by the LFI to respond to OFP requests for the API
...
integer (ms)
...
Average Response time
...
The average response time used by the LFI to respond to OFP requests for the API
...
integer (ms)
...
Total number of calls
...
Count of API calls
...
Integer (count)
...
Error rate
...
5xx / Total number of calls = Error rate
...
Integer (percentage)
1.5 Consents
1.5.1 Consent Authorisation
This report provides statistics on the life-cycle of a consent and information on successful and unsuccessful authorisation requests.
...
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
...
Authorised Consents at Start Date
...
Total number of consents in an Authorised state at the start of the reporting period
...
Integer (count)
...
Authorised Consents at End Date
...
Total number of consents in an Authorised state at the end of the reporting period
This is computed as
Authorised Consents at Start Date + Successful Authorisations - Consent Revocations - Consent Consumptions - Consent Expirations
...
Integer (count)
...
Consents Created
...
Total number of new consents that were created during the reporting period.
(This is the number of par requests made to the OFP authorization server during the reporting period)
...
Integer (count)
...
Authorisation Requests
...
Total number of authorization requests
(This is the number of auth requests made to the OFP Headless Heimdall service during the reporting period.)
...
Integer (count)
...
Successful Authorisation Requests
...
Total number of authorisation requests that were successful
(Requests to auth that ended with 2xx code
...
Integer (count)
...
Unsuccessful Authorisation Requests
...
Total number of authorisation requests that were not successful
(Requests to auth that ended with non 2xx code)
...
Integer (count)
...
Completed Authorisations
...
Total number of authorization requests that were completed with a success or error.
(This is the number of doFail or doSuccess requests made to the OFP Headless Heimdall service.)
...
Integer (count)
...
Incomplete Authorisations
...
Authorisations that were started, but never completed
( Authorisation Requests - Completed Authorisations)
...
Integer (count)
...
Abandoned Authorisations
...
Consents for which a corresponding authorisation request was never made
( Consents Created - Authorisation Requests)
...
Integer (count)
...
Insecure Authorisation Requests
...
Total number of authorization requests that were completed, but without a redirect to the TPP as the TPP could not be identified.
(This is the number of auth or doFail requests that resulted in a redirect: false response)
...
Integer (count)
...
Successful Authorisations
...
Total number of authorisation requests that were completed and resulted in the generation of an authorization code
(This is measured as the number of doSuccess calls that resulted in a successful response)
...
Integer (count)
...
Unsuccessful Authorisations
...
Total number of authorisation requests that were unsuccessful
(This is measured as the number of doFail calls and doSuccess calls that resulted in a non 200 response that resulted in a successful response)
...
Integer (count)
...
Access Denied Errors
...
Number of consents for which the customer denied authorisation explicitly.
(This is measured as the number of doFail calls with an error_code of access_denied)
...
Integer (count)
...
Other Unsuccessful Authorisations
...
Number of Unsuccessful Authorisations ending with an error other than access_denied
...
Integer (count)
...
Consent Rejections
...
Number of consents that were Rejected during the reporting period
This is the sum of
Abandoned Auth Requests
Unsuccesful Authorisation Requests
Insecure Authorisation Requests
Incomplete Authorisations
Unsuccessful Authorisation Requests
...
Integer (count)
...
Consent Revocations
...
Number of consents that transitioned into Revoked state during the reporting period
...
Integer (count)
...
Consent Consumptions
...
Number of consents that transitioned into Consumed state during the reporting period
...
Integer (count)
...
Consent Expirations
...
Number of consents that transitioned into Expired state during the reporting period
...
Integer (count)
The figure below illustrates the breakup of consents created by stage of progression through the authorisation process.
...
1.5.2 Consent Status
This report provides statistics on the number of consents in the given consent statethe life-cycle of a consent and information on successful and unsuccessful authorisation requests.
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 |
Authorised Consents at Start Date | Total number of consents in an | Integer (count) |
Authorised Consents at End Date | Total number of consents in an This is computed as
| Integer (count) |
Consents Created | Total number of new consents that were created during the reporting period. (This is the number of | Integer (count) |
Authorisation Requests | Total number of authorization requests (This is the number of | Integer (count) |
Successful Authorisation Requests | Total number of authorisation requests that were successful (Requests to | Integer (count) |
Unsuccessful Authorisation Requests | Total number of authorisation requests that were not successful (Requests to | Integer (count) |
Completed Authorisations | Total number of authorization requests that were completed with a success or error. (This is the number of | Integer (count) |
Incomplete Authorisations | Authorisations that were started, but never completed ( | Integer (count) |
Abandoned Authorisations | Consents for which a corresponding authorisation request was never made ( | Integer (count) |
Insecure Authorisation Requests | Total number of authorization 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) |
Successful Authorisations | Total number of authorisation requests that were completed and resulted in the generation of an authorization code (This is measured as the number of | Integer (count) |
Unsuccessful Authorisations | Total number of authorisation requests that were unsuccessful (This is measured as the number of | Integer (count) |
Access Denied Errors | Number of consents for which the customer denied authorisation explicitly. (This is measured as the number of | Integer (count) |
Other Unsuccessful Authorisations | Number of Unsuccessful Authorisations ending with an error other than | Integer (count) |
Consent Rejections | Number of consents that were This is the sum of
| Integer (count) |
Consent Revocations | Number of consents that transitioned into | Integer (count) |
Consent Consumptions | Number of consents that transitioned into | Integer (count) |
Consent Expirations | Number of consents that transitioned into | Integer (count) |
The figure below illustrates the breakup of consents created by stage of progression through the authorisation process.
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1.5.2 Consent Status
This report provides statistics on the number of consents in the given consent state.
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
This report provides statistics on the number of consent revocations and the reasoning.
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 |
RevokedBy | 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
This report provides statistics on the number of unique users at the start/end of the reporting period with Authorised consents.
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
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) |
Count at end
Change in user base |
| Integer (count) |
1.6 Usage & Uptake
1.
...
6.1 Bank Data
This report provides statistics on the number of consent revocations and the reasoningof API Bank requests including a breakdown of the resource name, e.g. Balance, Transactions etc.
Field | Description |
Data type | ||
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date |
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
RevokedBy
The reason code for the consent revocation for the given row
Enumeration
Count
-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 |
Attended Requests | The number of API requests attended by a user. | Integer (count) |
Unattended Requests | The number of unattended API requests. | Integer (count) |
Total Requests | The number of combined successful / unsuccessful API requests during the selected reporting time period. | Integer (count) |
Attended Requests | The number of API requests attended by a user. | Integer (count) |
Unattended Requests | The number of unattended API requests. | Integer (count) |
Rows | Number of “rows” of information for successful requests | Integer (count) |
1.
...
6.2 Insurance Data
This report provides statistics on the number of unique users at the start/end of the reporting period with Authorised consentsAPI Insurance requests including a breakdown of the resource name, e.g. Motor, House etc.
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 |
Authentication channel
App, Web
Enumeration
Consent type
Resource Name | e.g. |
Motor, |
etc. | Enumeration |
Unique User Count at Start
Authorised consentsStatus | 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) |
Unique User Count at End
Authorised consentsUniqu User Count at End - Unique User Count at StartAttended Requests | The number of API requests attended by a user. | Integer (count) |
Unattended Requests | The number of unattended API requests. | Integer (count) |
Change in user base
Rows | Number of “rows” of information for successful requests | Integer (count) |
1.
...
7 Payments
1.
...
7.1
...
Payment Volume
This report provides statistics on the number of payment API Bank requests including a breakdown of the resource name, e.g. Balance, Transactions etc., including payments that have settled or failed.
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
Payment type | Payments SIP, Payments VRP, etc. | Enumeration |
Status
HTTP Status code for the request
No
Currency | The currency of the payment executed. | String |
Payment Purpose Code | The Purpose Code indicated during payment initiation. | Enumeration |
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 |
reporting time period. | 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) |
Rows
Incomplete Payment Count | The number of payments that are incomplete (neither failed, nor settled) | Integer (count) |
1.6.2 Insurance Data
This report provides statistics on the number of API Insurance requests including a breakdown of the resource name, e.g. Motor, House etc.
...
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
...
e.g. Motor, 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)
...
Attended Requests
...
The number of API requests attended by a user.
...
Integer (count)
...
Unattended Requests
...
The number of unattended API requests.
...
Integer (count)
...
Rows
...
Number of “rows” of information for successful requests
...
Integer (count)
1.7 Payments
...
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
1.7.2 Payments Value
This report provides statistics on the number value of payment API requests, including payments that have been settled or failed.
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 |
Payment |
Purpose Code |
Enumeration
POST Request Count
The number of payments API post requests during the reporting time period.
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 post requests during the reporting time period.
Integer (count)
The Purpose Code indicated during payment initiation. | Enumeration | |
POST Request Value | The number of |
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)
This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc | Decimal (count) |
Successful POST Request Value | The number of |
Integer (count)
...
1.7.2 Payments Value
...
successful payments API | Decimal (count) | |
Failed POST Request Value | The number of failed payments API | Decimal (count) |
Completed Payment Value | The number of payments that have been completed (fully settled) | Decimal (count) |
Failed Payment Value | The number of payments that failed to be settled | Decimal (count) |
Incomplete Payment Value | The number of payments that are incomplete (neither failed, nor settled) | Decimal (count) |
1.7.3 Payments Performance
This report provides statistics on the 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.
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 |
Payment Purpose Code | The Purpose Code indicated during payment initiation. | Enumeration |
POST Request Value
The number of payments API post requests during the reporting time period.
This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc
Decimal (count)
Successful POST Request Value
The number of successful payments API post requests during the reporting time period.
Decimal (count)
Failed POST Request Value
The number of failed payments API post requests during the reporting time period.
Decimal (count)
Completed Payment Value
The number of payments that have been completed (fully settled)
Decimal (count)
Failed Payment Value
The number of payments that failed to be settled
Decimal (count)
Incomplete Payment Value
The number of payments that are incomplete (neither failed, nor settled)
Decimal (count)
1.7.3 Payments Performance
...
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 |
...
Field | Description | Data type |
Period Start | Date-time when the reporting period started | Datetime |
Period End | Date-time when the reporting period ended | DatetimeInteger (ms) |
1.7.4 Payment Logs
This is simply a projected copy of payment-log collection that is used by CM.
Field | Mapping | Data present |
|---|---|---|
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
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)
1.8 Event Notifications
...
Status |
| no |
TPP Id | copied from apiLog.context.clientId | |
Amount | copied from Payment request | |
Currency | copied from Payment request | |
Type of Payment Consent | Copied from Consent into Payment Log ie Single, Future Dated, or Multi Payment | |
Payment Type |
| |
Merchant Id |
| |
Is Large Corporate |
| |
Number of successful txns |
(only for file payments) | |
International Payment | true or false |
1.8 Event Notifications
This report provides statistics on the event name sent to the TPP.
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) |
1.9 Confirmation Of Payee
This report provides statistics on the payee confirmation request made.
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. |
payments |
) | Enumeration |
Event Name
The event name that was delivered to the TPP
API Sub Set | COP | String |
Resource |
| String |
Resource Name |
| String |
HTTP Response Code Group | The response code group received back from the TPP
| Enumeration |
Total number of calls | Count of API calls | Integer (count) |
1.
...
10 Usage & Uptake - Other
Additional usage reports will be added as new standards are introduced
...