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 API Key Authentication
Check out our API Key Authentication Section section to learn more
To cancel an order, send an API call to:
Staging:
POST https://orders-management.staging.skipify.com/{orderId}/cancelProduction:
POST https://orders-management.skipify.com/{orderId}/cancel
Request Body Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| transactionId | no | string | Pass 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 Name | Type | Description |
|---|---|---|
| orderId | string | The Skipify order id |
| merchantId | string | The Skipify Merchant identifier |
| transactionId | string | The Skipify transaction identifier |
| status | string | Allowed Values = Cancelled, Failed |
| message | string, nullable | This 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"
}
Updated about 1 month ago
What’s Next