Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Consents

Retrieve consent details

Retrieves a payment consent and its consumption data. Consumption data is returned only for authorized consents.

get/consents/v1/{consent_id}

Response

OK

consent_idstring uuid required

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

bank_identifierstring nullable

The identifier of the bank used to authorize this consent. Returns null if the consent has not been authorized.

application_idstring required

The application associated with the 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

Identifies which Customer owns the consent

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

sender_account_idstring uuid nullable

Account id from which payments are made under this consent. Returns null if the consent has not been authorized.

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

Example response

{
  "currency": "AED",
  "payment_consumption": {
    "cumulative_number_of_payments": 10,
    "cumulative_value_of_payments": 10000.05,
    "cumulative_number_of_payments_in_current_period": 5,
    "cumulative_value_of_payments_in_current_period": 5000.05
  },
  "immediate_payment": {
    "amount": 123.45,
    "reference": "Invoice #12345"
  }
}