> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-881012b3.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a QR Code | Image Content

> Create QR Codes with this endpoint and share with your customers.

<div style={{display:"flex",flexWrap:"wrap",alignItems:"center",gap:"0.35rem 0.9rem",border:"1px solid rgba(128,128,128,0.28)",borderRadius:"0.5rem",padding:"0.45rem 0.75rem",margin:"0 0 1.25rem",fontSize:"0.875rem"}}>
  <span style={{fontWeight:600}}>Available in</span>
  <span>🇮🇳 India</span>
</div>

Use this endpoint to create a QR Code.

* You can share the short URL with customers to accept payments.
* You can print and download it.
* You can create QR Codes for single or multiple use and for specific or all customers.

<RequestExample>
  ```bash Curl theme={null}
  curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
  -X POST https://api.razorpay.com/v1/payments/qr_codes \
  -H "Content-Type: application/json" \
  -d '{
    "type": "upi_qr",
    "name": "Store_1",
    "usage": "single_use",
    "fixed_amount": true,
    "payment_amount": 300,
    "description": "For Store 1",
    "customer_id": "cust_HKsR5se84c5LTO",
    "close_by": 1681615838,
    "notes": {
      "purpose": "Test UPI QR Code notes"
    }
  }'
  ```

  ```java Java theme={null}
  RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

  JSONObject qrRequest = new JSONObject();
  qrRequest.put("type","upi_qr");
  qrRequest.put("name","Store Front Display");
  qrRequest.put("usage","single_use");
  qrRequest.put("fixed_amount",true);
  qrRequest.put("payment_amount",300);
  qrRequest.put("description","For Store 1");
  qrRequest.put("customer_id","cust_HKsR5se84c5LTO");
  qrRequest.put("close_by",1681615838);
  JSONObject notes = new JSONObject();
  notes.put("notes_key_1","Tea, Earl Grey, Hot");
  notes.put("notes_key_2","Tea, Earl Grey… decaf.");
  qrRequest.put("notes",notes);

  QrCode qrcode = razorpay.qrCode.create(qrRequest);
  ```

  ```php PHP theme={null}
  $api = new Api($key_id, $secret);

  $api->qrCode->create(array("type" => "upi_qr","name" => "Store Front Display", "usage" => "single_use","fixed_amount" => 1,"payment_amount" => 300,"customer_id" => "cust_HKsR5se84c5LTO","description" => "For Store 1","close_by" => 1681615838,"notes" => array("purpose" => "Test UPI QR code notes")));
  ```

  ```javascript Node.js theme={null}
  var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

  instance.qrCode.create({
    type: "upi_qr",
    name: "Store Front Display",
    usage: "single_use",
    fixed_amount: true,
    payment_amount: 300,
    description: "For Store 1",
    customer_id: "cust_HKsR5se84c5LTO",
    close_by: 1681615838,
    notes: {
      purpose: "Test UPI QR Code notes"
    }
  })
  ```

  ```python Python theme={null}
  import razorpay
  client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

  client.qrcode.create({
    "type": "upi_qr",
    "name": "Store Front Display",
    "usage": "single_use",
    "fixed_amount": true,
    "payment_amount": 300,
    "description": "For Store 1",
    "customer_id": "cust_HKsR5se84c5LTO",
    "close_by": 1681615838,
    "notes": {
      "purpose": "Test UPI QR Code notes"
    }
  })
  ```

  ```go Go theme={null}
  import ( razorpay "github.com/razorpay/razorpay-go" )
  client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

  notes := map[string]interface{}{
    "purpose": "Test UPI QR Code notes",  
  }  

  data := map[string]interface{}{
    "type": "upi_qr",
    "name": "Store Front Display",
    "usage": "single_use",
    "fixed_amount": true,
    "payment_amount": 300,
    "description": "For Store 1",
    "customer_id": "cust_HKsR5se84c5LTO",
    "close_by": 1681615838,
    "notes": notes,
  }
  body, err := client.QrCode.create(data, nil)
  ```

  ```ruby Ruby theme={null}
  require "razorpay"
  Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

  para_attr = {
    "type": "upi_qr",
    "name": "Store Front Display",
    "usage": "single_use",
    "fixed_amount": true,
    "payment_amount": 300,
    "description": "For Store 1",
    "customer_id": "cust_HKsR5se84c5LTO",
    "close_by": 1681615838,
    "notes": {
      "purpose": "Test UPI QR Code notes"
    }
  }
  Razorpay::QrCode.create(para_attr)
  ```

  ```csharp .NET theme={null}
  RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

  Dictionary<string, object> qrRequest = new Dictionary<string, object>();
  qrRequest.Add("type", "upi_qr");
  qrRequest.Add("name", "Store_1");
  qrRequest.Add("usage", "single_use");
  qrRequest.Add("fixed_amount", true);
  qrRequest.Add("payment_amount", 300);
  qrRequest.Add("description", "For Store 1");
  qrRequest.Add("customer_id", "cust_MHYe2dVX323WYD");
  qrRequest.Add("close_by", 1681615838);
  Dictionary<string, object> notes = new Dictionary<string, object>();
  notes.Add("notes_key_1", "Tea, Earl Grey, Hot");
  notes.Add("notes_key_2", "Tea, Earl Grey… decaf.");
  qrRequest.Add("notes", notes);

  QrCode qrcode = client.QrCode.Create(qrRequest);
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "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",
    "image_content": "upi://pay?pa=qmart.razorpay@hdfcbank&pn=TestAccount&tr=RZPGT5viB4WHeoUuuqrv2&tn=TestAccountRaftarSoft&am=100&cu=INR&mc=5411",
    "payment_amount": 300,
    "status": "active",
    "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
  }
  ```

  ```json Failure theme={null}
  {
      "error": {
          "code": "BAD_REQUEST_ERROR",
          "description": "The requested URL was not found on the server.",
          "source": "NA",
          "step": "NA",
          "reason": "NA",
          "metadata": {}
      }
  }
  ```
