v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

/orders/{orderId}/void

Sandbox (Testing): https://gateway.sand.us.zip.co/orders/{orderId}/void

Voids uncaptured funds for the specified order and allocates them to the payment plan to apply it to the customer. Only applicable to pay-on-ship/deferred fund capture merchants. If sync query parameter is set to true, replies synchronously with callback payload, otherwise, replies asynchronously on callback URL. Default sync value is false for asynchronous behavior.

post/orders/{orderId}/void

Path parameters

orderIdstring required

Query parameters

syncboolean

Headers

QP-Territorystring required

Territory of the request (US)

X-QP-Signaturestring required

The signature for merchant validation

Request body

merchantIdstring required

Gets or sets the MerchantId

currencystring required

Gets or sets the Currency of the capture

amountnumber double required

Gets or sets the Amount of the capture

merchantReferencestring required

Gets or sets the Merchant Reference of the capture

callbackUrlstring

Gets or sets the url to callback with the void result

testboolean

Gets or sets a value indicating whether this is a test order

metadataobject

Gets or sets optional metadata associated with this capture

isAmountInCommandboolean

Gets or sets a flag indicating whether or not the command amount is set and not defaulted. By default, the void amount is included in the command.

Response

200

timestampstring

merchantIdstring

orderIdstring

currencystring

amountinteger

merchantReferencestring

testboolean

successboolean

messagestring

operationstring

Example response

{
  "timestamp": "2021-12-01T16:38:44.237Z",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "string",
  "merchantReference": "string",
  "test": true,
  "success": true,
  "message": "string",
  "metadata": {
    "additionalProp": "string"
  },
  "operation": "string"
}