bank-slips

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.

EndpointDescriçãoVerbos
v1/bank-slipsCria e lista boletosPOST, GET
v1/bank-slips/batchesCria boletos em lotePOST
/v1/bank-slips/{bankSlipId}Atualiza e cancela um boleto identificado pelo bankSlipIdPUT, DELETE

Parametros do corpo de um boleto

CampoTipoDescrição
amountnumberValor da cobrança
dueDatedateData de vencimento do boleto
referenceNumberstringNúmero utilizado pelo parceiro
payerobjectEntidade pagadora do boleto
installmentsintegerNúmero de parcelas (gera boletos adicionais)
costnumberCusto do boleto cobrado do cliente final
descriptionstringDescrição da cobrança (aparece no boleto)
interestsobjectJuros e multas
discountsarrayDesconto aplicado. No máximo um deve ser aplicado
deliveryMediumsarrayConfiguração de entrega
pixInfoobjectInformações Pix (QR code no boleto)

Objeto interests

CampoTipoDescrição
arrearsobjectTaxa de juros atrasados
penaltyobjectMulta aplicada

Objeto arrears

CampoTipoDescrição
valuenumberValor da taxa de juros
typestringTipo de aplicação dos juros (default: PERCENTAGE)

Objeto penalty

CampoTipoDescrição
penaltyobjectMulta aplicada
valuenumberValor da multa
typestringTipo de aplicação da multa (default: PERCENTAGE)

Objeto payer

CampoTipoDescrição
namestringNome do sacado
taxIdstringCPF do sacado
email (opcional)stringEmail do sacado (opcional)
phoneNumber (opcional)stringTelefone do sacado (opcional)
address (opcional)objectEndereço do sacado (opcional)

Objeto address

CampoTipoDescrição
zipCodestringCEP
citystringCidade
statestringEstado
streetstringLogradouro
numberstringNúmero

Array discounts

CampoTipoDescrição
valuenumberValor do desconto
typestringTipo de aplicação do desconto (default: PERCENTAGE)
dueDatedateData limite para aplicação do desconto.

Objeto pix info

CampoTipoDescrição
generateEmbeddedQrCodebooleanGerar QR code embutido no boleto para pagamento Pix