v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB

Voids

Create a void

Cancels a payment authorisation before it is captured, releasing the amount held on the card. Works for single and frequent authorisations.

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">void:create</code>

post/void/{id}

Path parameters

idstring uuid required

The token of the operation to cancel — the single or frequent payment authorisation token.

Request body

descriptivestring required

Free-text reason for the void. Required, up to 255 characters. This will appear in the bank statement / MB WAY application.

transaction_keystring

Optional. Your own internal key identifying this void, up to 50 characters. Echoed back on the void details.

Example request

{
  "descriptive": "Cancelling the duplicated authorisation",
  "transaction_key": "order-1982652-void"
}

Response

Created

statusstring

messagestring[]

An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

idstring

A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

Example response

{
  "status": "ok",
  "message": [
    "Your request was successfully created"
  ],
  "id": "8010e7d5-9985-4ae3-b1bf-6b70019439c7"
}