Page Comparison

Field

Description

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

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 returned to the 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

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

PSU Id

Id of the Payment Services User (Customer)

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

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

RateString (percentage)

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)