Guides/GuiasReferência APICryptoBrokers

Pré-visualizar um boleto

Este endpoint permite pré-visualizar os detalhes de um boleto antes de realizar o pagamento.

Obs: Você deve escolher entre código de barras ou linha digitável.

📍 Endpoint 

POST https://api.etherglobalassets.com.br/boletos/preview

🧾 Cabeçalhos obrigatórios (Headers)

Cabeçalho

Valor

Descrição

Authorization

Bearer <token>

Token JWT de autenticação

Content-Type

application/json

Formato do corpo da requisição

🧰 Corpo da Requisição (JSON) 

{
  "barcode": "85890000001097802702003248545820001312019037"
}

OU

{
  "typeableLine": "85890000000109780270200324854582000131201903700"
}

Explicação dos campos:

Campo

Tipo

Obrigatório

Descrição

barcode

string

⚠️

Código de barras do boleto (aceita com ou sem formatação - será sanitizado automaticamente)

typeableLine

string

⚠️

Linha digitável do boleto (aceita com ou sem formatação - será sanitizada automaticamente)

⚠️ Nota: Você deve fornecer apenas um dos campos: barcode OU typeableLine.

Formatos Aceitos:

Campo

Formato

Exemplo

barcode

Com ou sem espaços

85890000001097802702003248545820001312019037

typeableLine

Com ou sem pontos

85890000000109780270200324854582000131201903700

📌 Exemplo com curl 

curl https://api.etherglobalassets.com.br/boletos/preview \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "barcode": "85890000001097802702003248545820001312019037"
  }'

✅ Dica: Substitua <token> pelo seu JWT de autenticação válido e use o código de barras ou linha digitável do boleto.

✅ Resposta esperada (HTTP 200 - OK) 

{
  "assignor": "BANCO EXEMPLO S.A.",
  "barcode": "85890000001097802702003248545820001312019037",
  "typeableLine": "85890000000109780270200324854582000131201903700",
  "dueDate": "2024-12-31",
  "baseAmount": 10000,
  "feeAmount": 250,
  "internalFees": 150,
  "totalFeeAmount": 400,
  "providerNetAmount": 9750,
  "netAmount": 9600
}

Explicação da resposta:

Campo

Tipo

Descrição

Exemplo

assignor

string

Cedente do boleto

“BANCO EXEMPLO S.A.”

barcode

string

Código de barras

“85890000001097802702003248545820001312019037”

typeableLine

string

Linha digitável

“85890000000109780270200324854582000131201903700”

dueDate

string

Data de vencimento

“2024-12-31”

baseAmount

number

Valor base/nominal do boleto

10000

feeAmount

number

Taxa externa do provedor

250

internalFees

number

Taxas internas do sistema

150

totalFeeAmount

number

Total de todas as taxas

400

providerNetAmount

number

Valor líquido do provedor

9750

netAmount

number

Valor final a ser pago

9600

⚠️ Possíveis erros

Código

Erro

Causa comum

400

Bad Request

Código de barras ou linha digitável inválidos

401

Unauthorized

Token inválido ou ausente

404

Not Found

Boleto não encontrado

500

Internal Server Error

Erro interno do serviço

🎯 Como usar a pré-visualização

Após receber a resposta, você pode:

  1. Exibir os detalhes: Mostre todas as informações do boleto para o usuário

  2. Calcular taxas: Use os campos de taxas para mostrar o custo total

  3. Confirmar pagamento: Use o netAmount como valor final a ser pago

  4. Verificar vencimento: Use o campo dueDate para verificar se o boleto está vencido

💰 Cálculo de valores

  • Valor base: O campo baseAmount representa o valor original do boleto

  • Taxas: Verifique feeAmount e internalFees para calcular custos

  • Valor final: Use netAmount para saber quanto será debitado da conta

🛡️ Limitações e restrições

✅ FAÇA:

  • Use apenas um campo: barcode OU typeableLine

  • Aceite códigos com ou sem formatação

  • Mostre todas as taxas para transparência

  • Use o netAmount para o pagamento

❌ NÃO FAÇA:

  • Enviar ambos os campos simultaneamente

  • Ignorar as taxas na interface

  • Usar o baseAmount como valor final

  • Tentar pagar sem fazer a pré-visualização

🆘 Problemas comuns

“Estou recebendo erro 400!”

  • Verifique se está enviando apenas um campo

  • Confirme se o código de barras/linha digitável é válido

  • Teste com códigos sem formatação

“Erro 404 - Boleto não encontrado!”

  • Verifique se o boleto existe

  • Confirme se o código está correto

  • Teste com outro boleto

“Erro 401!”

  • Verifique se o token de autenticação é válido

  • Faça uma nova autenticação se necessário

📞 Suporte

Se nada funcionar:

  1. Verifique o código do boleto

  2. Confirme a autenticação está válida

  3. Entre em contato com nossa equipe de suporte

Mais Informações sobre esse endpoint:

Acesse aqui