v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
QR Codes

Update a QR code

Update the notes field of a QR code. Only notes can be modified after creation.

patch/payments/qr_codes/{id}

Path parameters

idstring required

QR code ID (qr_*).

Request body

notesNotes required

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

Response

Updated QR code.

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