Sign in

v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

UPI QR & Intent String

The UPI Intent API enables merchants to generate UPI intent links & QR string using a valid payment_token_id.

post/icp/upi/intent

Headers

Access-Keystring required

Provide the PG API Access Key here

Request body

amountstring required

The amount of transaction

contact_numberstring required

Mobile number of the customer. Please make sure you are passing actual customer mobile number. If you pass a hardcoded value, if the customer doesn't change the mobile number from layer the transaction will appear with hardcoded mobile number and name associated with it.

email_idstring required

Email Id of the customer

currencystring required

INR

mtxstring required

Reference id for the transaction. This should be unique for each transaction.

Response

200

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "UPI QR Strings generated successfully",
  "data": {
    "transaction_id": "pt_Aa68F7844592533",
    "amount": "5.00",
    "currency": "INR",
    "merchant_id": "me_f4063391a9",
    "upi_intent_links": {
      "collect_pay": {
        "instrument_id": 76,
        "amount": "5.00"
      },
      "intent": {
        "instrument_id": 75,
        "qr_string": "upi://pay?pa=open9962527334907@yesbank&pn=MFK%20Associates&tr=int_pt_Aa68F7844592533&am=5.00&cu=INR&tn=UPI%20Intent%20Transaction&mc=7299",
        "intent_apps": [
          {
            "label": "Google Pay",
            "intent": "gpay",
            "qr_string": "gpay://upi/pay?pa=open9962527334907@yesbank&pn=MFK%20Associates&tr=int_pt_Aa68F7844592533&am=5.00&cu=INR&tn=UPI%20Intent%20Transaction&mc=7299"
          }
        ]
      },
      "qr": {
        "instrument_id": 74,
        "qr_string": "upi://pay?pa=open9962527334907@yesbank&pn=MFK%20Associates&tr=qr_pt_Aa68F7844592533&am=5.00&cu=INR&tn=UPI%20QR%20Transaction&mc=7299"
      }
    }
  }
}