Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Consents

List customers consents

Retrieves a paginated list of payment consents for the specified customer.

get/consents/v1

Query parameters

customer_idstring uuid required
Example:123e4567-e89b-12d3-a456-426655440000
statusConsentStatus[]

Optional list of consent statuses to filter by

[
  "AUTHORISED"
]
page_numberinteger

Indicator of which page of results to return, starts at 0

page_sizeinteger

Size of a single page of results to return

Response

OK

Example response

{
  "data": [
    {
      "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"
      }
    }
  ]
}