Skip to main content
GET
Get Dynamic QR Code Details

Authorizations

x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Path Parameters

id
string<uuid>
required

QR code identifier

Response

QR code details retrieved successfully

accept_change_value
boolean
required

Allows payer to change the QR code value when scanning

Example:

false

allowed_tax_ids
string[]
required

List of CPF/CNPJ allowed to pay this QR code. Empty if unrestricted.

Example:
amount_in_cents
integer<int64>
required

Amount in cents

Example:

4000

copy_paste_code
string
required

PIX copy-paste code (BR Code)

Example:

"00020126..."

created_at
string<date-time>
required

QR Code creation timestamp (UTC, RFC 3339).

Example:

"2026-05-28T14:30:00Z"

id
string<uuid>
required

Unique QR Code identifier

picture_code_base64
string
required

QR Code image in base64 format

status
enum<string>
required

QR Code status: active, cancelled, or completed

Available options:
waiting_payment,
paid,
cancelled
type
enum<string>
required

QR Code type: INSTANT or DUE_DATE

Available options:
INSTANT,
DUE_DATE
updated_at
string<date-time>
required

QR Code last update timestamp (UTC, RFC 3339).

Example:

"2026-05-28T14:30:00Z"

due_date
string<date> | null

Due date (YYYY-MM-DD). Present for DUE_DATE type QR codes.

Example:

"2026-06-01"

external_reference_id
string | null

External reference ID provided by the client (if any)

Example:

"order-12345"

payer_data
null | object

Payer information (required for DUE_DATE type)

transaction
null | object

Most recent transaction that paid this QR code.