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

Cancel API

This API can be used to schedule a fulfillment for cancellation. The merchant needs to provide the fulfillment ID in the API request.

Please note that triggering the cancel API does not guarantee the cancellation of the fulfillment. Merchants should always verify the status of the fulfillment via the dashboard or by using the status API after a short period to check whether the fulfillment is cancelled or not.

An fulfillment can only be canceled in some certain circumstances only. We will try to cancel as best case scenario, but we can't guarantee the outcome. - in case the order is already attempted/pending at downstream gateway or picked for attempt in our transaction processing queue it cannot be cancelled

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/payout/merchant/v1/fulfillment/:fulfillmentId/cancel

Production Link

POST

https://api.juspay.in/payout/merchant/v1/fulfillment/:fulfillmentId/cancel

                      Basic Auth
                      *
                      

String

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Pass merchant-id provided by Juspay

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      fulfillmentId
                      *
                      

String

Mandatory

Please pass the id of the fulfillment.

Response Body

                      status
                      
                      

String

Possible Values:
“Fulfillment is scheduled for cancelation. Please check order status for final status.”

Response Body

                      error
                      
                      

Boolean

                      errorCode
                      
                      

String

                      errorMessage
                      
                      

String

                      userMessage
                      
                      

String