Skip to content

Creditor v2.1

At consent validation — POST /consent/action/validate — the LFI MUST validate Initiation.Creditor in the decrypted PII against three concerns:

  1. Cardinality — the shape of Initiation.Creditor matches a beneficiary model permitted by the requested payment type.
  2. Mandatory fields — every entry carries the fields required for a UAE domestic payment.
  3. Domestic creditor validity — each entry names an account reachable on a supported UAE domestic rail.

If any check fails, the LFI MUST mark the consent invalid in its validate response — see Rejecting an invalid consent below.

Cardinality — beneficiary model

The shape of Initiation.Creditor determines the beneficiary model. Three models are defined:

Beneficiary modelInitiation.Creditor
SingleArray of exactly 1 entry
MultipleArray of 2–10 entries
OpenArray omitted — no creditor fixed at consent time

Each payment type accepts only certain beneficiary models. The LFI MUST reject a consent where the cardinality doesn't align with a model permitted for the requested payment type. The allowed models are documented on each payment type's Requirements page (e.g. Variable On-Demand — Requirements).

Mandatory fields

For every entry in Initiation.Creditor[], the following fields MUST be present for a UAE domestic payment:

FieldRule
CreditorAccount.SchemeNameMUST be "IBAN""AccountNumber" is not valid for domestic payments
CreditorAccount.IdentificationMUST be a valid UAE IBAN
CreditorAccount.Name.en OR CreditorAccount.Name.arAt least one MUST be present

If any required field is missing, SchemeName is set to "AccountNumber", or the IBAN is invalid, the LFI MUST invalidate the consent.

Schema conformance — including additionalProperties: false at every level — is enforced through the OpenAPI spec. See How to Decrypt PII for how to plug the PII schema into a validator.

CreditorAgent

ScenarioLFI behaviour
CreditorAgent.Identification not providedLFI MUST derive the BIC from the IBAN
CreditorAgent.Identification providedMUST be in 8- or 11-character BIC format, and MUST match the BIC derivable from the IBAN

Domestic creditor validity

For each entry, the LFI MUST validate that the creditor account is reachable on a supported UAE domestic rail — AANI or UAEFTS. Where the LFI can determine the state of the receiving account, it MUST also check that the account is able to receive payments.

If any check above fails, the LFI MUST mark the consent invalid in its POST /consent/action/validate response. The API Hub will then reject the consent back to the TPP.

json
{
  "data": {
    "status": "invalid",
    "code": "InvalidCreditor",
    "description": "Creditor validation failed: <reason>."
  },
  "meta": {}
}

See Consent Events & Actions — API Guide for the full POST /consent/action/validate flow and response schema.