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

  1. Generate QR String creates a string that can be encoded into a QR code to fund the virtual bank account.
  2. Request UPI Payment sends a payment collection request to the given UPI ID.
  3. Payout API enables the transfer of funds out of the virtual bank account.

Funding using UPI

1. Scan the QR Code and Pay

Steps

  1. Send POST request on Generate QR String endpoint.
  2. Record the transaction id in the response and encode the received QR string into a QR code.
  3. Flash The QR code to the payer and wait for the payer to pay.
  4. 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

  1. Send a POST request on Request UPI Payment with the Payer's UPI ID.
  2. Wait for the payer to accept the UPI collection request on his PSP.
  3. 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

  1. Fetch Virtual Bank Account details using Fetch Virtual Bank Account API.
  2. 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.
  3. Wait for the payer to make a payment.
  4. After Sandbox receives money in the payer's virtual bank account, it will send a postback to your server, with transaction details.

Entities

Payment

ParamTypeDescriptionExample
payeePayee EntityPayee
payerPayer EntityPayer
payment_detailsPayment Details EntityPayment Details
amountnumber (required)The payment amount in INR100
created_atnumberTime of creation of payment in UNIX timestamp format1603548912

Payee

ParamTypeDescriptionExample
namestring (required)Name of the payeeJon Doe
bank_accountBank Account EntityBank Account
upi_idstringUPI ID of payeejondoe@upi

Payer

ParamTypeDescriptionExample
namestring (required)Name of the payerJon Doe
bank_accountBank Account EntityBank Account
upi_idstringUPI ID of payerjondoe@upi

Payment Details

ParamTypeDescriptionExample
descriptionstringTransaction descriptionTDS Payment for salary
transaction_idstringUnique transaction id58sdKG-12e4-5d58-8c4s5654sw6898
bank_transaction_idstringTransaction Reference number from bank2654316812
statusstringRepresents the payment statusCreated, Processing, Successful, Failed
notesjson objectAdditional notes on the transaction{ "customer":"John",
"client":"quicko"}
modestringPayment ModeRTGS, NEFT, UPI, IMPS

Bank Account

The various properties are explained below:

ParamTypeDescriptionExample
account_numberstringVirtual Payment/Bank Account Number568468986216
ifscstringIFSC CodeHDFC000001