POST /v1/direct/order/void-request
Headers
api-key: Server API key provided via secure email or the merchant dashboard
JSON Schema
JSON
{
"orderID":{
"type":"string",
"description":"This orderID is the one generated by your integration. If you are using an integration like Salesforce this will be the ID of the order created in Salesforce.",
"required":true
},
"amount":{
"type":"number",
"description":"Specified when the cancel request is a partial cancellation request with a specific amount. This amount must be less than the order total."
}
}
Response Codes
Code | Description |
---|---|
201 | Request created |
400 | Headers or request body were not provided correctly |
401 | API Key not valid |
403 | API Key cannot access this resource |
422 | The order is in a state where capture cannot be requested, e.g., refunded |
500 | Internal server error |