Skip to main content

UPI

To enable the UPI payment method, you need to use direct integration. When creating a payment, send a request with the following parameters:

ParameterTypeRequiredDescription
pos_idUUIDMerchant's identifier (POS_ID)
modeMODEdirect
methodMETHODPayment method (purchase)
amountNumberTransaction amount
currencyCURRENCYTransaction currency (ISO_4217)
order_3ds_bypassString3-D Secure flow option
order_idStringUnique identifier of order
descriptionStringPayment description
paywayStringupi
server_urlURLWebhook notification will be sent to this URL
result_urlURLCustomer will be redirected to this URL after payment.
customer_fnameStringpayer’s first name
customer_lnameStringpayer’s last name
customer_emailStringpayer’s email address
customer_phoneStringpayer’s phone number
customer_ipStringpayer’s IP
properties.upi_numberStringUPI address of the payer
properties.mop_typeStringtype of wallet
properties.trustedBooleanwhether the trusted payer

Request example:

{
"pos_id": "'$POS_ID'",
"mode": "direct",
"amount": 12,
"method": "purchase",
"currency": "INR",
"payway": "upi",
"order_3ds_bypass": "supported",
"customer_fname": "John",
"customer_lname": "Doe",
"customer_phone": "7259955534",
"customer_email": "[email protected]",
"customer_ip": "1.2.3.4",
"description": "Test description for '$ORDER_ID'# payment",
"order_id": "'$ORDER_ID'",
"server_url": "https://callback.blackhole.com/callback",
"result_url": "https://example.com/result",
"properties": {
"mop_type": "507",
"upi_number": "9971100000@hdfcbank",
"trusted": true,
}
}