Body
Cancel Order API
This document provides technical guidance for merchants to cancel an active payment link via the API.
Note
A cancelled order cannot be reactivated. A new payment link must be generated if needed.
Ensure the order being cancelled is in
ACTIVEstate; otherwise, cancellation may fail or have no effect.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/merchants/{merchant_id}/order/{order_id}/cancel
Production Link
POST
https://api.juspay.io/merchants/{merchant_id}/order/{order_id}/cancel
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Required
Base 64 encoded API key
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
Content-Type
*
String
Required
Example:- application/json
x-merchantid
*
String
Required
Merchant ID provided by Juspay
Example:- merchant_id
Path Params
merchant_id
*
String
Required
Merchant ID provided by Juspay
order_id
*
String
Required
Order Id for which cancellation is required
Request Schema: application/json
Basic Parameters
cancel_reason
*
String
Required
Reason for cancellation
Example:- Testing
200 : Success
Response Body
status
String
Example:- Success
message
String
Example:- Order cancelled successfully
order_id
String
Example:- 1747643180
400 : Invalid Input data
Response Body
error_message
String
Example:- Order with id = "ORDER176432906" does not exist.
status
String
Example:- invalid_request_error
error_info
Object
user_message
String
Example:- Could not find Order with order_id : ORDER176432906
fields
Array
request_id
String
Example:- 7167f1f5-e6e0-4013-8687-962bee70a73f
href
String
Example:- NA
developer_message
String
Example:- order_id is invalid.
code
String
Example:- RESOURCE_NOT_FOUND
category
String
Example:- USER_ERROR
401 : Authentication Failed
Response Body
status
String
Example:- error
error_code
String
Example:- access_denied
error_info
Object
user_message
String
Example:- Unauthorized.
request_id
String
Example:- 0a671060-7c4a-444c-a06e-167eb90d47a4
href
String
Example:- NA
developer_message
String
Example:- Invalid API Key. Please pass a valid and active api key.
code
String
Example:- UNAUTHORIZED
category
String
Example:- USER_ERROR