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_idUUID✅Merchant's identifier (POS_ID)
modeMODE✅direct
methodMETHOD✅Payment method (purchase)
amountNumber✅Transaction amount. Must be a positive number. The number of decimal digits must be less than or equal to 2 (e.g., 100.00, 250, 50.50)
currencyCURRENCY✅Transaction currency (ISO_4217)
order_3ds_bypassString✅3-D Secure flow option
order_idString✅Unique identifier of order
descriptionString✅Payment description
paywayString✅upi
server_urlURLWebhook notification will be sent to this URL
result_urlURLCustomer will be redirected to this URL after payment.
customer_fnameString✅payer’s first name
customer_lnameString✅payer’s last name
customer_emailString✅payer’s email address
customer_phoneString✅payer’s phone number
customer_ipString✅payer’s IP
properties.upi_numberString✅UPI address of the payer
properties.instrument_typeString✅Instrument type
properties.instrument_methodString✅Instrument method
properties.trustedBoolean✅whether 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": {
"instrument_type": "upi",
"instrument_method": "UPI",
"upi_number": "9971100000@hdfcbank",
"trusted": true
}
}