Pular para o conteúdo
Referência

PIX

Cobranças PIX com QR Code (copia e cola), recebimentos e depósitos na conta.

Exige o produto PIX ativo para a empresa em Produção. No Sandbox basta não estar desativado.
POST/v1/pix/charges

Cria cobrança PIX (QR Code + copia e cola)

Escopo charges.createAceita Idempotency-Key
Corpo (JSON)
amountobrigatório
string | inteiroValor em centavos (unidade mínima), como string ou inteiro. Ex.: "15990" = R$ 159,90.
description
string ≤ 140Texto exibido ao pagador.
customer
objetoPagador: name (obrigatório), document (CPF/CNPJ), email, phone.
expiresInSeconds
inteiroValidade do QR (60 s a 30 dias). Padrão 3600.
dueDate
ISO 8601Vencimento (cobrança com vencimento).
reference
string ≤ 80Referência livre.
externalId
string ≤ 80Seu identificador do pedido. Aparece em listagens, filtros e webhooks.
metadata
objetoPares chave/valor (string, número ou booleano). Chaves até 40 caracteres.
GET/v1/pix/charges

Lista cobranças PIX

Escopo charges.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/pix/charges/:id

Consulta cobrança PIX (txid, E2E, pagador)

Escopo charges.read
POST/v1/pix/charges/:id/cancel

Cancela cobrança PIX pendente

Escopo charges.createAceita Idempotency-Key
GET/v1/pix/received

PIX recebidos

Escopo charges.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/pix/overview

Resumo de PIX do período

Escopo charges.read
POST/v1/pix/deposits

Gera QR para depositar na própria conta

Escopo charges.createAceita Idempotency-Key
Corpo (JSON)
amountobrigatório
string | inteiroValor em centavos (unidade mínima), como string ou inteiro. Ex.: "15990" = R$ 159,90.
expiresInSeconds
inteiro300 s a 24 h. Padrão 3600.
description
string ≤ 140Descrição.
GET/v1/pix/deposits

Lista depósitos

Escopo charges.read
Parâmetros de consulta
page
inteiroPágina (começa em 1).
pageSize
inteiro ≤ 200Itens por página (padrão 25).
GET/v1/pix/deposits/:id

Consulta depósito

Escopo charges.read
GET/v1/pix/keys

Chaves PIX da conta

Escopo charges.read