Cancel Pix QR code
Cancels a QR code by its identifier. To look up the current
status of a QR (paid / awaiting / expired) use
GET /v1/accounts/{accountId}/pix/qr-code/lookup instead.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Optional client-generated idempotency token (recommended for safe retries).
Query parameters
Response
QR code transaction ID (used as qrcodeId).
EMV PIX copy-and-paste code (BR Code). Render this as the QR / “copia e cola”.
QR status. ACTIVE right after creation; BLOCKED for a Location QR until it is confirmed.
Client-provided identifier (use for lookups).
Same as message (alias).
Last instant the QR accepts payment. For due-date and Location QR codes, the end of dueDate + daysAfterDueDate (Brasília).
Location QR identifier at the settlement bank (Location QR only). Accepted instead of identifier on confirmation.
Due day (due-date and confirmed Location QR only).
Days after the due date the QR still accepts payment (due-date and confirmed Location QR only).
Deduction in BRL (due-date and confirmed Location QR only).
Discount in BRL (due-date and confirmed Location QR only).
Interest in BRL (due-date and confirmed Location QR only).
Penalty in BRL (due-date and confirmed Location QR only).
Amount to pay up to the due date (due-date and confirmed Location QR only).
Debtor given at issuance (due-date and confirmed Location QR only).
Receiver name shown to the payer (due-date and confirmed Location QR only).