UPI Collect

Use this flow to initiate a UPI collect request to the customer’s UPI Number. Before creating a collect request, you must validate the VPA or UPI number. Please refer the link to validate the VPA or UPI.

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

Request

Request Header

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

Request Parameters

Parameter Name	Data Type	Mandatory	Description	Constraints
`details`	Object	Yes	Object containing collect payment details.
`details.type`	String	Yes	Type of collect payment details. Allowed Values: • VPA • UPI_NUMBER
`details.vpa`	String	Yes	VPA against which collect request need to be raised (Use when type = VPA)
`details.upiNumber`	String	Yes	UPI Number against which collect request need to be raised (Use when type = UPI_NUMBER)
`message`	String	Yes	Message to show in collect request.
`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 UPI Intent : 600 UPI Collect: 480 Card : 720 NetBanking : 480
`metaInfo`	Object	No	Merchant defined meta info to store additional information.same data will be returned in status and callback response.
`metaInfo.udf1-5`	String	No	Merchant defined additional information	Max length = 256 characters
`deviceContext.deviceOS`	String	Yes	device OS required only in case of UPI_INTENT	Values Allowed = [IOS, ANDROID]
`deviceContext.merchantCallBackScheme`	String	Yes	Merchant Callback Scheme. Required only in case targetApp = PHONEPE and deviceContext.deviceOS = IOS
`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
`merchantUrls.redirectUrl`	String	Yes	Url where user will be redirected after completing the payment. Mandatory only for [NET_BANKING, TOKEN, CARD] Payment Mode.	Valid Http url.

Try it yourself!

UPI Collect With VPA

headers

body params

UPI Collect With UPI Number

body params

Response

Sample Response

{
    "orderId": "OMO123456789",
    "state": "PENDING",
    "expireAt": 1703756259307
}

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).