Api

Qr Codes

QR Codes

API Documentation for Razorpay QR Codes. Create, Close and Fetch QR Codes using APIs. Check the various use cases and code samples.

You can use Razorpay

QR Codes

to create QR Codes and share them with customers to accept digital payments.

Handy Tips

Before you begin integrating with the APIs for QR Codes, refer to the:

You can create and manage QR Codes using APIs or from the

Razorpay Dashboard

.

You can try out our APIs on the Razorpay Postman Public Workspace.

Run in Postman

List of Endpoints

API EndpointDescription

Create a QR Code

Creates a QR Code.

Close a QR Code

Closes a QR Code.

Fetch all QR Codes

Retrieves details of all QR Codes.

Fetch a QR Code with Id

Retrieves details of a specific QR Code using id.

Fetch QR Codes for a Customer ID

Retrieves QR Codes generated for a Customer id.

Fetch QR Codes for a Payment ID

Retrieves QR Codes by Payment id.

Fetch Payments for a QR Code

Retrieves payments made on a QR Code.

Refund Payments

API endpoint to refund payments made on a QR Code.

QR Code Entity

The QR Code entity has the following fields:

id

string The unique identifier of the QR Code. For example, qr_HMsVL8HOpbMcjU.

entity

string Indicates the type of entity. Here, it is qr_code.

created_at

integer Unix timestamp at which the QR Code is created.

name

string Label entered to identify the QR Code. For example, Store Front Display.

usage

string 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.

type

string The type of the QR Code. Possible value is upi_qr, which creates a QR Code that accepts only UPI payments.

Feature Request

This is an on-demand feature. Please raise a request with our

Support team

to get this feature activated on your Razorpay account.

image_url

string The URL of the QR Code. For example, http://rzp.io/l6MS. Click the link to download the code.

payment_amount

if fixed_amount=true

integer The amount allowed for a transaction. If this is specified, then any transaction of an amount less than or more than this value is not allowed. For example, if this amount is set as 500000, the customer cannot pay an amount less than or more than ₹5000.

status

string Indicates the status of the QR Code. Possible values:

  • active: Indicates that the QR Code has been created and is ready to accept payments.
  • closed: Indicates that the QR Code has been closed.

description

string A brief description about the QR Code.

fixed_amount

boolean Indicates if the QR Code should accept payments of specific amounts or any amount. Possible values:

  • true: QR Code accepts only a specific amount.

  • false (default): QR code accepts any amount.

Watch Out!

When setting the usage to single_use, ensure that fixed_amount is true to generate the QR Code successfully.

payments_amount_received

integer The total amount received on the QR Code. Only captured payments are considered.

payments_count_received

integer The total number of payments received on the QR Code. All captured payments are considered.

notes

object Key-value pair that can be used to store additional information about the QR Code. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

customer_id

string The unique identifier of the customer the QR Code is linked with. Know more about the

Customers API

.

close_by

integer 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. The date range can be set to 2147483647 in Unix timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30).

Handy Tips

  • Any request beyond 2147483647 Unix timestamp will fail.

Watch Out!

  • This parameter is only available for QR codes with usage set as single_use. You will not be able to use this parameter for multiple_use QR codes as it will generate an error.
  • For single_use QR codes, the close_by date can be set for a maximum of 45 days. If no close_by date is specified, the QR code will automatically become inactive after 45 days. Conversely, multiple_use QR codes do not have an expiration date.

closed_at

integer Unix timestamp at which the QR Code is automatically closed.

close_reason

string The reason for the closure of the QR Code. Possible values:

  • on_demand: When you close the QR Code using the APIs or the Razorpay Dashboard.
  • paid: If the QR Code is created with the usage=single_payment parameter, the QR Code closes automatically once the customer makes the payment, with the reason marked as paid.
  • null: The QR Code has not been closed yet.

Was this page helpful?

ON THIS PAGE