- 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.
Request
Curl
Response
Success
Parameters
type mandatory
: string The type of the QR Code.
upi_qr: Create a QR Code that accepts only UPI payments.
Feature Request
name optional
: string Label entered to identify the QR Code. For example, Store Front Display.
usage mandatory
: 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.
fixed_amount optional
: 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.
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: Data sent for a field is invalid. For example, when the data sent for
typeisabc, 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.
- code: 400
- description: A mandatory field is missing.
- solution: Ensure all mandatory fields are present.
- code: 400
- description: The amount specified is less than the minimum amount.
- solution: Enter an amount equal to or greater than the minimum amount, that is 1.
- code: 400
- description: Data entered for the Customer id field is invalid.
- solution: Ensure that the Customer id is correct and valid.
- code: 400
- description: A POST API is executed by GET Method.
- solution: Use the correct method, that is, POST.
- code: 400
- description: 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.
- code: 400
- description: An additional or unrequired parameter is passed.
- solution: Ensure that you only pass the required parameters in the request body.