API BaaSPix

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.

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).

expirationDatedatetimeRequired

QR Code expiration date/time (ISO 8601).

identifierstringRequired<=35 characters

Unique charge identifier (txid). Must be unique per account. Use for payment tracking.

allowChangeValuebooleanOptionalDefaults to false

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

messagestringOptional<=140 characters
Message displayed to payer.
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
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
422
Unprocessable Entity Error
500
Internal Server Error