ACacquired
Variable Recurring Payments

List open banking mandates

Changed on

Returns a paginated list of Open Banking mandates.

get/open-banking/mandates

Request

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' | '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

OK

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": "authorized",
      "reference": "REF-123456",
      "currency": "GBP"
    }
  ]
}

Changes

  • 9c9e8ec96e98Revision changes
    • breaking

      removed the enum value VISA_A2A from the query request parameter type

    • warning

      added the new authorized enum value to the /// response property for the response status

    • warning

      added the new awaiting_authorization enum value to the /// response property for the response status

    • warning

      added the new awaiting_initiation enum value to the /// response property for the response status

    • warning

      added the new cancelled enum value to the /// response property for the response status

    • warning

      added the new expired enum value to the /// response property for the response status

    • warning

      added the new rejected enum value to the /// response property for the response status

    • warning

      added the new unknown enum value to the /// response property for the response status

    • info

      removed the VISA_A2A enum value from the /// response property for the response status

    • info

      the /// response's property pattern was changed from ^[A-Za-z]{3}$ to ^[A-Z]{3}$ for the status