API Pricing Image

Overview

This API generates a QR string which can be encoded into a QR code to add funds to your virtual account by passing account_number and payment_details entity.

Problem

The requirement to easily add funds to a virtual bank account.

Solution

API to generate the QR String, which can be encoded into the desired QR code that users can scan to add funds to their Virtual Bank Account.

Sequence Diagram

Endpoint

HTTP Method	Resource
`POST`	/tax-payment/accounts/{account_number}/upi/qr

Request

Follow the below guidelines to pass the account number in the path parameter, and the payment details entity as the body, with the option of passing static in the query parameter.

Path Parameter

Param	Type	Description	Example
account_number	`string`	Virtual bank account number from which you want to add funds to.	HEY564578321596

Query Parameter

Param	Description	Example
static	used to generate static or dynamic QR. Possible values: - `true` - `false`Default value is set to `false`	false

Body

The payment details entity is passed into the body.

Sample CURL Request

curl --request POST \
     --url 'https://api.sandbox.co.in/tax-payment/accounts/xxxxxxxxxxxxxxx/upi/qr?static=false' \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxxxxxxxx' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --data '
{
  "@entity": "payment",
  "payment_details": {
    "@entity": "payment_details",
    "description": "Payment Request For Order: 12345678 ",
    "notes": {},
  },
  "amount": 100
}
'

📘
Different Types of UPI QR strings.

Static - A static QR string can be used to collect multiple payments on a single QR string.

These QRs are similar to what are being used by local shops and vendors to collect payments from a retail customer.

Dynamic - A dynamic QR string can be used to collect exactly one payment on a single QR string.

For each transaction, a customer has to create a new QR code, and each QR code will have a unique
transaction Id associated with it, which can be used to reconcile transaction postback on successful
payment.

These QRs are similar to what is being used in payment gateways.

❗️
Test Environment Not Available

Response

Params	Type	Description	Example
qr_string	`string`	The QR string should be encoded into a QR code.	upi://pay?pa=hiquicko@icici&pn=Quicko&tr=EZV2021100412035600027120&am=10&cu=INR&mc=5411&tn=Payment Request For Order: 12345678
static	`boolean`	It signifies if the QR sorting is static or dynamic	True, False
transaction_id	`string`	It signifies the transaction id for a dynamic QR string.	58sdKG-12e4-5d58-8c4s5654sw6898

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since Generate QR String 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