Release candidate

v2.2-rc2 is not ratified and MUST NOT be used for production. Current: v2.1. Changelog

This is v2.2-rc2 — a release candidate for the v2.2 standards, published for review and not yet ratified. It MUST NOT be used as the basis for a production implementation. For the current standards, switch to v2.1 using the version selector. See the v2.1 → v2.2-rc2 changelog for every change in this version.

Banking · Service Initiation · Single Instant Payment · UX

Single Instant Payment — User Experience 4 min read

Before a customer authorises a payment through Open Finance, you must present a Consent Page that clearly explains the payment they are consenting to. This page must accurately reflect the payee, amount, schedule, and all material terms of the payment consent. The examples and interactive wireframes below define the expected structure, content, and behaviour of the Consent Page and must be followed.

While you may adapt visual elements such as colour palette, fonts, and styling, you must not alter the meaning, clarity, or completeness of the payment information shown, and the representation of AlTareq (including logos, naming, and action buttons) must be preserved. The customer must always be able to clearly understand what payment they are consenting to and that it is part of the AlTareq ecosystem. Your Consent Page must be submitted as part of CX certification prior to production, and any material changes to a production Consent Page must be re-submitted for review and approval.

01 Interactive Demo

Edit the consent and watch the previews respond

TPPConsent page
LFIAuthorisation page
LFI
Consent
2
Authorize
3
Complete
Confirm Payment Details
[TPP trading name] needs your permission to make the payment below:
Please select the account to pay from
Add to my list of Trusted Payees
Pay using AlTareq
Cancel

Customise the request body fields below and watch the Consent and Authorisation page previews update live.

domestic_payment_piiPAR request body (AEDomesticPaymentPII)
AEBankServiceInitiationRichAuthorizationRequests.AEDomesticPaymentPIIView PAR endpoint ↗
1 lines0 charsEdits commit on blur — invalid JSON reverts.
authorization_detailsPAR request body field
AEBankServiceInitiationRichAuthorizationRequestsV21.AEBankServiceInitiationAuthorizationDetailsPropertiesView PAR endpoint ↗
1 lines0 charsEdits commit on blur — invalid JSON reverts.
Simulated Accounts Behaviour

Configure the mock accounts the authenticated user holds at their bank. The Authorisation Page will offer these accounts when the user picks a debtor account, or validate the Initiation.DebtorAccount against them when one is pre-selected by the TPP.

Simulated user accounts Accounts the authenticated user holds at their bank
2 / 5
02 Field-Driven UI

How API request fields change what the user sees

Debtor Account Selection

The presence or absence of Initiation.DebtorAccount in domestic_payment_pii determines whether the user selects their account at the LFI or if it is pre-selected by the TPP.

Tip

Passing a DebtorAccount reduces friction for users who have already selected their account within the TPP's own interface, but removes the user's ability to choose a different account at the LFI.

On Behalf Of

When a TPP processes payments on behalf of a merchant (e.g. a payment aggregator), OnBehalfOf can be passed in the payment consent to identify the merchant to the user on the LFI Authorisation Page. The LFI displays OnBehalfOf.TradingName. From v2.2 this replaces Risk.CreditorIndicators.MerchantDetails.MerchantName as the source of the on-behalf-of name; MerchantName remains a risk field only.

consent.OnBehalfOfLFI Authorisation Page Behaviour
Passed inThe page reads “[TPP trading name] needs your permission on-behalf of [OnBehalfOf.TradingName] to make the payment below”, alongside the creditor details. (See Example 4)
Not passed inNo merchant information is shown. Only the creditor details are displayed. (See Examples 1, 2 & 3)

Creditor Configuration

The presence or absence of creditors in Initiation.Creditor in domestic_payment_pii determines how the LFI presents payment recipient information to the user.

Initiation.CreditorLFI Authorisation Page Behaviour
1 creditorThe single payee's name and account details are displayed under "Who you're paying". (See Example 1)
2–10 defined creditorsNot Supported
Undefined (absent or empty)Not Supported

Trusted Payees Wording

The wording of the "Add to my list of Trusted Payees" checkbox is driven by Initiation.Creditor[].CreditorAccount.Type in domestic_payment_pii. Whether the checkbox is shown at all is a separate, account-driven behaviour — see Trusted Payees under UI Behaviour Driven by Account State.

CreditorAccount.TypeCheckbox Text
IndividualAdd person to my list of Trusted Payees
MerchantAdd merchant to my list of Trusted Payees
BusinessAdd business to my list of Trusted Payees
CharityAdd charity to my list of Trusted Payees
GovernmentBodyAdd government body to my list of Trusted Payees
Other or not providedAdd to my list of Trusted Payees

Permissions and Data Access

The table below describes the text shown to users on the Consent Page.

