UPI COLLECT

Request Details

Parameter Name	Data Type	Mandatory	Description
`merchantOrderId`	String	yes	Unique order ID generated by merchant
`amount`	long	yes	Amount of order in Paisa
`contraints`	List	yes	Different type of constraints that must be applied to the payment
`VPA`	String	Yes	VPA against which collect request need to be raised

Example :

import uuid
from phonepe.sdk.pg.payments.v2.custom_checkout_client import CustomCheckoutClient
from phonepe.sdk.pg.env import Env
from phonepe.sdk.pg.common.models.request.pg_payment_request import PgPaymentRequest  
 
client_id = "<client_id>"
client_secret = "<client_secret>"
client_version = 1 # insert your client version here
env = Env.SANDBOX # change to Env.PRODUCTION when you go live
 
custom_checkout_client = CustomCheckoutClient.get_instance(client_id=client_id,
                                                           client_version=client_version,
                                                           client_secret=client_secret,
                                                           env=env)
 
merchant_order_id = str(uuid.uuid4())
amount = 100
vpa = "<REPLACE_WITH_REQUIRED_VPA>"
collect_message = "<MESSAGE_DISPLAYED_TO_USER>"
custom_checkout_pay_request = PgPaymentRequest.build_upi_collect_pay_via_vpa_request(vpa=vpa,
                                                                                               amount=amount,
                                                                                               merchant_order_id=merchant_order_id,
                                                                                               device_os="IOS",
                                                                                               message=collect_message)
 
custom_checkout_pay_response = custom_checkout_client.pay(custom_checkout_pay_request)

The function will raise the collect request to the above mentioned VPA.

Response Details

Property	Type	Description
`orderId`	String	Order Id created by PhonePe
`state`	String	State of the order. Initially it will be PENDING.
`expireAt`	Long	Order expire date in epoch