v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Direct Debit

Cancel a mandate

This API endpoint allows for the immediate cancellation of a mandate. Any custom data supplied to this endpoint will be linked to the resulting mandate cancellation event. Please be aware that this process will fail if the mandate is not in an active status. Once a mandate has been cancelled, it cannot be reverted to an active status, in this case a new mandate must be created.

post/mandates/{mandate_id}/cancel

Path parameters

mandate_idstring uuid required

Unique ID assigned by Acquired.com for the 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.

Request body

custom_datastring required

Assign a base64 encoded reason to your cancellation request. This field is required as we pass the value from this field downstream to our Direct Debit provider who require a cancellation reason.

Example request

{
  "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
}

Response

status'success'

The outcome of the request