API BaaSPix

Lookup a single QR Code

Search for a single QR Code by its identifier (the value supplied at creation time, or the auto-generated UUID returned by the creation endpoints).

Returns the complete QR code record including payment info, payer details, refund data, and an enriched transaction object with full details when reconciled.

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.

Query parameters

identifierstringRequired

Identifier assigned during QR creation. The alias txid is also accepted for backwards compatibility.

Response

QR code found.
txidstring

QR code internal ID (txid).

emvstring

EMV PIX copy-and-paste code (BR Code). Render it as the QR.

typeenum
QR code type.
statusenum

QR code status (canonical, uppercase):

  • ACTIVE — created / awaiting
  • AWAITING-PAYMENT — awaiting payment
  • PAID — payment received
  • CANCELLED — cancelled / rejected
  • EXPIRED — past expiration date
  • UNKNOWN — partner status outside the known mapping
identifierstring

Client-provided identifier.

valuedoubleOptional
QR code value in BRL.
messagestringOptional
Message shown to the payer.
descriptionstringOptional

Same as message (alias).

accountIdstringOptionalformat: "uuid"
pixKeystringOptional
PIX key used for this QR code.
allowChangebooleanOptional
Whether the payer may change the amount.
qrCodeFormatstringOptional

Partner QR format (when provided).

allowedPayerDocumentstringOptional

CPF/CNPJ allowed to pay (when restricted).

payerPhysicalPersonbooleanOptional
createdAtdatetimeOptional
expiresAtdatetimeOptional

Expiration date (dynamic QR codes only).

paidAtdatetimeOptional

Payment timestamp (present when status is PAID).

paidAmountdoubleOptional

Amount actually paid (may differ if allowChange was true).

endToEndIdstringOptional

BACEN E2E identifier of the payment (present when paid).

payerobjectOptional

Payer details (present when the QR code has been paid). Populated from the underlying PIX transaction identified by endToEndId; typically includes name and document, plus bankCode/branch/account when the partner returns them.

payeeobjectOptional

Receiver (your account) details.

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error