Page Comparison

...

Expand

title	MENU

Table of Contents

maxLevel

maxLevel	6
minLevel	1
6	outline	false
style	none
type	list
printable	true

...

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

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

apiLog.context.apiContext.resource

Status

apiLog.context.downstreamResponseCode

Note: Still under discussion
There may by multiple downstream API calls, in this case we need all the response codes

Attended / Unattended Requests

apiLog.context.attendedRequest

For all API calls, we will set apiLog.context.attended to true if x-fapi-customer-ip-address is in the header and false otherwise.

This will then be available in api-log collection which can be projected down to this report.

Rows

apiLog.context.totalRecords

Only populated for AIS and insurance

API group

apiLog.context.apiSubSet

API method

apiLog.context.operation

API endpoint

apiLog.context.urlTemplate

TPP Identifier

apiLog.context.clientId

Payment Type

In POST /payment, we will store body.Data.OpenFinanceBilling.Type into apiLog.context.billingContent.Type.

This will then be available in api-log collection which can be projected down to this report.

Only populated for payments

Merchant Id

In POST /payment, we will store body.Data.OpenFinanceBilling.MerchantId into apiLog.context.billingContent.MerchantId.

This will then be available in api-log collection which can be projected down to this report.

Only populated for payments

Is Large Corporate

In POST /payment, all Insurance GET calls and all AIS GET calls, we will store consent.responseBody.Data.OpenFinanceBilling.IsLargeCorporate into apiLog.context.billingContent.MerchantId.

This will then be available in api-log collection which can be projected down to this report.

User Type

In all AIS GET calls, we will store cconsent.responseBody.OpenFinanceBilling.UserType into apiLog.context.billingContent.UserType.

This will then be available in api-log collection which can be projected down to this report.

Only populated for AIS

Purpose

In all AIS and Insurance GET calls, we will store cconsent.responseBody.OpenFinanceBilling.Purpose into apiLog.context.billingContent.Purpose.

This will then be available in api-log collection which can be projected down to this report.

Only populated for AIS and insurance

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

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

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)

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 Downtime	Total Downtime = Planned Downtime

-

+ Unplanned Downtime

Total Downtime = Total Time - Total Uptime

Integer (minutes)

% Uptime

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

% Uptime = Total Uptime / Total Time

Integer

RateString (percentage)

% Downtime

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

% Downtime = Total Downtime / Total Time

Integer

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)

Integer

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

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

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

Integer

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)

String

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 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.) 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 received back from the TPP

2xx (successful)
4xx (Rejected with client error)
5xx (Failed with server error)

Enumeration

Max Response time

The

response code group

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

calls

2xx

integer (

successful

ms)

4xx (Rejected with client error)

5xx (Failed with server error)

Enumeration

Max

Average Response time

The

maximum

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)

Min Response time

The minimum


Error rate	5xx / Total number of calls = Error rate	RateString (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

...

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

...

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)

...

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

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

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

Abandoned

Successful Authorisations

Consents for which a corresponding authorisation request was never made

( Consents Created - Authorisation Requests

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)

Insecure Authorisation Requests

Unsuccessful Authorisations

Total number of

authorization

authorisation requests that were

completed, but without a redirect to the TPP as the TPP could not be identified.

unsuccessful

(This is measured as the number of

auth or doFail requests

doFail calls and doSuccess calls that resulted in a non 200 response that resulted in a

redirect: false Total number of authorisation requests that were completed and resulted in the generation of an authorization code

successful response)

Integer (count)

Successful Authorisations

Access Denied Errors

Number of consents for which the customer denied authorisation explicitly.

(This is measured as the number of

doSuccess calls that resulted in a successful response

doFail calls with an error_code of access_denied)	Integer (count)
Other Unsuccessful Authorisations	Number of 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)

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)

Access Denied Errors

Consent Revocations

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)

that transitioned into Revoked state during the reporting period

Integer (count)

Other Unsuccessful Authorisations

Consent Consumptions

Number of

Unsuccessful Authorisations ending with an error other than access_denied

consents that transitioned into Consumed state during the reporting period	Integer (count)
Consent

Rejections

Expirations

Number of consents that

were Rejected

transitioned into Expired state 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.

...

Integer (count)

The figure below illustrates the breakup of consents created by stage of progression through the authorisation process.

Drawio

