ADadyen
Terminal orders - company level

Cancel an order

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

In the live environment, requests to this endpoint are subject to rate limits.

post/companies/{companyId}/terminalOrders/{orderId}/cancel

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/companies/{companyId}/terminalOrders/{orderId}/cancel
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

companyIdstring required

The unique identifier of the company account.

orderIdstring required

The unique identifier of the order.

Response

OK - the request has succeeded.

customerOrderReferencestring

The merchant-defined purchase order number. This will be printed on the packing list.

idstring

The unique identifier of the order.

orderDatestring

The date and time that the order was placed, in UTC ISO 8601 format. For example, "2011-12-03T10:15:30Z".

statusstring

The processing status of the order.

trackingUrlstring

The URL, provided by the carrier company, where the shipment can be tracked.

Changes

No recorded changes to this operation across all 50 revisions of this API.