PermissionsText shown to user on Consent Page
ReadAccountsBasicYou also grant us permission to access your account details before making the payment.
ReadAccountsDetailYou also grant us permission to access your account details before making the payment.
ReadRefundAccountYou also grant us permission to access your account details in order to process a refund.
ReadPartyIdentityYou also grant us permission to access your identity details (your name and Emirates ID) before making the payment.
ReadAccountsBasicReadAccountsDetailYou also grant us permission to access your account details before making the payment.
ReadAccountsBasicReadBalancesYou also grant us permission to access your account details and balance before making the payment.
ReadAccountsBasicReadRefundAccountYou also grant us permission to access your account details before making the payment, as well as to process refunds.
ReadAccountsBasicReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment.
ReadAccountsDetailReadBalancesYou also grant us permission to access your account details and balance before making the payment.
ReadAccountsDetailReadRefundAccountYou also grant us permission to access your account details before making the payment, as well as to process refunds.
ReadAccountsDetailReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment.
ReadRefundAccountReadPartyIdentityYou also grant us permission to access your identity details (your name and Emirates ID) before making the payment, as well as your account details in order to process a refund.
ReadAccountsBasicReadAccountsDetailReadBalancesYou also grant us permission to access your account details and balance before making the payment.
ReadAccountsBasicReadAccountsDetailReadRefundAccountYou also grant us permission to access your account details before making the payment, as well as to process refunds.
ReadAccountsBasicReadAccountsDetailReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment.
ReadAccountsBasicReadBalancesReadRefundAccountYou also grant us permission to access your account details and balance before making the payment, as well as to process refunds.
ReadAccountsBasicReadBalancesReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment.
ReadAccountsBasicReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment, as well as to process refunds.
ReadAccountsDetailReadBalancesReadRefundAccountYou also grant us permission to access your account details and balance before making the payment, as well as to process refunds.
ReadAccountsDetailReadBalancesReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment.
ReadAccountsDetailReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment, as well as to process refunds.
ReadAccountsBasicReadAccountsDetailReadBalancesReadRefundAccountYou also grant us permission to access your account details and balance before making the payment, as well as to process refunds.
ReadAccountsBasicReadAccountsDetailReadBalancesReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment.
ReadAccountsBasicReadAccountsDetailReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details and identity details before making the payment, as well as to process refunds.
ReadAccountsBasicReadBalancesReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment, as well as to process refunds.
ReadAccountsDetailReadBalancesReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment, as well as to process refunds.
ReadAccountsBasicReadAccountsDetailReadBalancesReadRefundAccountReadPartyIdentityYou also grant us permission to access your account details, balance and identity details before making the payment, as well as to process refunds.
Account-Driven Behaviour

UI Behaviour Driven by Account State

Some Authorisation Page behaviours are not driven by fields in the consent request — they are driven by the customer's account state or account-level settings at the LFI. The TPP cannot control these; the LFI determines them at the point of authorisation.

Use the Simulated Accounts Behaviour panel above to preview each state.

Warnings & Priority

The LFI may surface one of three warnings on the Authorisation Page based on the account and payment state. Only one warning is shown at a time, with the following priority order:

PriorityWarningWarning Text
1 (highest)Payment Limit ExceededPayment limit exceeded — The amount exceeds the payment limit you've set on your account. You may need to change your settings or try a smaller amount.
2OverdraftThis payment will take your selected account into an overdraft/unarranged overdraft.
3Duplicate Payment AlertDuplicate Payment Alert — Our systems indicate that you have already made a payment of the same amount to this beneficiary in the last 24 hours. Please check and ensure that you are not making a duplicate payment.

If a higher-priority warning applies, lower-priority warnings are suppressed. For example, if both a payment limit breach and a duplicate are detected, only the Payment Limit Exceeded warning is shown.

Trusted Payees

The LFI shows the "Add to my list of Trusted Payees" checkbox only if the creditor is not already a trusted payee on the customer's account. If the creditor is already a trusted payee, the checkbox is suppressed. The wording of the checkbox label is driven by an API field — see Trusted Payees Wording under UI Behaviour Driven by API Fields.

Creditor status on the customer's accountAuthorisation Page Behaviour
Not already a trusted payeeThe checkbox is shown.
Already a trusted payeeThe checkbox is suppressed.
03 Examples

Sample user journeys

Example 1 — User selects account at LFI

single-instant-payment-journey
single-instant-payment-journey

Example 2 — User selects account at TPP (duplicate payment warning)

single-instant-payment-journey
single-instant-payment-journey

Example 3 — User selects account at TPP (overdraft warning)

single-instant-payment-journey
single-instant-payment-journey

Example 4 — User selects account at LFI (OnBehalfOf passed in by TPP)

single-instant-payment-journey
single-instant-payment-journey