Skip to content

UI Behaviour Driven by API Fields

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.

Merchant Details

When a TPP processes payments on behalf of a merchant (e.g. a payment aggregator), Risk.CreditorIndicators.MerchantDetails.MerchantName can be passed to identify the merchant to the user on the LFI Authorisation Page.

Risk.CreditorIndicators.MerchantDetails.MerchantNameLFI Authorisation Page Behaviour
Passed inThe merchant name is displayed on the Authorisation Page alongside the creditor details, indicating that the payment is being made on behalf of that merchant. (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.
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.
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.
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.
ReadAccountsBasicReadBalancesReadRefundAccountYou also grant us permission to access your account details and balance 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.
ReadAccountsBasicReadAccountsDetailReadBalancesReadRefundAccountYou also grant us permission to access your account details and balance before making the payment, as well as to process refunds.

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.