Skip to main content
GET
Get a Pix charge for its payment page
Anyone with the charge’s ID can read it, so it carries only the payer’s name and masked document — no e-mail, address or account details. Send x-environment: LIVE for a production charge: without it, the charge is looked up in TEST. To follow your charges, use GET .../wallets/{walletId}/pix-billing/{pixId} instead.

Headers

x-environment
enum<string>

Environment of the charge: LIVE (production) or TEST (sandbox). When you omit it, TEST is used, so send LIVE for a production charge; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

pixBillingId
string
required

ID of the Pix charge — its _id (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

A Pix charge as its payment page reads it: only what the payer needs to pay it.

_id
string
required

ID of the charge.

Example:

"672a1f4eb4d3e80012c9b3e7"

status
enum<string>
required

ACTIVE while it can be paid; PAID once paid; CANCELED once canceled; CREATING when its QR code never came back — it can't be paid.

Available options:
CREATING,
ACTIVE,
PAID,
CANCELED
Example:

"ACTIVE"

txnCurrency
string
required

Currency of the charge: 986 (Brazilian real).

Example:

"986"

txnAmount
number
required

Amount of the charge, in cents.

Example:

28500

txnCanAmountChange
boolean
required

Whether the payer can change the amount when paying.

Example:

false

dueDate
string<date-time> | null
required

Due date of the charge — midnight UTC when it was sent as YYYY-MM-DD. null for a static QR code.

Example:

"2026-11-20T00:00:00.000Z"

expiresAt
string<date-time> | null
required

Last day the charge can be paid — midnight UTC when it was sent as YYYY-MM-DD. null when none was set.

Example:

"2026-12-20T00:00:00.000Z"

description
string
required

Description of the charge. Empty when it has none.

Example:

"Pedido 4821"

customer
object
required

The payer: the name, and the document masked.

emv
string

The Pix Copia e Cola code: render it as a QR code or let the payer paste it in their bank's app. Absent while CREATING.

Example:

"00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2"

key
string

The Pix key the charge pays into. Absent while CREATING.

Example:

"financeiro@lojaexemplo.com.br"