v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Direct Debit

Create a mandate

The first step in the Direct Debit process is to create a mandate. A mandate must be logged against a customer's bank account before Direct Debit collections can be made.

post/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

customer_idstring uuid required

Unique ID assigned by Acquired.com to the customer when it is created.

mandate_type'direct_debit' required

The type of mandate that is being created.

sort_codestring required

The sort code for the customer's bank account.

account_numberstring required

The account number for the account.

account_namestring required

The name on the bank account.

referencestring required

The internal reference assigned to the mandate.

Example request

{
  "customer_id": "21626628-cf4f-4b7d-82de-6df6925546a8",
  "mandate_type": "direct_debit",
  "sort_code": "123456",
  "account_number": "87654321",
  "account_name": "Mr E Johnson",
  "reference": "Custom Ref 001"
}

Response

Created

status'pending'

mandate_idstring uuid

Unique identifier assigned by Acquired.com for the mandate record.

Example response

{
  "status": "pending",
  "mandate_id": "413516ad-2ba7-49f0-92a1-6900cc14f5ea"
}