JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Cancel Order API

This document provides technical guidance for merchants to cancel an active payment link via the API.

A cancelled order cannot be reactivated. A new payment link must be generated if needed.
Ensure the order being cancelled is in ACTIVE state; otherwise, cancellation may fail or have no effect.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/merchants/{merchant_id}/order/{order_id}/cancel

Production Link

POST

https://api.juspay.in/merchants/{merchant_id}/order/{order_id}/cancel

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Required

                      Content-Type
                      *
                      

String

Required

application/json

                      x-merchantid
                      *
                      

String

Required

Merchant ID provided by Juspay

                      merchant_id
                      *
                      

String

Required

Merchant ID provided by Juspay

                      order_id
                      *
                      

String

Required

Order Id for which cancellation is required

Body

Request Schema: application/json

                      cancel_reason
                      *
                      

String

Required

Reason for cancellation

Example: Duplicate Request

Response Body

                      status
                      
                      

String

Example:- Success

                      message
                      
                      

String

Example:- Order cancelled successfully

                      order_id
                      
                      

String

Example:- Order ID for which the request was for