UPI QR

This flow generates a QR code that the customer can scan using any UPI-enabled app to complete the payment.

Environment

Environment	HTTP Method	API
Sandbox	`POST`	https://api-preprod.phonepe.com/apis/pg-sandbox/payments/v2/pay
Production	`POST`	https://api.phonepe.com/apis/pg/payments/v2/pay

⚠️ Setup Required to Avoid Errors!

Before initiating a payment, install the PhonePe Test App and configure the payment template. Skipping this step may result in HTTP 500 errors.

Request

Request Header

Header Name	Header Value	Description
Content-Type	application/json
`Authorizatio`n	O-Bearer <access_token>	Pass `access_token` received in Authorization call

⚠️ For Partner Integrations!

It is mandatory to include the X-MERCHANT-ID header with the MerchantID of the end merchant.

Request Parameters

Parameter Name	Data Type	Mandatory	Description	Constraints
`merchantOrderId`	String	Yes	Unique merchant order id generated by merchant.	Max Length = 63 charactersNo Special characters allowed except underscore “_” and hyphen “-“
`amount`	Long	Yes	Order amount in paisa.	Min Value = 100 (In paise)
`expireAfter`	Long	No	Order expiry in seconds. If not passed default value will be used.	Min Value = 300, Max Value = 5184000 Default Value (in Secs): UPI QR: 480
`metaInfo`	Object	No	Merchant defined meta info to store additional information.same data will be returned in status and callback response.
`paymentFlow`	Object	Yes	Additional details required by this flow.
`paymentMode.type`	String	Yes	Type of payment mode	Values Allowed: • UPI_INTENT • UPI_COLLECT • UPI_QR • NET_BANKING • TOKEN • CARD

The metaInfo object contains additional parameters, which are explained in the table below.

Request Parameters of metoInfo Object:

Parameter Name	Data Type	Description	Mandatory (Yes/No)	Constraints
`metaInfo.udf1-15`	String	Optional details you can add for more information	No	• Maximum length for Udf1-10 = 256 characters • Maximum length for Udf11-15 = 50 characters

⚠️ Do Not Rename metainfo Parameters!

It is mandatory to keep the parameter names udf1, udf2, etc., exactly as they are in the metainfo block. Renaming these key values will result in a production error.

Sample Request

{
    "merchantOrderId": "TX123456",
    "amount": 1000,
    "expireAfter": 1200,
    "metaInfo": {
        "udf1": "<additional-information-1>",
        "udf2": "<additional-information-2>",
        "udf3": "<additional-information-3>",
        "udf4": "<additional-information-4>",
        "udf5": "<additional-information-5>",
        "udf6": "<additional-information-6>",
        "udf7": "<additional-information-7>",
        "udf8": "<additional-information-8>",
        "udf9": "<additional-information-9>",
        "udf10": "<additional-information-10>",
        "udf11": "<additional-information-11>",
        "udf12": "<additional-information-12>",
        "udf13": "<additional-information-13>",
        "udf14": "<additional-information-14>",
        "udf15": "<additional-information-15>"
    },       
    "paymentFlow": {
        "type": "PG",    
       "paymentMode" : {
            "type" : "UPI_QR"
        }
    } 
}

Response

Sample Response

{
    "orderId": "OMO123456789",
    "state": "PENDING",
    "expireAt": 1703756259307,
    "intentUrl": "ppe://url",
    "qrData": ""
}

Field Name	Data Type	Description
`orderId`	String	PG generated internal order id.
`state`	String	State of the order created, Expected value is CREATED.
`expiryAt`	Long	Order expiry date in epoch (in milliseconds).
`intentUrl`	String	Intent url (Present in case of UPI_INTENT or UPI_QR).

Try it yourself!

headers

body params

What’s Next?

In the next section, you will learn how to initiate payment using card payment options including debit and credit cards.