Cancel Order

View as Markdown
The **Cancel Order** is an **authenticated API** that allows users to **cancel an existing order** before payment is completed. This API is useful for cases where **users change their mind, enter incorrect details, or experience payment issues**. Once an order is **successfully canceled**, it cannot be **reversed**, and a new order must be placed.

Path parameters

orderidstringRequiredDefaults to 467b702d-81c4-4f05-aff2-31ef7ebcc83c

orderId is the id received from the API - api/v2/orders

Headers

authorizationstringRequiredDefaults to USER_AUTHORIZATION_TOKEN

Authorization token is the accessToken received from the API - api/v2/auth/verify

x-user-identifierstringOptionalDefaults to USER_EMAIL_ID

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

x-access-tokenstringOptionalDefaults to YOUR_ACCESS_TOKEN

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Note: This is applicable only for Auth Reliance Flows

Query parameters

cancelReasonstringRequiredDefaults to User requested cancellation
Reason to Cancel the order

Response

200 - Success

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error