ACacquired
Variable Recurring Payments

Create an open banking mandate

Changed on

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

Mandate type must be one of: SWEEPING or COMMERCIAL.

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

post/open-banking/mandates

Request

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 in upper case.

type'SWEEPING' | '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,
      "currency": "GBP"
    },
    "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.

auth_urlstring uri

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

Example response

{
  "mandate_id": "xxx-mandate-xxxx",
  "auth_url": "https://bank.example.com/oauth/authorize?state=xxx&client_id=xxx",
  "links": [
    {
      "rel": "self",
      "href": "/v1/open-banking/mandates/xxx-mandate-xxxx"
    }
  ]
}

Changes

  • 9c9e8ec96e98Revision changes
    • breaking

      added the new required request property //

    • breaking

      removed the enum value VISA_A2A of the request property

    • warning

      changed the pattern of the request property from ^[A-Za-z]{3}$ to ^[A-Z]{3}$

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status