Sign in

v1

latestOpenAPI 3.0.32026-07-248079274.0 KB
Direct Debit

Cancel a Direct Debit

Use this function to cancel a Direct Debit transaction if it hasn't been submitted to the banks. Any custom data supplied to this endpoint will be stored against the payment cancellation event. Please be aware that this process will fail if the transaction is not in pending status.

post/transactions/{transaction_id}/cancel

Path parameters

transaction_idstring uuid required

Unique ID assigned by Acquired.com for the transaction.

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

Enables the inclusion of extra information associated with the retry process for the collection.

Example request

{
  "custom_data": "L3BheW1lbnQtbGlua3MgcGF5IGN1c3RvbV9kYXRh"
}

Response

OK