Referência

Boleto

Boletos registrados com juros, multa, desconto e PDF.

Exige o produto BOLETO ativo para a empresa em Produção. No Sandbox basta não estar desativado.

POST/v1/boletos

Emite boleto

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.

customerobrigatório

objetoPagador — document (CPF/CNPJ) é obrigatório no boleto.

dueDateobrigatório

AAAA-MM-DDVencimento.

interestBps

inteiro 0–1000Juros ao mês em pontos-base (100 = 1%).

fineBps

inteiro 0–1000Multa em pontos-base.

discountAmount

centavosDesconto até o vencimento.

instructions

string ≤ 400Instruções impressas.

description

string ≤ 140Descrição.

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/boletos

Lista boletos

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/boletos/:id

Consulta boleto (linha digitável, código de barras, nosso número)

Escopo charges.read

POST/v1/boletos/:id/cancel

Baixa/cancela boleto em aberto

Escopo charges.createAceita Idempotency-Key

GET/v1/boletos/:id/pdf

PDF do boleto

Escopo charges.read