UPI
To enable the UPI payment method, you need to use direct integration. When creating a payment, send a request with the following parameters:
Parameter | Type | Required | Description |
---|---|---|---|
pos_id | UUID | ✅ | Merchant's identifier (POS_ID ) |
mode | MODE | ✅ | direct |
method | METHOD | ✅ | Payment method (purchase ) |
amount | Number | ✅ | Transaction amount |
currency | CURRENCY | ✅ | Transaction currency (ISO_4217) |
order_3ds_bypass | String | ✅ | 3-D Secure flow option |
order_id | String | ✅ | Unique identifier of order |
description | String | ✅ | Payment description |
payway | String | ✅ | upi |
server_url | URL | Webhook notification will be sent to this URL | |
result_url | URL | Customer will be redirected to this URL after payment. | |
customer_fname | String | ✅ | payer’s first name |
customer_lname | String | ✅ | payer’s last name |
customer_email | String | ✅ | payer’s email address |
customer_phone | String | ✅ | payer’s phone number |
customer_ip | String | ✅ | payer’s IP |
properties.upi_number | String | ✅ | UPI address of the payer |
properties.mop_type | String | ✅ | type of wallet |
properties.trusted | Boolean | ✅ | 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": {
"mop_type": "507",
"upi_number": "9971100000@hdfcbank",
"trusted": true,
}
}