v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

QR Codes

Create a QR code

Create a UPI QR code for accepting digital payments. Only upi_qr type is supported (on-demand feature; requires merchant activation). single_use QR codes require fixed_amount=true and close_by maximum is 45 days. multiple_use QR codes have no expiry restriction.

post/payments/qr_codes

Request body

type'upi_qr' required

QR code type. Only upi_qr is supported (on-demand feature requiring merchant activation).

namestring required

Label for the QR code.

usage'single_use' | 'multiple_use' required

single_use: auto-closes after first successful payment (requires fixed_amount=true). multiple_use: stays open for multiple payments.

fixed_amountboolean required

true: fixed amount QR (required for single_use). false: customer enters amount at scan time.

payment_amountinteger

Fixed payment amount in paise. Required when fixed_amount=true.

descriptionstring

customer_idstring

Associate QR code with a customer (cust_*).

close_byinteger

Unix timestamp for auto-close. Maximum 45 days from creation for single_use.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

Response

QR code created.

idstring

Unique QR code identifier. Prefix: qr_

entity'qr_code'

namestring

Label for the QR code.

descriptionstring

image_urlstring

Hosted URL of the QR code image.

payment_amountinteger

Fixed payment amount in paise. Null for variable-amount QR codes.

status'active' | 'closed'

usage_type'single_use' | 'multiple_use'

close_byinteger

Unix timestamp when the QR code will auto-close.

closed_atinteger

Unix timestamp when the QR code was closed.

close_reason'on_demand' | 'paid'

Why the QR code was closed.

customer_idstring

Associated customer ID (cust_*).

payments_amount_receivedinteger

Total amount received via this QR code (paise).

payments_count_receivedinteger

Number of payments received.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

created_atinteger