</ResponseExample>

## Request Parameters

<ParamField body="type" type="string" required>
  The type of the QR Code. Possible values:

  * `upi_qr`: Create a QR Code that accepts only UPI payments.
  * `bharat_qr`: Create a QR Code that accepts UPI and card payments.

  <Info>
    **Handy Tips**

    This is an on-demand feature. Learn more about [Bharat QR](/docs/payments/payment-methods/bharatqr).
  </Info>
</ParamField>

<ParamField body="name" type="string">
  Label entered to identify the QR Code. For example, `Store Front Display`.
</ParamField>

<ParamField body="usage" type="string" required>
  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.
</ParamField>

<ParamField body="fixed_amount" type="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.
</ParamField>

<ParamField body="payment_amount" type="integer" required>
  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.
</ParamField>

<ParamField body="description" type="string">
  A brief description about the QR Code.
</ParamField>

<ParamField body="notes" type="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”`.
</ParamField>

<ParamField body="customer_id" type="string">
  Unique identifier of the customer the QR Code is linked with. Know more about to the [Customers API](/docs/api/customers).
</ParamField>

<ParamField body="close_by" type="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).

  <Warning>
    **Watch Out!**

    Any request beyond 2147483647 Unix timestamp will fail.
  </Warning>
</ParamField>

## Response Parameters

<ResponseField name="id" type="string">
  The unique identifier of the QR Code.
</ResponseField>

<ResponseField name="entity" type="string">
  Indicates the type of entity. Here, it is `qr_code`.
</ResponseField>

<ResponseField name="type" type="string">
  The type of the QR Code. Possible values:

  * `upi_qr`: Create a QR Code that accepts only UPI payments.
  * `bharat_qr`: Create a QR Code that accepts UPI and card payments. This is an on-demand feature. Learn more about [Bharat QR](/docs/payments/payment-methods/bharatqr).
</ResponseField>

<ResponseField name="image_url" type="string">
  The URL of the QR Code. For example, `http://rzp.io/l6MS`. Click the link to download the code.
</ResponseField>

