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

Stop Mandate Execution

There can always be cases when post calling Mandate Execution , there would be a requirement for stopping the execution post notification being sent on account

User making payment themselves
Revoking it from merchant’s end
Where notification was sent then requirement of payment did not arrive.

In these cases, in order to stop the payment , we can stop the mandate payment order from being executed.

Execution needs to be stopped at least 30 mins before scheduled execution time.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/mandates/{mandate_id}

Production Link

POST

https://api.juspay.in/mandates/{mandate_id}

                      Basic Auth
                      *
                      

required

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      *
                      

String

Mandatory

Merchant ID which would have been issues while registering with Juspay

Example:- 7SucJZ2PCyoGY5vvW8Xa26

                      Content-Type
                      *
                      

String

Mandatory

Example:- application/x-www-form-urlencoded

                      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

                      mandate_id
                      *
                      

String

Mandatory

Mandate Id of the mandate executed

Body

Request Schema: application/json

                      command
                      *
                      

String

Mandatory

Example:- cancel_recurring_transaction

                      order_id
                      *
                      

String

Mandatory

Order_id of the order that has been executed

Example - test_recurring_1697711432