UPI Intent (In)
Payment method to a UPI wallet using a QR code with a deep link
| Country | India |
|---|---|
| Currency | INR (Indian Rupee) |
| Method type | upi |
| Direction | Pay-in |
| Integration type | Widget/H2H |
| Transfer type | Transfer via UPI Wallet |
| Account number format | upi@wallet |
| Limits | **** |
Create Pay-in (API request) Integration type: Widget HTTP Method: POST Endpoint: /deals/payin
{
"amount": 1000, // Payment amount
"currency": "INR", // Currency
"invoiceId": "invoiceID", // Unique invoice identifier on the merchant side
"clientId": "clientID", // Unique client identifier on the merchant side
"type": "upi", // Method type
"successUrl": "https://example.com/success", // Optional (widget): URL for redirect on successful payment
"failUrl": "https://example.com/fail", // Optional (widget): URL for redirect on failed payment
"backUrl": "https://example.com/back", // Optional (widget): URL for return without completing payment
"lang": "EN", // Optional (widget): localization EN
"clientCredentials": { // Client data
"firstName": "firstName", // Client first name
"lastName": "lastName", // Client last name/surname
"phone": "123456789", // Client phone number
"email": "[email protected]", // Client email
}
}Widget for desktop (QR)
Widget for mobile (QR)
Create Pay-in (API request) Integration type: H2H HTTP Method: POST Endpoint: /deals/payin
{
"amount": 1000, // Payment amount
"currency": "INR", // Currency
"invoiceId": "invoiceID", // Unique invoice identifier on the merchant side
"clientId": "clientID", // Unique client identifier on the merchant side
"bankId": "bankId", // Bank identifier on our side, obtained from the /banks/find request
"type": "upi", // Method type
"successUrl": "https://example.com/success", // Optional (widget): URL for redirect on successful payment
"failUrl": "https://example.com/fail", // Optional (widget): URL for redirect on failed payment
"backUrl": "https://example.com/back", // Optional (widget): URL for return without completing payment
"lang": "EN" // Optional (widget): localization EN
}Find bank (API request)
HTTP Method: GET
Endpoint: /banks/find
This endpoint returns the list of banks supported by our system.
To create an H2H pay‑in for current method, use the _id field from this response as the bankId value in the /deals/payin request.
Example response item:
{
"_id": "a1b2c3d4-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"tid": "a1b2c3d4-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "Paytm",
...
}Here, "bankId": "a1b2c3d4-4e5f-4a6b-8c7d-9e0f1a2b3c4d".
Updated 3 months ago
Did this page help you?
