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

UPI Intent

The API can be used for providing intent support on app, mobile web or web (Dynamic QR). When the Customer chooses the UPI app on the payment page and clicks the Pay button, Merchant calls Juspay’s transaction API with parameters depending on different payment methods chosen by the Customer. The API response will have the parameters required for constructing the intent URI. Merchant can then construct the URI and invoke the APP using chrome intent feature.

Please use the relevant parameters received from the Payment Method API in UPI for payment_method_type and payment_method fields.

Construction of UPI Pay String code through the string mentioned

The sdk_params obtained in the response of the UPI transaction call should be used for constructing the Intent URI.

Sample URI:
upi://pay?tr=202101345671229366&tid=121313202101345671229366&pa=juspay@axisbank&mc=1234&pn= Merchant%20Inc&am=1.00&cu=INR&tn=Pay%20for%20merchant

Format:
upi://pay?tr=...(enter the tr).......&tid=...(enter the tid).......&pa=.....(enter merchant_vpa)...&mc=....(enter the mcc)...&pn=....(enter
the Merchant name)...&am=.....(enter the amount).....&cu=INR&tn=....(description for the transaction)..

In the URI spaces are replaced by "%20". The URI is encoded. Kindly generate the intent URI dynamically ie, based on the params received in the sdk_params response. Do not hardcode any keys or values as it can differ with different PG’s.

How to create an intent from mWeb browser?

Once the URI is constructed, it should be embedded into the page. The mobile browser then checks for the UPI apps on the phone and displays them. Customer clicks on the app and completes the payment.

Sample Reference for chrome Intent is given below:
https://developer.chrome.com/multidevice/android/intents

How to handle payment status once the payment is completed?

Unlike in Web collect, where the success response is redirected to the merchant's return url as well as through server callback, in intent, only a callback response is posted on Merchant’s server. This is because UPI intent is an App to app switch push payment. While payment is being done via the UPI app, Merchant has to show a waiting/loader page on the background. Merchants should continuously poll their own server to check for Juspay callback of payment status and give the response in the frontend to the client side. Merchant can also call the order status API of Juspay to check the Order Status of the transaction.

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/txns

Production Link

POST

https://api.juspay.in/txns

                      Content-Type
                      *
                      

String

Mandatory

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

Body

                      merchant_id
                      *
                      

string

Mandatory

The merchant id associated with Juspay

                      order_id
                      *
                      

string

Mandatory

The order Id against which the payment has to be initiated

                      payment_method_type
                      *
                      

string

Mandatory

Must be UPI

                      payment_method
                      *
                      

string

Mandatory

Please use the relevant values received in payment_method field from the Payment Method API.

                      txn_type
                      *
                      

string

Mandatory

Must be UPI_PAY for Old UPI Intent Request. This field is obsolete for New UPI Intent Request

                      sdk_params
                      *
                      

boolean

Mandatory

Should be true for receiving the intent params

                      redirect_after_payment
                      
                      

boolean

This is a boolean variable and accepts true/false. 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

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.

Response Body

                      txn_uuid
                      
                      

string

eulgxNx4mgcnKwoqe2

                      txn_id
                      
                      

string

9727125664Q20200107180320

                      status
                      
                      

string

PENDING_VBV

                      payment
                      
                      

object

                      sdk_params
                      
                      

object

tr

String

tid

String

                      merchant_vpa
                      
                      

String

                      merchant_name
                      
                      

String

mcc

String

                      amount
                      
                      

String

                      authentication.url
                      
                      

String

                      authentication.method
                      
                      

String

                      order_id
                      
                      

string

9727125664Q20200107180320