Skip to navigation

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

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-KeystringRequired>=8 characters

Client-generated idempotency token.

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.

Request

This endpoint expects an object.
pixKeystringRequired

PIX key of the receiving account (must be registered to the account).

valuedoubleRequired>=0.01

Charge amount in BRL. Max 2 decimal places (e.g., 150.75 for R$150,75).

expirationDatedatetimeOptional

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.

allowChangeValuebooleanOptionalDefaults to false

If true, allows payer to change the value at payment time.

messagestringOptional<=140 characters
Message displayed to payer.
identifierstringOptional<=35 characters

Unique charge identifier (txid). Must be unique per account. Use for payment tracking. When omitted the API generates one (a UUID without hyphens).

payerPhysicalPersonbooleanOptional

If true, restricts payment to individuals only (CPF).

allowedPayerTaxNumberstringOptional

Specific CPF/CNPJ authorized to pay (payer restriction).

splitobjectOptional
Split payment configuration.

Response

QR code generated successfully.
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
Allowed values:
statusstring

QR status. ACTIVE right after creation; BLOCKED for a Location QR until it is confirmed.

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

Last instant the QR accepts payment. For due-date and Location QR codes, the end of dueDate + daysAfterDueDate (Brasília).

locationIdstringOptional

Location QR identifier at the settlement bank (Location QR only). Accepted instead of identifier on confirmation.

dueDatedateOptional

Due day (due-date and confirmed Location QR only).

daysAfterDueDateintegerOptional

Days after the due date the QR still accepts payment (due-date and confirmed Location QR only).

deductiondoubleOptional

Deduction in BRL (due-date and confirmed Location QR only).

discountdoubleOptional

Discount in BRL (due-date and confirmed Location QR only).

interestdoubleOptional

Interest in BRL (due-date and confirmed Location QR only).

penaltydoubleOptional

Penalty in BRL (due-date and confirmed Location QR only).

finalValuedoubleOptional

Amount to pay up to the due date (due-date and confirmed Location QR only).

debtorobjectOptional

Debtor given at issuance (due-date and confirmed Location QR only).

receiverNamestringOptional

Receiver name shown to the payer (due-date and confirmed Location QR only).

Errors

400
Bad Request Error
422
Unprocessable Entity Error
500
Internal Server Error