POST /companies/{companyId}/terminalOrders/{orderId}/cancel
Cancels the terminal products order identified in the path. Cancelling is only possible while the order has the status Placed. To cancel an order, make a POST call without a request body. The response returns the full order details, but with the status changed to Cancelled.
To make this request, your API credential must have the following role:
- Management API—Terminal ordering read and write
Servers
- https://management-test.adyen.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
orderId |
String | Yes |
The unique identifier of the order. |
companyId |
String | Yes |
The unique identifier of the company account. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.