Payment APIs

Payment Entity

The various properties are explained below:

Param

Type

Description

Example

payee

Payee Entity (conditionally required)

Payee

payer

Payer Entity (conditionally required)

Payer

payment_details

Payment Details Entity

Payment Details

amount

number (required)

Payment amount in INR

100

created_at

number

Time of creation of payment in Unix timestamp format in milliseconds

1655581699420

Payee Entity

The various properties are explained below:

Param

Type

Description

Example

name

string

Name of the payee

Jon Doe

bank_account

Bank Account Entity (conditionally required)

Bank Account

upi_id

string (conditionally required)

UPI ID of payee

[email protected]

Payer Entity

The various properties are explained below:

Param

Type

Description

Example

name

string

Name of the payer

Jon Doe

bank_account

Bank Account Entity (conditionally required)

Bank Account

upi_id

string (conditionally required)

UPI ID of payer

[email protected]

Bank Account Entity

The various properties are explained below:

Param

Type

Description

Example

account_number

string (required)

Virtual Payment/Bank Account Number

568468986216

ifsc

string (required)

IFSC Code

HDFC000001


Generate QR

Endpoint

Used to generate a QR Code

HTTP Method

Resource

Description

POST

/tax-payment/accounts/{account_number}/upi/qr

This API generates a QR string which can be encoded into QR code.

API EndpointAPI Endpoint

Query Parameters

Param

Description

Example

static

used 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

Params

Type

Description

Example

qr_string

string

The 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

static

boolean

It signifies if the QR srting is static or dynamic

True, False

transaction_id

string

It 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 Method

Resource

Description

POST

/tax-payment/accounts/{account_number}/upi/collect

This 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 Method

Resource

Description

POST

/tax-payment/accounts/{account_number}/payout

This 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



Did this page help you?