Payment APIs

Payment Entity

The various properties are explained below:

ParamTypeDescriptionExample
payeePayee Entity (conditionally required)Payee
payerPayer Entity (conditionally required)Payer
payment_detailsPayment Details EntityPayment Details
amountnumber (required)Payment amount in INR100
created_atnumberTime of creation of payment in Unix timestamp format in milliseconds1655581699420

Payee Entity

The various properties are explained below:

ParamTypeDescriptionExample
namestringName of the payeeJon Doe
bank_accountBank Account Entity (conditionally required)Bank Account
upi_idstring (conditionally required)UPI ID of payee[email protected]

Payer Entity

The various properties are explained below:

ParamTypeDescriptionExample
namestringName of the payerJon Doe
bank_accountBank Account Entity (conditionally required)Bank Account
upi_idstring (conditionally required)UPI ID of payer[email protected]

Bank Account Entity

The various properties are explained below:

ParamTypeDescriptionExample
account_numberstring (required)Virtual Payment/Bank Account Number568468986216
ifscstring (required)IFSC CodeHDFC000001

Generate QR

Endpoint

Used to generate a QR Code

HTTP MethodResourceDescription
POST/tax-payment/accounts/{account_number}/upi/qrThis API generates a QR string which can be encoded into QR code.

API EndpointAPI Endpoint

Query Parameters

ParamDescriptionExample
staticused to generate static or dynamic QR.
Possible values:
- true
- false

Default value is set to false
false

Request

  • This API takes Payment Entity where only the amount parameter is mandatory.

Response

ParamsTypeDescriptionExample
qr_stringstringThe QR string which should be encoded into a QR code.upi://[email protected]&pn=Quicko&tr=EZV2021100412035600027120&am=10&cu=INR&mc=5411&tn=Payment Request For Order: 12345678
staticbooleanIt signifies if the QR srting is static or dynamicTrue, False
transaction_idstringIt signifies the transaction id for a dynamic QR string.58sdKG-12e4-5d58-8c4s5654sw6898

Request UPI Payment

Endpoint

Request to ask for payment on a given UPI Id

HTTP MethodResourceDescription
POST/tax-payment/accounts/{account_number}/upi/collectThis API lets you send UPI payment collection requests on a given UPI ID

API EndpointAPI Endpoint

Request

  • This API takes Payment Entity where payer and amount parameter are mandatory.

Payout API

Endpoint

Used to move money from the Virtual Account to any other bank account.

HTTP MethodResourceDescription
POST/tax-payment/accounts/{account_number}/payoutThis API lets you move money out from a virtual payment account to any other bank account.

API EndpointAPI Endpoint

Request

  • This API takes Payment Entity with payee ,amount as mandatory parameters.
  • The payment_details parameter in the Payment Entity which consists of Payment Details Entity requires mode parameter to be defined.

Response