API Internet BankingPix

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

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.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Query parameters

identifierstringRequired
Identifier assigned during QR creation.

Response

QR code cancelled.
txidstring

QR code transaction ID (used as qrcodeId).

emvstring

EMV PIX copy-and-paste code (BR Code). Render this as the QR / “copia e cola”.

typeenum
statusstring

QR status. ACTIVE right after creation.

identifierstring

Client-provided identifier (use for lookups).

valuedoubleOptional
Charge amount in BRL.
messagestringOptional
Message shown to the payer.
descriptionstringOptional

Same as message (alias).

accountIdstringOptional
Account that owns the charge.
pixKeystringOptional
PIX key used in the charge.
allowChangebooleanOptional
Whether the payer may change the amount.
createdAtdatetimeOptional
expiresAtdatetimeOptional

Errors

400
Bad Request Error
500
Internal Server Error