QR Code APIs

Checklist to integrate using QR Code APIs. List of QR Codes APIs and GST QR Code APIs - Create, Close, Fetch and Refund.


You can use the QR Codes APIs to perform various actions. You can perform all of these actions from the

as well.

Watch Out!

Once the QR code has been created, you cannot edit its details.

  1. If you are creating a Dynamic QR code, we suggest you create a single customer_id rather than making multiple ids for the same customer. In any case, if their details change, you can use the

    .

  2. To keep a check on the duplication of customer details:

    1. Please use the fail_existing : 1 parameter. The API will throw an error when already existing customer details are added.
    2. If you use the fail_existing : 0 parameter, the API will return the customer_id if the customer exists already.
  3. Use

    to check for any constant downtimes that might affect the UPI generation/transactions.

  4. Please note that the Razorpay order id will be generated automatically when a customer makes the payment using the QR code provided by you.

  5. While

    or using the Razorpay Dashboard, make sure that you pass all the critical parameters for non-GST and GST QR codes.

  6. Pass the type as upi_qr while creating the QR Code. As we also have a BharatQR feature available with us, not passing the type can lead to errors.

  7. For the usage information;

    Dynamic QRStatic QR
    Single use. Can be used only once.Can be used multiple times.
    If it is generated for specific customers, then you can pass customer_id .Not required to pass customer_id .
  8. If the fixed_amount parameter is passed, do not forget to pass the amount parameter at the time of QR code creation.

  9. To fetch the details about the QR codes, you can use

    or use to get details about payment activity or the status of your QR codes.

  10. We suggest you to run the

    to fetch relative information about QR codes.

Best Practices for Image Content Integration

Here is a best practice to keep in mind while integrating QR Code APIs with Image Content. You can check the contents passed in the QR Code, using the response payload for

. The image_content parameter displays the QR Code content. For Example, once the qr_image_content feature is enabled, you can get the create QR Code response as given on the right-hand side.

The table below lists the various QR Code APIs and gives a brief description of each API:

APIDescription
API to create a new QR Code
API to close a QR Code
API to view details of a QR Code
API to view details of a QR Code for a Customer ID
API to view details of a QR Code for a Payment ID
API to view details of payments made to a QR Code
API to view a list of all QR Codes
API to refund a payment

The table below lists the various QR Code APIs and gives a brief description of each API:

APIDescription
API to create a new QR Code
API to close a QR Code
API to view details of a QR Code
API to view details of a QR Code for a Customer ID
API to view details of a QR Code for a Payment ID
API to view details of payments made to a QR Code
API to view a list of all QR Codes
API to refund a payment

Was this page helpful?