> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Get a Pix charge for its payment page > Returns what a payment page shows the payer about a Pix charge, by its ID alone and without a token: the status, the amount, the dates, the description, the Pix Copia e Cola code (`emv`) and the Pix key. 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. ## OpenAPI ````yaml /api-reference/banking.openapi.json get /pix-billing/{pixBillingId} openapi: 3.0.3 info: title: Banking version: 1.0.0 description: >- Portão 3 banking API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Banking attaches a zod validationSchema at the route; request bodies are resolved from it (object + array roots). Responses have no presenter layer, so they stay tier=unknown. Confidence tiers: generated:typed=318 copied:manual=0 unknown=0. servers: - url: https://api.banking.v2.portao3.com.br/ description: production - url: https://api.banking.dev.3pers.com.br/ description: development security: [] tags: - name: Accounts - name: Account Limits - name: Wallets - name: Transaction Limits - name: Transfers - name: Cards - name: Card Limits - name: Cards 3DS - name: Pix Payments - name: Pix Keys - name: Pix Billing - name: PIX Automatic - name: PIX Infractions (MED) - name: Boleto Payments - name: Boleto Billing - name: TED Payments - name: Transactions - name: Transaction Reversals - name: Spend Review - name: Cashback - name: Currency Codes paths: /pix-billing/{pixBillingId}: get: tags: - Pix Billing summary: Get a Pix charge for its payment page description: >- Returns what a payment page shows the payer about a Pix charge, by its ID alone and without a token: the status, the amount, the dates, the description, the Pix Copia e Cola code (`emv`) and the Pix key. operationId: getPixBillingByPixBillingId parameters: - name: pixBillingId in: path required: true description: ID of the Pix charge — its `_id` (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 672a1f4eb4d3e80012c9b3e7 - name: x-environment in: header required: false description: >- 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. schema: type: string enum: - LIVE - TEST example: LIVE responses: '200': description: Successful response content: application/json: schema: type: object properties: _id: type: string description: ID of the charge. example: 672a1f4eb4d3e80012c9b3e7 status: type: string enum: - CREATING - ACTIVE - PAID - CANCELED description: >- `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. example: ACTIVE emv: type: string description: >- 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: type: string description: The Pix key the charge pays into. Absent while `CREATING`. example: financeiro@lojaexemplo.com.br txnCurrency: type: string description: 'Currency of the charge: `986` (Brazilian real).' example: '986' txnAmount: type: number description: Amount of the charge, in cents. example: 28500 txnCanAmountChange: type: boolean description: Whether the payer can change the amount when paying. example: false dueDate: type: string nullable: true description: >- 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' format: date-time expiresAt: type: string nullable: true description: >- 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' format: date-time description: type: string description: Description of the charge. Empty when it has none. example: Pedido 4821 customer: type: object properties: name: type: string description: Name of the payer. example: Juliana Ribeiro document: type: string description: >- CPF or CNPJ of the payer, masked: a CPF shows only its middle six digits (`***.456.789-**`), a CNPJ only its first two characters, its four-character branch number and its first check digit. example: '***.456.789-**' required: - name - document description: 'The payer: the name, and the document masked.' required: - _id - status - txnCurrency - txnAmount - txnCanAmountChange - dueDate - expiresAt - description - customer description: >- A Pix charge as its payment page reads it: only what the payer needs to pay it. '404': description: >- `PIX_BILLING_NOT_FOUND` — No charge with this ID exists in this environment. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - PIX_BILLING_NOT_FOUND description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: PIX_BILLING_NOT_FOUND origin: BANKING message: Pix billing not found '422': description: '`BAD_REQUEST` — `pixBillingId` is not a valid ID; `fields` names it.' content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: BANKING message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: id message: 'Invalid input: expected string, received undefined' code: ID_REQUIRED security: [] ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.