Versions Compared

Version Old Version 3 New Version 4
Changes made by

Isla Humphreys

Alex Ischimji

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleMENU
Table of Contents
maxLevel
maxLevel6
minLevel1
6outlinefalse
stylenone
typelist
printabletrue

...

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

Timestamp when the API call was received

Datetime

LFI

Org

Id

Identifiers (such as name, orgId)

Identifier of the Licensed Financial Institution

String

TPP Org Id

Identifiers (such as name, clientid, orgId)

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

TPP Response Code Group

The response code group

for

returned to the

API calls

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

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.)
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 OFP 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

TPP

  • 2xx (successful)

  • 4xx (Rejected with client error)

  • 5xx (Failed with server error)

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.

Resource Name

Name of a data resource. E.g.: Balance, Transactions, Direct debit, etc.

String

LFI Response Code Group

The response code group received from the LFI

  • 2xx (successful)

  • 4xx (Rejected with client error)

  • 5xx (Failed with server error)

  • if no downstream calls were made, this field is left empty

String

Is Attended

Indication if API call was attended by the user:

  • true - attended

  • false - not attended

Boolean

Records

The number of records in successful Bank Data Sharing or Insurance responses.

If calls are not for Bank Data Sharing or Insurance, this field is left empty.

Integer

Payment Type

The type of the payment. E.g.: Collection, LargeValueCollection, PushP2P, PullP2P, Me2Me

Enumeration

Merchant Id

Id of the Merchant

String

Is Large Corporate

Indication if Customer is a Large Corporate:

  • true - if Customer has more than 100 million AED turnover

  • false - if Customer doesn’t have more than 100 million AED turnover

Boolean

User Type

Indication of user type:

  • Retail,

  • SME

  • Corporate

If calls are not for Bank Data Sharing, this field is left empty.

Enumeration

Purpose

Indication of request purpose:

  • AccountAggregation

  • RiskAssessment

  • TaxFiling

  • Onboarding

  • Verification

  • QuoteComparison

  • BudgetingAnalysis

  • FinancialAdvice

  • AuditReconciliation

If calls are not for Bank Data Sharing, this field is left empty.

Enumeration

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

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)

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

...

% Uptime = Total Uptime / Total Time

...

Integer (percentage)

...

% Downtime

...

The percentage of time that the OFP 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)

...

Integer (percentage)

1.3.2 LFI Availability

This report provides statistics on the time that the 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.)
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

...

, 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 Id

Identifier 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 OFP was unavailable for use or not functioning correctly during a period when downtime was not planned

Integer (minutes)

Total

Uptime The number of minutes of uptime in the given time period.

Downtime

Total Downtime = Planned Downtime + Unplanned Downtime

Total Downtime = Total Time - Total Uptime

Integer (minutes)

Planned Downtime

% Uptime

The

total number

percentage of

minutes

time that

were scheduled as downtime in the time period

Integer (minutes)

Unplanned

the OFP was available for use and functioning correctly.

% Uptime = Total Uptime / Total Time

RateString (percentage)

% Downtime

The percentage of time that the

LFI’s Ozone Connect interface

OFP 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

% Downtime = Total Downtime / Total Time

RateString (percentage)

% Unplanned Downtime

The percentage of time that the

LFI’s Ozone Connect

OFP was

available

unavailable for use

and functioning correctly.

in the time period excluding planned downtime

%

Uptime

Unplanned Downtime = Total

Uptime

Downtime / (Total Time - Planned Downtime)

Integer

RateString (percentage)

% Downtime

The percentage of

1.3.2 LFI Availability

This report provides statistics on the time that the

...

Ozone Connect implementation at LFI end was

...

available for use

...

and 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

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

, 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

started

ended

Datetime

Period End

Date-time when the reporting period ended

Datetime

LFI Org Id

Identifiers (such as name, orgId)

LFI Id

Identifier 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 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

5xx / Total number of calls = Error rate

Integer (percentage)

1.4.2 LFI Performance

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

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

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

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

RateString (percentage)

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

ended

started

Datetime

LFI Org Id

Identifiers (such as name, orgId)

Period End

Date-time when the reporting period ended

Datetime

LFI Id

Identifier of the Licensed Financial Institution

