Payment API
Payment API includes Generate QR String, Request UPI Payment & Payout API.
Introduction
Payment APIs can be used to make Payin and Payout on your virtual bank account.
Available Payment APIs
- Generate QR String creates a string that can be encoded into a QR code to fund the virtual bank account.
- Request UPI Payment sends a payment collection request to the given UPI ID.
- Payout API enables the transfer of funds out of the virtual bank account.
Funding using UPI
1. Scan the QR Code and Pay

Steps
- Send POST request on Generate QR String endpoint.
- Record the transaction id in the response and encode the received QR string into a QR code.
- Flash The QR code to the payer and wait for the payer to pay.
- After Sandbox receives money in the payer's virtual bank account, it will send a postback to your server, with transaction details.
2. Using UPI Payment Collection Request

Steps
- Send a POST request on Request UPI Payment with the Payer's UPI ID.
- Wait for the payer to accept the UPI collection request on his PSP.
- After Sandbox receives money in the payer's virtual bank account, it will send a postback to your server, with transaction details.
Funding Using Net Banking

Steps
- Fetch Virtual Bank Account details using Fetch Virtual Bank Account API.
- The customer uses these details which include the Account number and IFSC code, to make NEFT/IMPS/RTGS payments to transfer funds to a Virtual Payment Address.
- Wait for the payer to make a payment.
- After Sandbox receives money in the payer's virtual bank account, it will send a postback to your server, with transaction details.
Entities
Payment
Param | Type | Description | Example |
---|---|---|---|
payee | Payee Entity | Payee | |
payer | Payer Entity | Payer | |
payment_details | Payment Details Entity | Payment Details | |
amount | number (required) | The payment amount in INR | 100 |
created_at | number | Time of creation of payment in UNIX timestamp format | 1603548912 |
Payee
Param | Type | Description | Example |
---|---|---|---|
name | string (required) | Name of the payee | Jon Doe |
bank_account | Bank Account Entity | Bank Account | |
upi_id | string | UPI ID of payee | jondoe@upi |
Payer
Param | Type | Description | Example |
---|---|---|---|
name | string (required) | Name of the payer | Jon Doe |
bank_account | Bank Account Entity | Bank Account | |
upi_id | string | UPI ID of payer | jondoe@upi |
Payment Details
Param | Type | Description | Example |
---|---|---|---|
description | string | Transaction description | TDS Payment for salary |
transaction_id | string | Unique transaction id | 58sdKG-12e4-5d58-8c4s5654sw6898 |
bank_transaction_id | string | Transaction Reference number from bank | 2654316812 |
status | string | Represents the payment status | Created, Processing, Successful, Failed |
notes | json object | Additional notes on the transaction | { "customer":"John", "client":"quicko"} |
mode | string | Payment Mode | RTGS, NEFT, UPI, IMPS |
Bank Account
The various properties are explained below:
Param | Type | Description | Example |
---|---|---|---|
account_number | string | Virtual Payment/Bank Account Number | 568468986216 |
ifsc | string | IFSC Code | HDFC000001 |
Updated about 1 month ago