Cancel every still-valid Pix QR code
Cancels every QR code of the account that is still awaiting
payment. Optional pixKey limits the batch to that PIX key.
Each call cancels at most 50 QR codes. When remaining is
greater than zero, call again. skipped means the settlement
bank already left the awaiting-payment state (paid, expired or
cancelled). failed does not stop the rest of the batch.
Amounts already paid are not reversed. A payer who scans a
cancelled QR code is refused, and the qrcode.cancelled webhook
is sent for each cancellation.
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).
Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).
Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.
Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.
Request
PIX key whose still-valid QR codes should be cancelled. Omit to cancel every still-valid QR code on the account.