Cancel / Void Order

Learn how to cancel orders where funds have been authorized, but not captured

Overview

Use the Cancel/Void Order endpoint to cancel orders where funds have been authorized, but not settled.

👍

This endpoint uses HMAC with SHA-256

Check out our API Authentication section to learn more

To cancel an order, send an API call to:

Staging: POST https://orders-management.staging.skipify.com/{orderId}/cancel

Production: POST https://orders-management.skipify.com/{orderId}/cancel

Request Body Parameters

Parameter NameRequiredTypeDescription
transactionIdnostringPass the transactionId received from the ORDER_PAYMENT_SUCCEEDED webhook event.
This can be passed in all cases. It is required in a split-payment scenario, when multiple transactions are tied to one orderId.

Request Body Example

{
  "transactionId": "string"
}

API Response

Response Body Parameters

Parameter NameTypeDescription
orderIdstringThe Skipify order id
merchantIdstringThe Skipify Merchant identifier
transactionIdstringThe Skipify transaction identifier
statusstringAllowed Values = Cancelled, Failed
messagestring, nullableThis message will be populated if there was an error processing the cancel

Response Body Example

{
  "orderId": "string",
  "merchantId": "string",
  "transactionId": "string",
  "status": "Cancelled",
  "message": "string"
}

Skipify baner with link to contact us form

What’s Next