<ResponseField name="image_content" type="string">
  The link encoded to the payable QR Code using any QR Code generator. For example:

  * For UPI QR: `upi://pay?pa=dmart.razorpay@hdfcbank&pn=TestAccount&tr=RZPGT5viB4WHeoUuuqrv2&tn=TestAccountRaftarSoft&am=100&cu=INR&mc=5411`
  * For Bharat QR: `000201010212021643926300000000850415540461000000008061661005900000000890827YESB0CMSNOC222333004882700126430010A0000005240117razorpaybqr@icici02041.1027350010A0000005240117RZPGT8ildsFTgS5Sp52047531530335654041.105802IN5906zxcbmn6005Delhi610611008562300514GT8ildsFTgS5Sp070838R004506304B6A9`
</ResponseField>

<ResponseField name="name" type="string">
  Label entered to identify the QR Code. For example, `Store Front Display`.
</ResponseField>

<ResponseField name="usage" type="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.
</ResponseField>

<ResponseField name="fixed_amount" type="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.
</ResponseField>

<ResponseField name="payment_amount" type="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.
</ResponseField>

<ResponseField name="status" type="string">
  Indicates the status of the QR Code. Possible values:

  * `active`
  * `closed`
</ResponseField>

<ResponseField name="description" type="string">
  A brief description about the QR Code.
</ResponseField>

<ResponseField name="payments_amount_received" type="integer">
  The total amount received on the QR Code. All captured payments are considered.
</ResponseField>

<ResponseField name="payments_count_received" type="integer">
  The total number of payments received on the QR Code. All captured payments are considered.
</ResponseField>

<ResponseField name="notes" type="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”`.
</ResponseField>

<ResponseField name="customer_id" type="string">
  Unique identifier of the customer the QR Code is linked with. Know more about to the [Customers API](/docs/api/customers).
</ResponseField>

<ResponseField name="close_by" type="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).

  <Warning>
    **Watch Out!**

    Any request beyond 2147483647 Unix timestamp will fail.
  </Warning>
</ResponseField>

<ResponseField name="closed_at" type="integer">
  Unix timestamp at which the QR Code is automatically closed.
</ResponseField>

<ResponseField name="created_at" type="integer">
  Unix timestamp at which the QR Code was created.
</ResponseField>

<ResponseField name="close_reason" type="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.
</ResponseField>

## Errors

<AccordionGroup>
  <Accordion title="The API {key/secret} provided is invalid.">
    **Code:** `4xx`

    The 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.
  </Accordion>

  <Accordion title="The selected {field name} is invalid.">
    **Code:** `400`

    Data sent for a field is invalid. For example, when the data sent for `type` is `abc`, instead of the acceptable value.

    **Solution:** Ensure that the data sent for a field is valid. Re-check the acceptable values for that request parameter.
  </Accordion>

  <Accordion title="The {field name} is required.">
    **Code:** `400`

    A mandatory field is missing.

    **Solution:** Ensure all mandatory fields are present.
  </Accordion>

  <Accordion title="The payment amount must be at least 1.">
    **Code:** `400`

    The amount specified is less than the minimum amount.

    **Solution:** Enter an amount equal to or greater than the minimum amount, that is 1.
  </Accordion>

  <Accordion title="{Customer_id} is not a valid id.">
    **Code:** `400`

    Data entered for the Customer id field is invalid.

    **Solution:** Ensure that the Customer id is correct and valid.
  </Accordion>

  <Accordion title="type, usage, fixed_amount, payment_amount, description, close_by is/are not required and should not be sent">
    **Code:** `400`

    A POST API is executed by GET Method. | Use the correct method, that is, POST.

    **Solution:** Use the correct method, that is, POST.
  </Accordion>

  <Accordion title="{close_by} must be between 946684800 and 4765046400">
    **Code:** `400`

    A wrong close by date is passed.

    **Solution:** Ensure you pass the correct close by date(Unix timestamp). It must be between 946684800 and 4765046400.
  </Accordion>

  <Accordion title="{any extra field} ajshdas is/are not required and should not be sent">
    **Code:** `400`

    An additional or unrequired parameter is passed.

    **Solution:** Ensure that you only pass the required parameters in the request body.
  </Accordion>
</AccordionGroup>