mVer	2
simple	0
zoom	1
inComment	0
custContentId	79069329
pageId	79953925
diagramDisplayName	Untitled Diagram-1715590372925.drawio
lbox	1
contentVer	1
revision	1
baseUrl	https://openfinanceuae.atlassian.net/wiki
diagramName	Untitled Diagram-1715590372925.drawio
pCenter	0
width	960
links
tbstyle
height	360

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 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
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 consents in the given consent stateconsent 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	Identifier of the TPP	String
TPP

Org

Client Id

Identifiers (such as name, clientid, orgId)

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

RevokedBy	The reason code for the consent revocation for the given row	Enumeration
Count	Number of consents

in the given consent state at the end of

revoked with the revocation reason code during the period

Integer (count)

1.5.

...

4 Consent

...

users

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

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

...


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	Integer (count)
Change in user base	Unique User Count at End - Unique User Count at Start	Integer (count)

1.6 Usage & Uptake

1.6.1 Bank Data

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

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)

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

TPP Client Id	Client identifier of the TPP	String
Resource Name	Name of a data resource. E.g.: 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)

Unique User Count at End

Total number of unique users at the end of the period associated with Authorised consentsUniqu User Count at End - Unique User Count at Start

Unattended Requests

The number of unattended API requests.

Integer (count)

Change in user base

Total Requests

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

Integer (count)

...


Records	Number of “records” of information for successful requests	Integer (count)

1.6.

...

2 Insurance Data

This report provides statistics on the number of API Bank Insurance requests including a breakdown of the resource name, e.g. BalanceMotor, Transactions 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 Id	Identifier of the TPP	String
TPP

Org

Client Id

Identifiers (such as name, clientid, orgId)

Client identifier of the TPP	String
Resource Name

Balance, Transactions, Direct debit

e.g. Motor, 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

Records

Number of

“rows”

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

Identifier of the Licensed Financial Institution	String
TPP Id

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

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)

Attended Requests

Failed POST Request Count

The number of failed payments API

requests attended by a user

post requests during the reporting time period.

Integer (count)

Unattended Requests

Completed Payment Count

The number of

unattended API requests.

payments that have been completed (fully settled)

Integer (count)

Rows

Number of “rows” of information for successful requests

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

Status

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

body.Data.OpenFinanceBilling.Type

Merchant Id

body.Data.OpenFinanceBilling.MerchantId

Is Large Corporate

consent.responseBody.Data.OpenFinanceBilling.IsLargeCorporate

Number of successful txns

paymentLog.???.OpenFinanceBilling.NumberOfSuccessfulTransactions

(only for file payments)

International Payment

true or false

Failed Payment Count

The number of payments that failed to be settled

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

...

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

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

...

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)

Incomplete Payment Count

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

Integer (count)

Drawio

mVer	2
simple	0
zoom	1
inComment	0
custContentId	79495202
pageId	79953925
diagramDisplayName	Untitled Diagram-1715590434139.drawio
lbox	1
contentVer	1
revision	1
baseUrl	https://openfinanceuae.atlassian.net/wiki
diagramName	Untitled Diagram-1715590434139.drawio
pCenter	0
width	960
links
tbstyle
height	180

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

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

HTTP

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 IdIdentifiers (such as name, orgId) of the Licensed Financial Institution

Id	Identifier of the Licensed Financial Institution	String
TPP Id	Identifier of the TPP	String
TPP

Org

Client Id

Identifiers (such as name, clientId, orgId)

String

Resource

beneficiaries

String

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

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

Resource Name

discovery, confirmation

String

HTTP

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

...

Version	Old Version 2	New Version Current
Changes made by	Isla Humphreys	Isla Humphreys
Saved on	25 Oct 2024	07 Nov 2024

Versions Compared

Key

1.1 Raw API Log Data

1.2 API Call Volume & Billing

1.3 Availability

1.3.1 OFP Availability

1.3.2 LFI Availability

1.4 Performance

1.4.1 OFP Performance

1.4.2 LFI Performance

1.4.2 LFI Performance

1.5 Consents

1.5.1 Consent Authorisation

1.5 Consents

1.5.1 Consent Authorisation

1.5.2 Consent Status

1.5.3 Consent revocations

1.5.

4 Consent

users

1.6 Usage & Uptake

1.6.1 Bank Data

1.6.

2 Insurance Data

1.7 Payments

1.

7.1 Payment Volume

1.7.4 Payment Logs

1.7 Payments

1.7.1 Payment Volume

1.7.2 Payments Value

1.7.3 Payments Performance

1.7.2 Payments Value

1.7.3 Payments Performance

1.7.4 Payment Logs

1.8 Event Notifications

1.9 Confirmation Of Payee

1.10 Usage & Uptake - Other