String

TPP Id

TPP Org Id

Identifiers (such as name, clientid, orgId)

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

TPP Response Code Group

The response code group

for the API calls

received back from the TPP

  • 2xx (successful)

  • 4xx (Rejected with client error)

  • 5xx (Failed with server error)

Enumeration

Max Response time

The maximum response time used by the

LFI

OFP to respond to

OFP

TPP requests for the API

integer (ms)

Min Response time

The minimum response time used by the

LFI

OFP to respond to

OFP

TPP requests for the API

integer (ms)

Average Response time

The average response time used by the

LFI

OFP to respond to

OFP

TPP 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

RateString (percentage)

1.

...

4.2 LFI Performance

This report provides statistics on the life-cycle of a consent and information on successful and unsuccessful authorisation requeststhe 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

Datatype

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

Id

Identifiers (such as name, clientId, orgId)

Consent type

The type of consent

Identifier of the TPP

String

Authentication channel

App, Web

Enumeration

TPP Client Id

Client identifier of the TPP

String

API Set

Group of APIs (e.g. account information, 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 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)

...

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

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

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

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

Identifier of the Licensed Financial Institution

String

TPP Id

Identifier of the TPP

String

TPP Client Id

Client identifier 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.

Drawio
mVer2
simple0
zoom1
inComment0
custContentId79069329
pageId79953925
diagramDisplayNameUntitled Diagram-1715590372925.drawio
lbox1
contentVer1
revision1
baseUrlhttps://openfinanceuae.atlassian.net/wiki
diagramNameUntitled Diagram-1715590372925.drawio
pCenter0
width960
links
tbstyle
height360

1.5.2 Consent Status

This report provides statistics on the number of consent revocations and the reasoningconsents 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)

Identifier of the Licensed Financial Institution

String

TPP

Org

Id

Identifiers (such as name, clientid, orgId)

Identifier of the TPP

String

Authentication channel

App

TPP Client Id

Client identifier 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

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 unique users at the start/end of the reporting period with Authorised consentsconsent 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)

Identifier of the Licensed Financial Institution

String

TPP Id

TPP Org Id

Identifiers (such as name, clientid, orgId)

Identifier of the TPP

String

TPP Client Id

Client identifier 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 Authorised consents

Integer (count)

Unique User Count at End

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

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)

Change in user base

Uniqu User Count at End - Unique User Count at Start

Integer (count)

1.6 Usage & Uptake

...

1.5.4 Consent users

This report provides statistics on the number of API Bank requests including a breakdown of the resource name, e.g. Balance, Transactions etcunique users at the start/end of the reporting period with Authorised consents.

Field

Description

Data type

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)

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

Resource Name

Authentication channel

Balance, Transactions, Direct debit, etc.

App, Web

Enumeration

Status

HTTP Status code for the request

No

Attended Requests

The number of API requests attended by a user.

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

Integer (count)

Unattended Requests

The number of unattended API requests.

Unique User Count at End

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

Integer (count)

Total Requests

The number of combined successful / unsuccessful API requests during the selected reporting time period.

Change in user base

Unique User Count at End - Unique User Count at Start

Integer (count)

Attended Requests

The

1.6 Usage & Uptake

1.6.1 Bank Data

This report provides statistics on the number of API Bank requests

...

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 API Insurance requests including a breakdown of the resource name, e.g. Motor, House etc.

...

Field

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-time when the reporting period ended

Datetime

LFI

Org

Id

Identifiers (such as name, orgId)

Identifier of the Licensed Financial Institution

String

TPP Id

Identifier of the TPP

String

TPP

Org

Client Id

Identifiers (such as name, clientid, orgId)

Client identifier of the TPP

String

Resource Name

e

Name of a data resource. E.g.

Motor

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

Attended Requests

The number of API requests attended by a user.

Integer (count)

Unattended Requests

The number of unattended API requests.

Integer (count)

Rows

Total Requests

The number of combined successful / unsuccessful API requests during the selected reporting time period.

Integer (count)

Records

Number of

“rows”

“records” of information for successful requests

Integer (count)




1.

...

6.2 Insurance Data

This report provides statistics on the number of payment API Insurance requests , including payments that have settled or failedincluding 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)

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

