v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Variable Recurring Payments

List open banking mandates

Returns a paginated list of Open Banking mandates.

get/open-banking/mandates

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

customer_idstring uuid

Filter results to cards stored against a specific customer_id.

bank_idstring

Filter by supported bank identifier.

referencestring

Filter by mandate reference.

type'SWEEPING' | 'VISA_A2A' | 'COMMERCIAL'

Filter by mandate type.

transaction_idstring uuid

Filter by Acquired transaction identifier.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Response

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "id": "xxx-mandate-xxxx",
      "bank_id": "xxx-bank-xxxx",
      "type": "SWEEPING",
      "status": "active",
      "reference": "REF-123456",
      "currency": "GBP"
    }
  ]
}