UPI
PF Integration Option
This integration option supports the payment transaction:
Payment
Payment flow
- Customer selects UPI as a payment method on the merchant's website and submits their VPA (Virtual Payment Address).
- Merchant sends the payment request to Overpay.
- Overpay returns the payment status to the merchant:
pending
orfailed
. - Customer receives a payment confirmation request in their UPI application.
- Customer confirms the payment in their UPI application.
- Overpay sends a webhook notification with
successful
,failed
orpending
status.
Request
Send a payment request with the following additional parameters:
Parameter | Type | Description |
---|---|---|
method | object | A section of the payment method. |
type * required |
string | upi |
account * required |
string | VPA/UPI ID of the customer. |
customer * required |
object | A section of information about the customer. |
first_name * required |
string | The customer's first name. |
last_name * required |
string | The customer's last name. |
state * required | string (2) | The customer's billing state. Set as the 2 last symbols of the code in the ISO 3166-2 format. |
city * required | string (100) | The customer's billing city. |
zip * required | string | The post code of the customer's billing address. |
address * required | string (100) | The customer's address. |
phone * required |
string (14) | The customer's phone number. |
email * required |
string | The customer's email address. |
Request example
{
"request": {
"amount": 10042,
"currency": "INR",
"description": "description",
"test": false,
"customer": {
"first_name": "John",
"last_name": "Doe",
"state": "KA",
"city": "Bangalore",
"zip": "560002",
"address": "1st Street",
"phone": "17777777777",
"email": "[email protected]"
},
"method": {
"type": "upi",
"account": "1234"
}
}
}
Response
The upi
response section will have the same parameters as in the request.