Cancel order

Cancel an order or mark it as complete

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to terminate an order using the order number.

If the order has a preliminary status, which is before the customer makes an approved payment or card registration, the API will set the order status to Cancelled. This includes orders with the Draft, Pending, and Rejected status.

If the order has a live status, which is after an approved payment or card registration, the API will set the order status to Complete. This includes orders with the Active, Failed, Suspended, Paused, and Review status.

You cannot cancel or complete an order that is already Cancelled or Completed.

Path Params
int32
required

The system identifier of the order

Query Params
int32

If you have more than one profile, you must supply the ID of the profile to use

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json