Body
Mandate Registration API
Use this API to choose the preferred mode of payment for the mandate. Supported Payment Methods include Card, PIX_QR.
Share the URL that you get in the response body with your end customer, for whom this mandate is being initiated. They will have to run the same to authorise the collect request from their UPI App.
The API is not required for the merchants using Juspay's Payment Page product.
Note
For Cards mandates,
To enable mandate on new card transactions,
Tokenization is mandatory for card mandate creation.
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/txns
Production Link
POST
https://api.juspay.io/txns
Headers
Content-Type
string
It should be `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.
Warning
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
Parameters
order_id
*
string
Mandatory
Unique Identifier for the order.
merchant_id
*
string
Mandatory
ID of the merchant_account that you hold with us.
payment_method_type
*
string
Mandatory
Payment method type of transaction.
Possible values: CARD, RTP (for PIX AUTOMATICO).
payment_method
*
string
Mandatory
Payment method of transaction.
Payment Method API in the payment_method field.
For card mandate - One of VISA/MASTERCARD/AMEX. This is usually inferred from the card number itself and we will take care of this if you are unable to provide this from your end.
For PIX AUTOMATICO - PIX_QR needs to be passed.
redirect_after_payment
*
boolean
Mandatory
We recommend that you set this to true and use the redirection flow.
If set to true, then the user is redirected to the return_url configured for the order.
If set to false, then the user will be stopped at the response page from the gateway.
Your client should be able to read the page/title to infer that the user has completed the transaction.
format
*
string
Mandatory
If it is set to json, then the response will be HTTP 200 with a JSON formatted text. Otherwise, the response is HTTP 302 with the Location attribute having the destination URL.
mandate_type
*
string
Mandatory
EMANDATE in case of PIX_QR/Wallet.
MANDATE in case of card
should_create_mandate
boolean
This is a customer’s consent flag. This should be always TRUE in case of a mandate transaction.
bank_account_number
string
Bank account number. Required for emandate.
Not required for PIX AUTOMATICO.
bank_ifsc
string
Bank IFSC. Required for emandate.
Not required for PIX AUTOMATICO.
bank_beneficiary_name
string
Account holder name. Should contain alphabetical characters only. Required for emandate/e-NACH.
Not required for PIX AUTOMATICO.
bank_account_type
string
Possible values are SAVINGS, CURRENT. Default value will be “SAVINGS”
Not required for PIX AUTOMATICO.
card_token
string
A valid card token obtained using /card/list API. If you send this parameter, then card_number, name_on_card, card_exp_year, card_exp_month fields are not required.
If the token is generated using the /card/tokenize API, card_number, name_on_card, card_exp_year, card_exp_month and card_security_code fields are not required. Required for mandate_type= MANDATE for stored card.
Not required for PIX AUTOMATICO.
card_number
string
A valid credit/debit card number. Required when mandate_type = MANDATE for a new card transaction.
card_exp_year
string
Represent the expiry year of the card as YY (two digits only).
Required when mandate_type = MANDATE for a new card transaction.
card_exp_month
string
Represent the expiry month of the card as MM (two digits only). Required when mandate_type = MANDATE for a new card transaction.
card_security_code
string
CVV of the card. Usually three digits. Required when mandate_type = MANDATE for a new card transaction.
name_on_card
string
Card holder name. Should contain alphabetical characters only. Required when mandate_type = MANDATE for a new card transaction.
save_to_locker
string
This is a boolean variable and accepts true/false. If set to true, then the card will be saved in locker when the transaction is successful. Else, the card will not be saved.
200 : Success
Response Body
UPI Collect/Card/NB
JSON
txn_uuid
String
txn_id
String
Transaction ID for the payment attempt.
status
String
Status of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete.
payment
object
authentication
object
url
String
URL to which the user has to be taken to for completing the authentication
method
String
HTTP Method for authentication. Can be one of GET or POST
order_id
String
Unique Identifier for the order.
UPI Intent
JSON
txn_uuid
String
txn_id
String
Transaction ID for the payment attempt.
status
String
Status of the transaction. PENDING_VBV indicates that the transaction requires authentication to complete.
payment
Object
sdk_params
object
uri_params
object
validitystart
String
validityend
String
tr
String
tn
String
tid
String
recur
String
purpose
String
pn
String
pa
String
orgid
String
mode
String
mn
String
mc
String
cu
String
amrule
String
am
String
scheme
String
authentication
object
url
String
URL to which the user has to be taken to for completing the authentication
method
String
HTTP Method for authentication. Can be one of GET or POST
order_id
String
offer_details
object
offers
array
Have questions?
- Need help? Contact support
- LLM? Read llms.txt