Request UPI Payment
Send UPI payment requests to contacts to add funds to the virtual bank account.
Overview
This API lets you send UPI payment collection requests on a given upi_id
Problem
- The requirement to easily add funds to a virtual bank account.
Solution
- API to send the UPI payment collection request.
- Get postback on when the account is topped-up.
Sequence Diagram
Endpoint
| HTTP Method | Resource |
|---|---|
POST | /tax-payment/accounts/{account_number}/upi/collect |
Request
Follow the below guidelines to pass the account number in the path parameter and payment in the body.
Path Parameter
| Param | Type | Description | Example |
|---|---|---|---|
| account_number | string | Virtual bank account number from which you want to add funds to. | HEY564578321596 |
Body
This API takes Payment Entity where the payer and amount parameters are mandatory.
Sample CURL Request.
curl --request POST \
--url https://api.sandbox.co.in/tax-payment/accounts/xxxxxxxxxxxxxx/upi/collect \
--header 'Accept: application/json' \
--header 'Authorization: xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'x-api-key: xxxxxxxxxxxxxxx' \
--data '
{
"@entity": "payment",
"payer": {
"@entity": "payer",
"name":"John Doe",
"upi_id": "jon*******@upi"
},
"payment_details": {
"@entity": "payment_details",
"description": "Payment Request For Order 12345678 ",
"notes": {},
},
"amount": 600
}
'
Test Environment Not Available
Response
The API will respond with the Payment Entity
{
"code": 200,
"timestamp": 1631095323168,
"transaction_id": "8831d466-6fe7-48ed-b478-7d1cb4e92572",
"data": {
"@entity": "payment",
"payer": {
"@entity": "payer",
"name": "John Doe",
"upi_id": "john*******@upi"
},
"payee": {
"@entity": "payee",
"bank_account": {
"@entity": "virtual_bank_account",
"account_number": "HEYSBX0****01",
"status": "Active",
"IFSC_no": "ICIC***25"
}
},
"payment_details": {
"@entity": "payment_details",
"transaction_id": "58sdKG-12e4-5d58-8c4s5654sw6898",
"status": "pending",
"bank_transaction_id": null,
"description": "Test Transaction",
"notes": {}
},
"status": "Pending",
"amount": 600,
"created_at": 16373968890
}
}
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since Request UPI Payment API is a Paid API, a wallet charge will take place.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 5 months ago