O acesso à API de boletos é realizado através de requisições para o endpoint v1/bank-slips. As páginas que detalham cada operação indicarão se há a possibilidade de filtragem por meio de query paramethers e quais serão esses parametros.
Endpoint
Descrição
Verbos
v1/bank-slips
Cria e lista boletos
POST, GET
v1/bank-slips/batches
Cria boletos em lote
POST
/v1/bank-slips/{bankSlipId}
Atualiza e cancela um boleto identificado pelo bankSlipId
PUT, DELETE
Parametros do corpo de um boleto
Campo
Tipo
Descrição
amount
number
Valor da cobrança
dueDate
date
Data de vencimento do boleto
referenceNumber
string
Número utilizado pelo parceiro
payer
object
Entidade pagadora do boleto
installments
integer
Número de parcelas (gera boletos adicionais)
cost
number
Custo do boleto cobrado do cliente final
description
string
Descrição da cobrança (aparece no boleto)
interests
object
Juros e multas
discounts
array
Desconto aplicado. No máximo um deve ser aplicado
deliveryMediums
array
Configuração de entrega
pixInfo
object
Informações Pix (QR code no boleto)
Objeto interests
Campo
Tipo
Descrição
arrears
object
Taxa de juros atrasados
penalty
object
Multa aplicada
Objeto arrears
Campo
Tipo
Descrição
value
number
Valor da taxa de juros
type
string
Tipo de aplicação dos juros (default: PERCENTAGE)
Objeto penalty
Campo
Tipo
Descrição
penalty
object
Multa aplicada
value
number
Valor da multa
type
string
Tipo de aplicação da multa (default: PERCENTAGE)
Objeto payer
Campo
Tipo
Descrição
name
string
Nome do sacado
taxId
string
CPF do sacado
email (opcional)
string
Email do sacado (opcional)
phoneNumber (opcional)
string
Telefone do sacado (opcional)
address (opcional)
object
Endereço do sacado (opcional)
Objeto address
Campo
Tipo
Descrição
zipCode
string
CEP
city
string
Cidade
state
string
Estado
street
string
Logradouro
number
string
Número
Array discounts
Campo
Tipo
Descrição
value
number
Valor do desconto
type
string
Tipo de aplicação do desconto (default: PERCENTAGE)
dueDate
date
Data limite para aplicação do desconto.
Objeto pix info
Campo
Tipo
Descrição
generateEmbeddedQrCode
boolean
Gerar QR code embutido no boleto para pagamento Pix
