Migrate from BharatQR APIs to QR Codes APIs
Migrate from our BharatQR APIs to QR Code APIs.
Given below is the high-level migration process.
- Explore the QR Codes APIs using the Postman collection.
- Understand the QR Code API Request and Response structure and the webhook payloads.
- Integrate with QR Code APIs. You can refer to the provided sample codes.
The table below lists the features availability on BharatQR API and QR Codes API:
Feature
| BharatQR API
| QR Codes API
|
---|
Dynamic BharatQR
| No
| Yes
|
Static BharatQR
| Yes
| Yes
|
Dynamic UPI QR
| Yes
| Yes
|
Static UPI QR
| No
| Yes
|
Get count of payments collected on QR code
| No
| Yes
|
Dashboard access
| No
| Yes
|
Your business branding on QR image
| No
| Yes
|
Dedicated VPA for your business
| No
| Yes
|
Given below is a comparison of the parameters and their descriptions.
BharatQR Parameter
| QR Codes Parameter
| Description
|
---|
receivers.types
| type
| The type of QR code. Possible values: • upi_qr: Create a QR code that accepts only UPI payments. • bharat_qr: Create a QR code that accepts UPI and card payments. For receivers.types , the only possible value was qr_code .
|
description
| description
| A brief description about the QR code.
|
customer_id
| customer_id
| Unique identifier of the customer the QR code is linked with.
|
close_by
| close_by
| UNIX timestamp at which the QR code is scheduled to be automatically closed. The time must be at least 15 minutes after the current time.
|
notes
| notes
| Key-value pair that can be used to store additional information about the QR code. Maximum 15 key-value pairs, 256 characters (maximum) each.
|
amount_expected
| NA
| The maximum amount you expect to receive in this virtual account.
|
NA
| name
| Label entered to identify the QR code. For example, Store Front Display .
|
NA
| usage
| Indicates if the QR code should be allowed to accept single payment or multiple payments. Possible values: • single_use : QR code will accept only one payment and then close automatically. • multiple_use (default): QR code will accept multiple payments.
|
NA
| fixed_amount
| Indicates if the QR should accept payments of specific amounts or any amount. Possible values: • true : QR code accepts only a specific amount. • false (default): QR code will accept any amount.
|
NA
| payment_amount
| This parameter is mandatory if fixed_amount parameter is in use. The amount allowed for a transaction. If this is specified, then any transaction of amount less than or more than this value will not be allowed. For example, if this amount is set as 500000 , the customer cannot pay an amount less than or more than ₹5000.
|
API Reference Links
Given below is a comparison of the parameters and their descriptions.
For this action, only one path parameter needs to be passed, the QR code id.
BharatQR Parameter
| QR Codes Parameter
| Description
|
---|
Virtual Account ID
| QR Code ID
| The unique identifier of the virtual account/QR code that is to be closed.
|
API Reference Links
The fetch query parameters remain the same across the APIs as given below:
BharatQR Parameter
| QR Codes Parameter
| Description
|
---|
from
| from
| Timestamp, in seconds, from when QR codes are to be fetched.
|
to
| to
| Timestamp, in seconds, till when QR codes are to be fetched.
|
count
| count
| Number of QR codes to be fetched. The default value is 10 and the maximum value is 100. This can be used for pagination, in combination with skip.
|
skip
| skip
| Number of records to be skipped while fetching the QR codes. This can be used for pagination, in combination with count.
|
API Reference Links
Given below is a comparison of the parameters and their descriptions.
For this action, only one path parameter needs to be passed, the QR code id.
BharatQR Parameter
| QR Codes Parameter
| Description
|
---|
Virtual Account ID
| QR Code ID
| The unique identifier of the virtual account/QR code whose details are to be fetched.
|
API Reference Links
Given below is a comparison of the parameters and their descriptions.
For this action, only one path parameter needs to be passed, the QR code identifier.
BharatQR Parameter
| QR Codes Parameter
| Description
|
---|
Virtual Account ID
| QR Code ID
| The unique identifier of the virtual account/QR code whose payment details are to be fetched.
|
API Reference Links
Given below is a comparison of BharatQR and QR Codes webhook events: