Generate Pix dynamic QR for an account
Creates a dynamic PIX QR code (BR Code) for a fixed amount, with optional expiration and payer restrictions. The response carries the emv payload to render and a txid to reconcile the payment via webhooks or the lookup endpoint.
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).
Charge amount in BRL. Max 2 decimal places (e.g., 150.75 for R$150,75).
Expiration date/time (RFC3339), at most 90 days after creation. When omitted the QR expires 24 hours after creation. An account may have a shorter limit configured at the settlement bank; above it the response is 400 with the bank’s message.
If true, allows payer to change the value at payment time.
Unique charge identifier (txid). Must be unique per account. Use for payment tracking. When omitted the API generates one (a UUID without hyphens).
If true, restricts payment to individuals only (CPF).
Specific CPF/CNPJ authorized to pay (payer restriction).
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).