Request
Curl
Response
Success
Parameters
from optional
: integer Unix timestamp, in seconds, from when QR Codes are to be retrieved.
to optional
: integer Unix timestamp, in seconds, till when QR Codes are to be retrieved.
count optional
: integer Number of QR Codes to be retrieved.
- Default value: 10
- Maximum value: 100
- This can be used for pagination, in combination with
skip.
skip optional
: integer Number of records to be skipped while fetching the QR Codes. This can be used for pagination, in combination with count.
Parameters
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
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.
Errors
The API {key/secret} provided is invalid.- code: 4xx
- description: 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.
- code: 400
- description: Possible reasons: - The URL is wrong or is missing something.
- A GET API is executed by POST Method.
- solution: Suggested solutions: - Ensure you have the correct and complete URL.
- Use the right method, that is, GET.
- code: 400
- description: A GET API is executed by POST Method.
- solution: Use the correct method, that is, GET.
- code: 400
- description: The URL is wrong or missing something.
- solution: Use the correct and complete URL.