Resource Name

e.g. Motor, etc.

Enumeration

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

This excludes API calls for retrieving payment statuses, consent status, confirmation of funds etc

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)

Successful POST Request Count

Attended Requests

The number of

successful payments

API

post requests during the reporting time period

requests attended by a user.

Integer (count)

Failed POST Request Count

Unattended Requests

The number of

failed payments

unattended API

post

requests

during the 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)

Incomplete Payment Count

The number of payments that are incomplete (neither failed, nor settled)

Integer (count)

...

1.7.2 Payments Value

This report provides statistics on the value of 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

...

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

...

Records

Number of “records” 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 requests, 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 Id

Identifier of the Licensed Financial Institution

String

TPP Id

Identifier of the TPP

String

TPP Client Id

Client identifier of the TPP

String

Payment type

Indicates payment type. E.g.: Collection, LargeValueCollection, PushP2P, PullP2P, Me2Me

Enumeration

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

Failed POST Request Count

The number of failed payments API post requests during the 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)

Incomplete Payment Count

The number of payments that are incomplete (neither failed, nor settled)

Integer (count)

Drawio
mVer2
simple0
zoom1
inComment0
custContentId79495202
pageId79953925
diagramDisplayNameUntitled Diagram-1715590434139.drawio
lbox1
contentVer1
revision1
baseUrlhttps://openfinanceuae.atlassian.net/wiki
diagramNameUntitled Diagram-1715590434139.drawio
pCenter0
width960
links
tbstyle
height180


1.7.2 Payments Value

This report provides statistics on the value of 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)

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.

Indicates payment type. E.g.: Collection, LargeValueCollection, PushP2P, PullP2P, Me2Me

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

POST Request Value

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

This value API calls for retrieving payment statuses, consent status, confirmation of funds etc

Decimal (count)

Successful POST Request Value

The value of successful payments API post requests during the reporting time period.

Decimal (count)

Failed POST Request Value

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

Decimal (count)

Completed Payment Value

The value of payments that have been completed (fully settled)

Decimal (count)

Failed Payment Value

The value of payments that failed to be settled

Decimal (count)

Incomplete Payment Value

The value 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

...

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

This report provides statistics on the event name sent to the TPPof 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 Id

Identifier of the Licensed Financial Institution

String

TPP Id

Identifier of the TPP

String

TPP Client Id

Client identifier of the TPP

String

Payment type

Indicates payment type. E.g.: Collection, LargeValueCollection, PushP2P, PullP2P, Me2Me

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.7.4 Payment Logs

This is simply a projected copy of payment-log collection that is used by CM.

Field

Mapping

Data type

Timestamp

Timestamp when the API call was received

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

Status

Indicates payment status.

Enumeration

Payment Consent Type 

Indicates type of the payment consent. E.g.: Single Immediate, Future Dated, etc.

Enumeration

Payment Type

Indicates payment type. E.g.: Collection, LargeValueCollection, PushP2P, PullP2P, Me2Me

Enumeration

Transaction Id

Unique identifier of the transaction

String

Merchant Id

Id of the Merchant

String

Is Large Corporate

Indication if Customer is a Large Corporate:

  • true - if Customer has more than 100 million AED turnover

  • false - if Customer doesn’t have more than 100 million AED turnover

Boolean

Number of successful transactions

Indicates number of successful transactions done under Bulk/Batch payment.

If transactions are not a part of Bulk/Batch payment, this field is left empty.

Integer

International Payment

Indication if payment is international.

Boolean

Amount

The amount of the payment

String

Currency

The currency of the payment.

String

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 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. account information, payments, vrp etc.)
An API can belong to only one group that will be determined as part of the specifications.

Enumeration

Event Name

The event name that was delivered to the TPP

Enumeration


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)

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)

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

API Set

Group of APIs (e

.g. account information, payments, vrp etc.

.g. payments)
An API can belong to only one group that will be determined as part of the specifications.

Enumeration

Event Name

HTTP Method

The

event name that was delivered to the TPP

Enumeration

HTTP

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

Resource Name

discovery, confirmation

String

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)

1.

...

10 Usage & Uptake - Other

Additional usage reports will be added as new standards are introduced

...