Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Consents Account On File

Create a new AoF consent

Creates a new Account-on-File consent that can be authorized later.

post/consents/v1/account-on-file

Request body

customer_idstring uuid required

The unique identifier of the customer for whom the consent is being created.

destination_account_idstring uuid required

The unique identifier of the account acting as a consent beneficiary.

currencystring required

The ISO 3 letter currency code

referencestring required

A reason or reference in relation to a payment. Maximum 64 chars

purpose'FIS' | 'TCS' | 'MWP' | 'OAT' | 'IFS' | 'RNT' | 'LNC' | 'PIN' | 'GDS' required

A category code that relates to the type of services or goods that corresponds to the underlying purpose of the payment.
The code must conform to the payment purpose code list.
Supported values:

  • FIS – Financial services
  • TCS – Telecommunication services
  • MWP – Mobile wallet card payments
  • OAT – Own account transfer
  • IFS – Information services
  • RNT – Rent payments
  • LNC – Loan charges
  • PIN – Personal investments
  • GDS – Goods bought or sold
start_date_timestring date-time nullable

The date and time when the consent becomes active.
Optional. Defaults to the current date and time if not provided.

expiration_date_timestring date-time nullable

The date and time when the consent expires.
Optional. Defaults to one year after start_date_time if not provided.

Example request

{
  "customer_id": "acc176ca-7716-4fbb-a735-d0e3dec24b40",
  "destination_account_id": "911f30d8-8fc8-4fe9-86a1-3f9fea11a674",
  "currency": "AED",
  "reference": "Invoice #12345",
  "start_date_time": "2025-07-11T16:58:03.559872Z",
  "expiration_date_time": "2026-07-11T16:58:03.559872Z",
  "immediate_payment": {
    "amount": 123.45,
    "reference": "Invoice #12345"
  }
}

Response

Consent created successfully

idstring uuid required

The unique identifier for the consent. Provided as a UUID.

application_idstring required

Application identifier owning this consent

start_date_timestring date-time required

Date and time from when the consent will be active

expiration_date_timestring date-time required

Date and time of the expiration of this consent

customer_idstring uuid required

Id of a customer that this consent belongs to

status'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'REVOKED' | 'REJECTED' | 'EXPIRED' | 'CONSUMED' | 'SUSPENDED' required

Current status of this consent.

destination_account_idstring uuid required

Account id that this consent allows payments to

referencestring required

A reason or reference in relation to a payment. Passed as a part of OF creditor_reference. This value will be used as default reference for payments made with this consent.

currencystring required

The ISO 3 letter currency code

purpose'FIS' | 'TCS' | 'MWP' | 'OAT' | 'IFS' | 'RNT' | 'LNC' | 'PIN' | 'GDS' required

A category code that relates to the type of services or goods that corresponds to the underlying purpose of the payment.
The code must conform to the payment purpose code list.
Supported values:

  • FIS – Financial services
  • TCS – Telecommunication services
  • MWP – Mobile wallet card payments
  • OAT – Own account transfer
  • IFS – Information services
  • RNT – Rent payments
  • LNC – Loan charges
  • PIN – Personal investments
  • GDS – Goods bought or sold

Example response

{
  "currency": "AED",
  "immediate_payment": {
    "amount": 123.45,
    "reference": "Invoice #12345"
  }
}