Page Comparison

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

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

Yes

URL

The generic url template for the API call.

(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

Total Downtime = Planned Downtime - Unplanned Downtime

Total Downtime = Total Time - Total Uptime

Integer (minutes)

No

% Uptime

The percentage of time that the OFP was available for use and functioning correctly.

% Uptime = Total Uptime / Total Time

Integer (percentage)

No

% Downtime

The percentage of time that the OFP was unavailable for use or not functioning correctly.

% Downtime = Total Downtime / Total Time

Integer (percentage)

No

% 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)

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

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

Yes

URL

The generic url template for the API call.

(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

Total Downtime = Planned Downtime - Unplanned Downtime

Total Downtime = Total Time - Total Uptime

Integer (minutes)

No

% 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)

No

% 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)

No

% Unplanned Downtime

The percentage of time that the LFI’s Ozone Connect was unavailable for use in the time period excluding planned downtime.

% Unplanned Downtime = Total Downtime / (Total Time - 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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

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

Yes

URL

The generic url template for the API call.

(This is the url without any url parameters specified.)

Enumeration

Yes

TPP Response Code Group

The response code group received back from the TPP

• 2xx (successful)

• 4xx (Rejected with client error)

• 5xx (Failed with server error)

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

5xx / Total number of calls = Error rate

RateString (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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

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

Yes

URL

The generic url template for the API call.

(This is the url without any url parameters specified.)

Enumeration

Yes

TPP Response Code Group

The response code group received back from the TPP

• 2xx (successful)

• 4xx (Rejected with client error)

• 5xx (Failed with server error)

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

5xx / Total number of calls = Error rate

RateString (percentage)

No

Period Start

Date-time when the rollup period started.

Datetime

NA

Period End

Date-time when the rollup period ended.

Datetime

NA

LFI Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

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

Yes

URL

The generic url template for the API call.

(This is the url without any url parameters specified.)

Enumeration

Yes

TPP Response Code Group

The response code group received back from the TPP

• 2xx (successful)

• 4xx (Rejected with client error)

• 5xx (Failed with server error)

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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 Authorised state at the start of the reporting period.

Integer (count)

No

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)

No

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 authorisation server during the reporting period.)

Integer (count)

No

Authorisation Requests

Total number of authorisation requests.

(This is the number of auth requests made to the OFP Headless Heimdall service during the reporting period.)

Integer (count)

No

Successful Authorisation Requests

Total number of authorisation requests that were successful.

(Requests to auth that ended with 2xx code.)

Integer (count)

No

Unsuccessful Authorisation Requests

Total number of authorisation requests that were not successful.

(Requests to auth that ended with non 2xx code.)

Integer (count)

No

Completed Authorisations

Total number of authorisation 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)

No

Incomplete Authorisations

Authorisations that were started, but never completed.

( Authorisation Requests - Completed Authorisations)

Integer (count)

No

Abandoned Authorisations

Consents for which a corresponding authorisation request was never made.

( Consents Created - Authorisation Requests)

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 auth or doFail requests that resulted in a redirect: false response.)

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 doSuccess calls that resulted in a successful response.)

Integer (count)

No

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)

No

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)

No

Other Unsuccessful Authorisations

Number of Unsuccessful Authorisations ending with an error other than access_denied.

Integer (count)

No

Consent Rejections

Number of consents that were Rejected during the reporting period.

This is the sum of:

• Abandoned Auth Requests.

• Unsuccessful Authorisation Requests.

• Insecure Authorisation Requests.

• Incomplete Authorisations.

• Unsuccessful Authorisation Requests.

Integer (count)

No

Consent Revocations

Number of consents that transitioned into Revoked state during the reporting period.

Integer (count)

No

Consent Consumptions

Number of consents that transitioned into Consumed state during the reporting period.

Integer (count)

No

Consent Expirations

Number of consents that transitioned into Expired state during the reporting 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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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 Authorised consents.

Integer (count)

No

Unique User Count at End

Total number of unique users at the end of the period associated with Authorised consents.

Integer (count)

No

Change in user base

Unique User Count at End - Unique User Count at Start.

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Records

Number of “records” of information for successful requests

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Records

Number of “records” of information for successful requests

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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 post requests during the reporting time period.

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 post requests during the reporting time period.

Integer (count)

No

Failed POST Request Count

The number of failed payments API post requests during the reporting time period.

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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 post requests during the reporting time period.

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 post requests during the reporting time period.

Decimal (count)

No

Failed POST Request Value

The number of failed payments API post requests during the reporting time period.

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

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 Id

Identifier of the Licensed Financial Institution

String

Yes

TPP Id

Identifier of the TPP

String

Yes

TPP Client Id

Client identifier of the TPP

String

Yes

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

Yes

Event Name

The event name that was delivered to the TPP.

Enumeration

Yes

TPP Response Code Group

The response code group received back from the TPP

• 2xx (successful)

• 4xx (Rejected with client error)

• 5xx (Failed with server error)

Enumeration

Yes

Total number of calls

Count of API calls.

Integer (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 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)
An API can belong to only one group that will be determined as part of the specifications.

Enumeration

API Sub Set

COP

String

Resource Name

discovery, confirmation

String

TTP TPP Response Code Group

The response code group received back from the TPP

• 2xx (successful)

• 4xx (Rejected with client error)

• 5xx (Failed with server error)

Enumeration

Total number of calls

Count of API calls

Integer (count)