Fetch a QR code

GET

payments

qr_codes

{id}

Fetch a QR code

curl --request GET \
  --url https://api.razorpay.com/v1/payments/qr_codes/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.razorpay.com/v1/payments/qr_codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.razorpay.com/v1/payments/qr_codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.razorpay.com/v1/payments/qr_codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.razorpay.com/v1/payments/qr_codes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "qr_EtjRHL7viz7RCz",
  "entity": "qr_code",
  "created_at": 1623914648,
  "name": "Store Front Display",
  "usage": "single_use",
  "type": "upi_qr",
  "image_url": "https://rzp.io/i/w2CEwYmkAu",
  "payment_amount": 100,
  "status": "active",
  "description": "For Store 1",
  "fixed_amount": true,
  "payments_amount_received": 0,
  "payments_count_received": 0,
  "notes": {},
  "customer_id": "cust_EtjRHOF6vrzpfy",
  "close_by": 1681615838,
  "closed_at": null,
  "close_reason": null
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

Authorizations

Authorization

string

header

required

Use your Razorpay Key ID as the username and Key Secret as the password.

Path Parameters

string

required

Unique identifier of the QR code.

Example:

"qr_EtjRHL7viz7RCz"

Response

QR code details retrieved successfully.

A Razorpay QR Code object for UPI payments.

string

Unique identifier of the QR code.

Example:

"qr_EtjRHL7viz7RCz"

entity

string

Entity type. Always qr_code.

Example:

"qr_code"

created_at

integer

Unix timestamp at which the QR code was created.

Example:

1623914648

name

string

Name or label for the QR code.

Example:

"Store Front Display"

usage

enum<string>

Whether the QR code can be used for single or multiple payments.

Available options:

single_use,

multiple_use

Example:

"single_use"

type

enum<string>

Type of QR code. upi_qr for UPI payments.

Available options:

upi_qr

Example:

"upi_qr"

image_url

string

URL of the QR code image. Can be embedded or downloaded.

Example:

"https://rzp.io/i/w2CEwYmkAu"

payment_amount

integer | null

Fixed payment amount in smallest currency unit (paise). Null for open amount QR codes.

Example:

100

status

enum<string>

Current status of the QR code.

Available options:

active,

closed

Example:

"active"

description

string

Description of the QR code.

Example:

"For Store 1"

fixed_amount

boolean

Whether the QR code has a fixed payment amount.

Example:

true

payments_amount_received

integer

Total amount received through this QR code in smallest currency unit.

Example:

0

payments_count_received

integer

Total number of payments received through this QR code.

Example:

0

notes

object

Key-value pairs for storing additional information.

Show child attributes

Example:

{}

customer_id

string | null

Unique identifier of the customer associated with this QR code.

Example:

"cust_EtjRHOF6vrzpfy"

close_by

integer | null

Unix timestamp after which the QR code will be automatically closed.

Example:

1681615838

closed_at

integer | null

Unix timestamp at which the QR code was closed.

Example:

null

close_reason

string | null

Reason for closing the QR code.

Example:

null

Fetch a QR code

curl --request GET \
  --url https://api.razorpay.com/v1/payments/qr_codes/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.razorpay.com/v1/payments/qr_codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.razorpay.com/v1/payments/qr_codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.razorpay.com/v1/payments/qr_codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.razorpay.com/v1/payments/qr_codes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "qr_EtjRHL7viz7RCz",
  "entity": "qr_code",
  "created_at": 1623914648,
  "name": "Store Front Display",
  "usage": "single_use",
  "type": "upi_qr",
  "image_url": "https://rzp.io/i/w2CEwYmkAu",
  "payment_amount": 100,
  "status": "active",
  "description": "For Store 1",
  "fixed_amount": true,
  "payments_amount_received": 0,
  "payments_count_received": 0,
  "notes": {},
  "customer_id": "cust_EtjRHOF6vrzpfy",
  "close_by": 1681615838,
  "closed_at": null,
  "close_reason": null
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The amount must be greater than 0.",
    "field": "amount"
  }
}

Introduction

API Guides

Core Resources API

Products API

Additional Resources

Payments

QR Codes

RazorpayX

Partners

Authorizations

Path Parameters

Response