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();

razorpay qr-codes close qr_ABC123

{
  "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"
}

{
    "error": {
        "code": "BAD_REQUEST_ERROR",
        "description": "The requested URL was not found on the server.",
        "source": "NA",
        "step": "NA",
        "reason": "NA",
        "metadata": {}
    }
}

POST

payments

qr_codes

: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();

razorpay qr-codes close qr_ABC123

{
  "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"
}

{
    "error": {
        "code": "BAD_REQUEST_ERROR",
        "description": "The requested URL was not found on the server.",
        "source": "NA",
        "step": "NA",
        "reason": "NA",
        "metadata": {}
    }
}

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();

razorpay qr-codes close qr_ABC123

{
  "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"
}

{
    "error": {
        "code": "BAD_REQUEST_ERROR",
        "description": "The requested URL was not found on the server.",
        "source": "NA",
        "step": "NA",
        "reason": "NA",
        "metadata": {}
    }
}

Path Parameters

string

required

The unique identifier of the QR Code.

Response Parameters

string

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

string

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

integer

Unix timestamp at which the QR Code is created.

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.

string

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

Feature RequestThis is an on-demand feature. Please raise a request with our Support team to get this feature activated on your account.

string

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

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: Indicates that the QR Code has been created and is ready to accept payments.
closed: Indicates that the QR Code has been closed.

string

A brief description about the QR Code.

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.

integer

The total amount received on the QR Code. Only 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

The unique identifier of the customer the QR Code is linked with. Know more about 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).

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.

integer

Unix timestamp at which the QR Code is automatically closed.

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.

array

Tax invoice details for GST-compliant QR codes. An array containing GST identification and supply information.

Errors

The API {key/secret} provided is invalid.

Code: 4xxThe API credentials passed in the API call differ from the ones generated on the Dashboard.Solution: The API keys must be active and entered correctly with no whitespace before or after.

The id provided does not exist

Code: 400The QR Code id was created on a different key and secret.Solution: Ensure that you use the same keys while creating and closing a QR Code.

We are facing some trouble completing your request at the moment. Please try again shortly.

Code: 400There is an error in the QR Code id. It may be incorrect or invalid.Solution: Check if you have used a valid QR Code id.

The requested URL was not found on the server.

Code: 400Possible reasons:

A POST API is executed by GET Method.
The QR Code id is not passed.

Solution: Use the correct method (POST) and QR Code id while running the API.

Partners

Payout APIs

Path Parameters

Response Parameters

Errors

​Path Parameters

​Response Parameters

​Errors

Path Parameters

Response Parameters

Errors