---
title: "List open banking mandates"
method: GET
path: "/open-banking/mandates"
tags: ["Variable Recurring Payments"]
---

# List open banking mandates

`GET /open-banking/mandates`

Returns a paginated list of Open Banking mandates.

## Query parameters

- `offset` integer
- `limit` integer
- `customer_id` string, uuid
- `bank_id` string
- `reference` string
- `type` 'SWEEPING' | 'VISA_A2A' | 'COMMERCIAL'
- `transaction_id` string, uuid

## Headers

- `Company-Id` string, uuid
- `Mid` string, uuid

## Response `200`

OK

- OpenBankingMandateListPaged
  - `meta` object
    - `count` integer — The number of records returned as part of the response.
    - `offset` integer — The starting record number.
    - `limit` integer — The maximum number of records that can be returned as part of the response.
    - `total` integer — The total number of records contained in the query response.
    - `links` object[]
      - `rel` 'self' | 'first' | 'last' | 'prev' | 'next'
      - `href` string — Link to the resource which should be appended to base URL.
      - `title` string — Description of the link.
  - `data` OpenBankingMandate[]
    - `id` string — The unique ID assigned to the open banking mandate.
    - `bank_id` string — The unique ID associated with the bank the mandate has been created against.
    - `type` 'SWEEPING' | 'VISA_A2A' | 'COMMERCIAL' — The type of mandate that has been created.
    - `status` string — The current status of the mandate.
    - `reference` string — The reference used for payments made against this mandate.
    - `currency` string — ISO 4217 currency code. Case-insensitive.
    - `debtor` object
      - `customer_id` string, uuid
      - `account_number` string
      - `sort_code` string
      - `account_name` string
    - `periodic_limit` object — Periodic limits configured on the mandate.
    - `term` object — Mandate term (validity window).
    - `created_at` string, date-time — The time the mandate was created in UTC.

## Other responses

- `400`
- `401`
- `403`
- `500`

---

[API](https://skmtc.dev/acquired/apis/acquired-api.md) · [All operations](https://skmtc.dev/acquired/apis/acquired-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/acquired/acquired-api/revisions/7ae178a046f2/schema)