Generate blocked Pix Location QR for an account
Generates a Pix Location QR code blocked (status: BLOCKED). The
emv can be printed or sent right away, but payment is refused until
the charge is confirmed with
PUT /v1/accounts/{accountId}/pix/qr-code/location/{identifier}/confirm.
Requires the product to be enabled for the tenant (403 feature_disabled otherwise).
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Client-generated idempotency token.
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 of the receiving account (must be registered to the account).
Unique identifier ([A-Za-z0-9._-], up to 38 characters), used to
confirm, look up and cancel. When omitted the API generates one.
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).