v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Direct Debit

Retrieve a mandate

Utilize this endpoint to retrieve information associated with a specific mandate. Just add the necessary mandate_id to your request, and we will return the relevant data.

get/mandates/{mandate_id}

Path parameters

mandate_idstring uuid required

Unique ID assigned by Acquired.com for the mandate.

Query parameters

filterstring

Filter the parameters that you want to return within the response.

Response

mandate_idstring uuid

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

status'pending' | 'active' | 'rejected' | 'cancelled'

The current status of the mandate.

mandate_type'direct_debit'

The type of mandate that is being created.

referencestring

The internal reference assigned to the mandate.

bacs_referencestring

The Bacs reference assigned to the mandate by the scheme, as shown on the payer's bank statement. Returned as an empty string if not yet available.

createdstring date-time

The date and time that the mandate was created.

last_updatedstring date-time

The date and time that the mandate was last updated.

Example response

{
  "mandate_id": "82f67f47-f841-4dbe-98f3-dbc99fd9463f",
  "status": "rejected",
  "mandate_type": "direct-debit",
  "reference": "Custom ref 001",
  "bacs_reference": "ACQUIRED-123",
  "payer_detail": {
    "account_name": "Mr E Johnson",
    "account_number_ending": "1234"
  },
  "detail": {
    "scheme": "bacs",
    "report": "AUDDIS",
    "reason_code": "1",
    "reason_description": "Instruction cancelled"
  },
  "links": [
    {
      "rel": "customer",
      "href": "/v1/customers/a7e3fde5-5b83-44f4-9915-782bc7121717"
    }
  ]
}