Close a QR Code - Razorpay

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/qr_codes/qr_HMsVL8HOpbMcjU/close

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String qrCodeId = "qr_HMsVL8HOpbMcjU";

QrCode qrcode = razorpay.qrCode.close(qrCodeId);

$api = new Api($key_id, $secret);

$api->qrCode->fetch($qrCodeId)->close()

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.qrCode.close(qrCodeId)

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.qrcode.close(qrCodeId);

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

qrCodeId = "qr_HMsVL8HOpbMcjU"

body, err := client.QrCode.Close(qrCodeId);

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

qrCodeId = "qr_HMsVL8HOpbMcjU"

Razorpay::QrCode.fetch(qrCodeId).close

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string qrCodeId = "qr_Z6t7VFTb9xHeOs";

QrCode qrcode = client.QrCode.Fetch(qrCodeId).Close();

{
  "id": "qr_HMsVL8HOpbMcjU",
  "entity": "qr_code",
  "created_at": 1623660301,
  "name": "Store_1",
  "usage": "single_use",
  "type": "upi_qr",
  "image_url": "https://rzp.io/i/BWcUVrLp",
  "payment_amount": 300,
  "status": "closed",
  "description": "For Store 1",
  "fixed_amount": true,
  "payments_amount_received": 0,
  "payments_count_received": 0,
  "notes": {
    "purpose": "Test UPI QR Code notes"
  },
  "customer_id": "cust_HKsR5se84c5LTO",
  "close_by": 1681615838,
  "closed_at": 1623660445,
  "close_reason": "on_demand",
  "tax_invoice": {
    "number": "INV001",
    "date": 1589994898,
    "customer_name": "Gaurav Kumar",
    "business_gstin": "06AABCU9605R1ZR",
    "gst_amount": 4000,
    "cess_amount": 0,
    "supply_type": "interstate"
  }
}

POST

payments

qr_codes

:qr_id

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/qr_codes/qr_HMsVL8HOpbMcjU/close

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String qrCodeId = "qr_HMsVL8HOpbMcjU";

QrCode qrcode = razorpay.qrCode.close(qrCodeId);

$api = new Api($key_id, $secret);

$api->qrCode->fetch($qrCodeId)->close()

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.qrCode.close(qrCodeId)

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.qrcode.close(qrCodeId);

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

qrCodeId = "qr_HMsVL8HOpbMcjU"

body, err := client.QrCode.Close(qrCodeId);

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

qrCodeId = "qr_HMsVL8HOpbMcjU"

Razorpay::QrCode.fetch(qrCodeId).close

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string qrCodeId = "qr_Z6t7VFTb9xHeOs";

QrCode qrcode = client.QrCode.Fetch(qrCodeId).Close();

{
  "id": "qr_HMsVL8HOpbMcjU",
  "entity": "qr_code",
  "created_at": 1623660301,
  "name": "Store_1",
  "usage": "single_use",
  "type": "upi_qr",
  "image_url": "https://rzp.io/i/BWcUVrLp",
  "payment_amount": 300,
  "status": "closed",
  "description": "For Store 1",
  "fixed_amount": true,
  "payments_amount_received": 0,
  "payments_count_received": 0,
  "notes": {
    "purpose": "Test UPI QR Code notes"
  },
  "customer_id": "cust_HKsR5se84c5LTO",
  "close_by": 1681615838,
  "closed_at": 1623660445,
  "close_reason": "on_demand",
  "tax_invoice": {
    "number": "INV001",
    "date": 1589994898,
    "customer_name": "Gaurav Kumar",
    "business_gstin": "06AABCU9605R1ZR",
    "gst_amount": 4000,
    "cess_amount": 0,
    "supply_type": "interstate"
  }
}

Available in🇮🇳 India

Use this endpoint to close a QR Code.

curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
-X POST https://api.razorpay.com/v1/payments/qr_codes/qr_HMsVL8HOpbMcjU/close

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String qrCodeId = "qr_HMsVL8HOpbMcjU";

QrCode qrcode = razorpay.qrCode.close(qrCodeId);

$api = new Api($key_id, $secret);

$api->qrCode->fetch($qrCodeId)->close()

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.qrCode.close(qrCodeId)

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.qrcode.close(qrCodeId);

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

qrCodeId = "qr_HMsVL8HOpbMcjU"

body, err := client.QrCode.Close(qrCodeId);

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

qrCodeId = "qr_HMsVL8HOpbMcjU"

Razorpay::QrCode.fetch(qrCodeId).close

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

string qrCodeId = "qr_Z6t7VFTb9xHeOs";

QrCode qrcode = client.QrCode.Fetch(qrCodeId).Close();

{
  "id": "qr_HMsVL8HOpbMcjU",
  "entity": "qr_code",
  "created_at": 1623660301,
  "name": "Store_1",
  "usage": "single_use",
  "type": "upi_qr",
  "image_url": "https://rzp.io/i/BWcUVrLp",
  "payment_amount": 300,
  "status": "closed",
  "description": "For Store 1",
  "fixed_amount": true,
  "payments_amount_received": 0,
  "payments_count_received": 0,
  "notes": {
    "purpose": "Test UPI QR Code notes"
  },
  "customer_id": "cust_HKsR5se84c5LTO",
  "close_by": 1681615838,
  "closed_at": 1623660445,
  "close_reason": "on_demand",
  "tax_invoice": {
    "number": "INV001",
    "date": 1589994898,
    "customer_name": "Gaurav Kumar",
    "business_gstin": "06AABCU9605R1ZR",
    "gst_amount": 4000,
    "cess_amount": 0,
    "supply_type": "interstate"
  }
}

Path Parameters

string

required

The unique identifier of the QR Code.

Response Parameters

string

The unique identifier of the QR Code.

string

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

json object

This block contains information about the invoices. If not provided, the transaction will default to non-GST compliant UPI flow.

string

This is the invoice number against which the payment is collected. If not provided, the transaction will default to non-GST compliant UPI flow.

integer

Timestamp, in Unix format, that indicates the issue date of the invoice. For example. 1589994898. If not provided, it will default to the current date.

string

Customer name on the invoice. If not provided, the transaction will default to non-GST compliant UPI flow.

integer

GST amount on the invoice in paise. If not provided, the transaction will default to the non-GST compliant UPI flow.

integer

CESS Amount on the invoice in paise. If not provided, the transaction will default to the non-GST compliant UPI flow.

string

Indicates whether the transaction is interstate or intrastate. Possible values:

interstate
intrastate

If not provided, the transaction will default to the non-GST compliant UPI flow.

string

The GSTIN mentioned on the invoice. For example, 06AABCU9603R1ZR. If not passed, it will be picked up from the database.

Handy Tips

This parameter is only available for UPI QR Codes.
This is an optional parameter.
The business is responsible for the completeness and correctness of the data and not Razorpay.

string

The type of the QR Code. Possible values:

upi_qr: Create a QR Code that accepts only UPI payments.

string

The URL of the QR Code. A sample short URL looks like this http://rzp.io/l6MS. Click the link to download the code.

string

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

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.

boolean

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 accepts any amount.

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.

string

Indicates the status of the QR Code. Possible values:

active
closed

string

A brief description about the QR Code.

integer

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

integer

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

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

string

Unique identifier of the customer the QR Code is linked with. Know more about to the Customers API.

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

Watch OutAny request beyond 2147483647 UNIX timestamp will fail.

integer

UNIX timestamp at which the QR Code is automatically closed.

integer

UNIX timestamp at which the QR Code was created.

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

​Path Parameters

​Response Parameters

Path Parameters

Response Parameters