Void Order

Overview

Use the Void Order endpoint to void orders where funds have been authorized, but not settled. An order amount can be voided in full or partially voided up to the amount of funds that have been authorized but not captured.

API Request

πŸ‘

This endpoint uses MAC with SHA-256

Check out our API Authentication section to learn more

The request body may contain a voidAmount. If this field is not passed with the request body, the total amount of the order be voided.

To Void an order, send an API call to:

POST {{baseUrl}}/orders/{{orderId}}/void

Request Body Parameters

ParameterRequired?TypeDescription
voidAmountNoIntegerInclude this field for partial order voiding. If this field is not passed with the request body, the total amount of the order be voided.

Note: that the void amount cannot exceed the total amount of funds that have been captured.

Request Body Example

{
  "voidAmount": 1523 // $15.23
}

API Response:

Response Body Parameters

Response ParameterTypeDescription
voidTransactionIdstringTransactionId from the Payment Gateway
statusstring"success" or "failure"
errorCodestring, nullableError code supplied by the payment gateway if a failure occurred
transactionIdsarrayList of all transactionIds related to the order, supplied to us from the payment gateway
gatewayResponsestringRaw response from the payment gateway

Response Body Example

{
  "voidTransactionId": "115245",
  "status": "Failure", 
  "errorCode": "102",
  "transactionIds": [
    "54270a3e-a0b6-424b-83c2-4d3ab976acd2",
  ],
  "gatewayResponse": "string"
}

πŸ‘

API Reference

Check out our API Reference to learn more



Skipify baner with link to contact us form