Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

UPI Intent Payment

Create a UPI payment transaction. In UPI Pay transactions, the response of the /txns call will have SDK object parameters for generating the intent URI/ QR code etc. Merchants can then use these parameters appropriately

The response for the UPI Intent Payment API is a Payment Status Object  (with two extra parameters: "txn_uuid" and "payment.sdk_params":{...} (object))     (click to open table)
ParameterTypeDescription
order_idStringUnique Identifier for the order.
txn_idStringTransaction ID for the payment attempt.
txn_uuidStringTransaction UUID
statusStringStatus of the transaction. See Appendix below for status mapping. PENDING_VBV indicates that the transaction requires authentication to complete.
payment:wwiw
    {{...},{...}}
ObjectContains authentication object:
{method, url, params} and sdk_params: {...} object.
 Parameters for the payment object:
     {click to open)
authentication:
    {method, url, params}
ObjectAuthentication parameterswwwww
  Parameters for the authentication object:
      (click to open)
ParameterTypeDescription
methodStringHTTP Method for authentication. Can be one of GET or POST. (For redirection instructions, see the "Handling the Redirection Method" section.)
urlStringURL to which the user has to be taken to for completing the authentication
paramsStringPresent only when the method is POST. Parameter map that has to be sent along with the URL for authentication. Do not hardcode the params in your client * Never assume that you will receive param “x” or param “y”. This is completely dynamic and will vary on a case by case basis.
sdk_params: {{...},...}wtObjectList of SDK parameterswwwwww
  Parameters for the sdk_params object:
      (click to open)
merchant_vpaString"[email protected]"
merchant_nameString"juspay"
trString"202101345671229366"
tidString"121313202101345671229366"
mccString"1234"
amountString"1"
  APPENDIX   - Payment status codes and meaning:
StatusIDMeaning
NEW10Newly created order
PENDING_VBV23Authentication is in progress
CHARGED21Successful transaction
AUTHENTICATION_FAILED26User did not complete authentication
AUTHORIZATION_FAILED27User completed authentication, but bank refused the transaction
JUSPAY_DECLINED22User input is not accepted by the underlying PG
AUTHORIZING28Transaction status is pending from bank
The request consists of Payment Method Details and three extra parameters: upi_app, 'txn_type' (must be set to 'UPI_PAY'), and 'sdk_params' (set to "true" to return SDK parameters)     Parameters are listed below:
Note:
If using the Third-Party Validation (TPV) option, payment_method must be one from this table:     (click to open)
Bank Code (payment_method)Bank Name
JP_ANDHRAAndhra Bank
JP_AXISAxis Bank
JP_CANRCanara Bank
JP_ICICIICICI Bank
JP_IOBIndian Overseas Bank
JP_KVBKarur Vysya Bank
JP_PNBPunjab National Bank
JP_SBIState Bank of India
JP_IDFCIDFC Bank
JP_HDFCHDFC Bank
JP_YESBYes Bank
JP_DLSDhanalaxmi Bank
JP_CSBCatholic Syrian Bank
JP_OBCOriental Bank Of Commerce
JP_LVBLakshmi Vilas Bank Retail
PAYUPI Intent Payment
COLLECTUPI Collect Payment
INAPPUPI IN App Payment
Language
Click Try It! to start a request and see the response here!