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

Mandate Update API

AIM: Adding a new feature for allowing merchants to update valid fields which are supported for that gateway and payment method type combination.

Add new command ‘update’ in the existing /mandate/:mandateId api, which will take a new parameter ‘updated_fields’

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
                      *
                      

Base64 Encoded Username:Password

Required

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      
                      

String

Example:- application/json

                      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

Body

Request Schema: application/json

                      command
                      
                      

String

Example:- update

                      updated_fields
                      
                      

Object

                      amount
                      
                      

String

Example:- 100

                      end_date
                      
                      

String

Example:- 1717670006

                      frequency
                      
                      

String

Example:- ASPRESENTED

Response Body

                      updatedFields
                      
                      

Object

                      end_date
                      
                      

String

Example:- 2061-10-10T00:00:00Z

                      mandate
                      
                      

Object

                      order_id
                      
                      

String

Example:- bd_1726477951

                      frequency
                      
                      

String

Example:- ASPRESENTED

                      end_date
                      
                      

String

Example:- 2832969600

                      status
                      
                      

String

Example:- UPDATE_PENDING

                      activated_at
                      
                      

String

Example:- 2024-09-16T14:58:08Z

                      last_activated_at
                      
                      

String

Example:- 2024-09-17T13:08:13Z

                      amount_rule
                      
                      

String

Example:- VARIABLE

                      last_updated
                      
                      

String

Example:- 2024-09-17T13:08:13Z

                      start_date
                      
                      

String

Example:- 1726477958

                      mandate_debit_token
                      
                      

String

Example:- tkn_4d0dc686b85d46b69b5aea078c09c540

                      customer_id
                      
                      

String

Example:- cst_t1bbcrzxzofcxkjs

                      mandate_id
                      
                      

String

Example:- hTdCX9eFC6EyjttVDJagq2

                      block_fund
                      
                      

Boolean

Example:- false

                      currency
                      
                      

String

Example:- INR

                      max_amount
                      
                      

String

Example:- 1000

                      mandate_token
                      
                      

String

Example:- 8f076e2e12004b8bb2478b188ac3202f

                      rule_value
                      
                      

String

Example:- 1

                      revokable_by_customer
                      
                      

Boolean

Example:- true

                      payment_info
                      
                      

Object

upi

Object

                      payer_vpa
                      
                      

String

Example:- billdesk@vpa

                      payment_method
                      
                      

String

Example:- COLLECT

                      payment_method_type
                      
                      

String

Example:- UPI

                      gateway_reference_id
                      
                      

String

Example:- billuat

                      mandate_type
                      
                      

String

Example:- EMANDATE

                      rule_type
                      
                      

String

Example:- AFTER

                      isPending
                      
                      

Boolean

Example:- true