Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Variable Recurring Payments

Create an open banking mandate

Creates an Open Banking mandate and returns details needed to continue the user authorisation journey.

Mandate type must be one of: SWEEPING, VISA_A2A, COMMERCIAL.

Where periodic limits specify an alignment, it must be one of: CALENDAR or CONSENT.

post/open-banking/mandates

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.

Request body

bank_idstring required

Identifier of the supported bank.

currencystring required

ISO 4217 currency code. Case-insensitive.

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

Mandate type. Case-insensitive; values are normalised to uppercase.

referencestring

Reference used for payments taken against this mandate.

order_idstring required

Merchant order identifier.

Example request

{
  "debtor": {
    "account_number": "12345678",
    "sort_code": "112233",
    "account_name": "J SMITH"
  },
  "bank_id": "xxx-bank-xxxx",
  "currency": "GBP",
  "periodic_limit": {
    "per_payment": {
      "maximum_amount": 25.5
    },
    "day": {
      "maximum_amount": 100,
      "alignment": "CALENDAR"
    },
    "week": {
      "maximum_amount": 250,
      "alignment": "CONSENT"
    },
    "fortnight": {
      "maximum_amount": 500
    },
    "month": {
      "alignment": "CALENDAR",
      "maximum_amount": 10
    },
    "half_year": {
      "alignment": "CONSENT",
      "maximum_amount": 5000
    },
    "year": {
      "alignment": "CALENDAR",
      "maximum_amount": 50000
    }
  },
  "type": "SWEEPING",
  "term": {
    "start_date": "2026-01-01T12:00:00Z",
    "end_date": "2027-01-01T12:00:00Z"
  },
  "reference": "REF-123456",
  "order_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Response

Created

mandate_idstring required

The unique ID assigned to the open banking mandate.

statusstring

Mandate status.

auth_urlstring uri

URL the customer should be redirected to in order to authorise the mandate.

created_atstring date-time

The time the mandate was created in UTC.

Example response

{
  "mandate_id": "xxx-mandate-xxxx",
  "status": "awaiting_authorisation",
  "auth_url": "https://bank.example.com/oauth/authorize?state=xxx&client_id=xxx"
}