Custom – UPI Collect

Sequence

Validate VPA
Custom – UPI Collect

Validate VPA

Used to check if the given VPA is valid or not.

Parameters

Parameter	Type	Mandatory	Description
vpa	str	Yes	The Virtual Payment Address (VPA) for the payment.

For Python SDK Version <= 0.0.3, the imports should be:
from phonepe.sdk.pg.payments

For Python SDK Version > 0.0.3, the imports should be:
from phonepe.sdk.pg.payments.v1

Example – Valid VPA

Python
from phonepe.sdk.pg.payments.v1.payment_client import PhonePePaymentClient
from phonepe.sdk.pg.env import Env

merchant_id = "<YOUR_MERCHANT_ID>"
salt_key = "<YOUR_SALT_KEY>"
salt_index = 1 # insert your salt index
env = Env.UAT
should_publish_events = True
phonepe_client = PhonePePaymentClient(merchant_id, salt_key, salt_index, env, should_publish_events)

vpa_to_verify = "valid_vap@ybl"
response = phonepe_client.validate_vpa(vpa_to_verify)
vpa_linked_name = response.data.name

Example – Invalid VPA (Raises exception)

Python
from phonepe.sdk.pg.common.exceptions import PhonePeException
from phonepe.sdk.pg.payments.v1.payment_client import PhonePePaymentClient
from phonepe.sdk.pg.env import Env

merchant_id = "<YOUR_MERCHANT_ID>"
salt_key = "<YOUR_SALT_KEY>"
salt_index = 1 # insert your salt index
env = Env.UAT
should_publish_events = True
phonepe_client = PhonePePaymentClient(merchant_id, salt_key, salt_index, env, should_publish_events)

try:
    response = phonepe_client.validate_vpa('bad_vpa@upi')
except PhonePeException as exception:  
    print(f"The given VPA: {exception.phonepe_response.vpa} is invalid")

Returns

The function returns a VpaValidateResponse object with the following properties:

Parameter	Type	Description
success	boolean	Success/failure of the request processing
code	str	Response code explaining the reason for the status
message	str	Message providing more information about the code
data	VpaValidateResponse	Information about the VPA

VpaValidateResponse Properties

Property	Type	Description
vpa	str	The VPA sent in the request.
name	str	The name linked to the VPA.

Custom – UPI Collect

This method is used to initiate a UPI Collect via the PhonePe PG Custom Checkout

Parameters

Parameter	Type	Mandatory	Description
merchant_transaction_id	str	Yes	The unique transaction ID assigned by the merchant. Note: – merchantTransactionId length should be less than 35 characters – No Special characters allowed except underscore “_” and hyphen “-“
amount	int	Yes	The amount of the payment. In paise. Minimum 100 i.e. 1 rupee
vpa	str	Yes	The Virtual Payment Address (VPA) for the payment.
merchant_user_id	str	No	The ID assigned to the user by the merchant. Note: – merchantUserId length should be less than 36 characters – No Special characters allowed except underscore “_” and hyphen “-“
redirect_url	str	No	The UI URL to redirect the user after a successful payment.
redirect_mode	str	No	The mode of redirection after payment completion.
callback_url	str	No	The S2S callback URL to which status notifications will be sent.
callback_mode	str	No	The mode of callback handling.
merchant_order_id	str	No	The ID of the order assigned by the merchant.
device_os	str	No	The operating system of the device used for the payment. Possible values: ANDROID or IOS.

Example (Custom – UPI Collect)

Python
import uuid
from phonepe.sdk.pg.payments.v1.models.request.pg_pay_request import PgPayRequest
from phonepe.sdk.pg.payments.v1.payment_client import PhonePePaymentClient
from phonepe.sdk.pg.env import Env

merchant_id = "<YOUR_MERCHANT_ID>"
salt_key = "<YOUR_SALT_KEY>"
salt_index = 1 # insert your salt index
env = Env.UAT
should_publish_events = True
phonepe_client = PhonePePaymentClient(merchant_id, salt_key, salt_index, env, should_publish_events)

unique_transcation_id = str(uuid.uuid4())[:-2]
amount = 100
merchant_user_id = "YOUR_USER_ID"
s2s_callback_url = "https://www.merchant.com/callback"
merchant_order_id = "<YOUR_ORDER_ID>"
device_os = "ANDROID"
redirect_url = "https://www.merchant.com/success"
cancel_redirect_url = "https://www.merchant.com/cancel"
callback_mode = "POST"
validated_vpa = "valid_vpa@ybl" #Insert a valid vpa  

upi_collect_request_data = PgPayRequest.upi_collect_pay_request_builder(merchant_transaction_id=unique_transcation_id,
                                                                        amount=amount,
                                                                        vpa=validated_vpa,
                                                                        merchant_user_id=merchant_user_id,
                                                                        callback_url=s2s_callback_url,
                                                                        merchant_order_id=merchant_order_id,
                                                                        device_os=device_os,
                                                                        redirect_url=redirect_url,
                                                                        cancel_redirect_url=cancel_redirect_url,
                                                                        callback_mode=callback_mode)
upi_collect_response = phonepe_client.pay(upi_collect_request_data)

Returns

The pay function returns a PgPayResponse object. With UpiCollectInstrumentResponse object in data.

Sequence

Validate VPA

Parameters

Example – Valid VPA

Example – Invalid VPA (Raises exception)

Returns

VpaValidateResponse Properties

Custom – UPI Collect

Parameters

Example (Custom – UPI Collect)

Returns

Updated on Nov 10, 2023