Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Variable Recurring Payments

Retrieve an open banking mandate

Returns an open banking mandate using the unique mandate_id. This identifier can be found via the mandate_active webhook or Hosted Checkout redirect after a customer authenticates their open banking connection.

get/open-banking/mandates/{mandate_id}

Path parameters

mandate_idstring required

The unique ID assigned to the open banking mandate.

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

idstring

The unique ID assigned to the open banking mandate.

company_idstring

Unique ID assigned by Acquired.com for your company.

bank_idstring

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.

currencystring

The currency allowed for payments taken against this mandate.

statusstring

The current status of the mandate.

referencestring

The reference to be used for payments made against this mandate.

created_atstring date-time

The time the mandate was created in UTC.

Example response

{
  "id": "01JZQ8E6GP4W4EKSGP9HARRJQG",
  "company_id": "123",
  "bank_id": "01K4VWY7EWQ48F710PWTVPFQ6J",
  "type": "SWEEPING",
  "debtor": {
    "account_number": "123456",
    "sort_code": "112233",
    "account_name": "J SMITH"
  },
  "creditor": {
    "account_number": "654321",
    "sort_code": "332211",
    "account_name": "ACQUIRED"
  },
  "currency": "GBP",
  "periodic_limit": {
    "per_payment": {
      "maximum_amount": 100
    },
    "day": {
      "maximum_amount": 5,
      "alignment": "CALENDAR"
    },
    "week": {
      "maximum_amount": 10,
      "alignment": "CONSENT"
    },
    "fortnight": {
      "maximum_amount": 10,
      "amount": 10,
      "alignment": "CONSENT"
    },
    "month": {
      "maximum_amount": 40,
      "alignment": "CALENDAR"
    },
    "half_year": {
      "maximum_amount": 500,
      "alignment": "CONSENT"
    },
    "year": {
      "maximum_amount": 100,
      "alignment": "CALENDAR"
    }
  },
  "status": "awaiting_initiation",
  "reference": "REF-01"
}