Validador de Boleto Brasileiro API

API ID 13930

Valide boletos brasileiros (boleto bancário e contas de serviços públicos/impostos), verifique os dígitos verificadores, extraia banco, valor e data de vencimento, e converta entre linha digitável e código de barras

835 ms resp. média

Documentação da API

Endpoints

Requisição
O endpoint "Validar um boleto" verifica se um boleto brasileiro (código de barras ou linha digitável) está bem formado, utilizando os algoritmos de dígitos verificadores oficiais da FEBRABAN. Ele retorna se os dígitos verificadores são válidos, juntamente com o banco emissor, valor do pagamento e data de vencimento extraídos dos dados do boleto. Este endpoint não verifica o status de pagamento, não confirma o boleto com qualquer banco ou instituição financeira, nem garante que o boleto esteja livre de fraudes — ele realiza apenas uma validação matemática, não uma verificação financeira ao vivo
Endpoint ID: 32113
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32113/validate+a+boleto
PARÂMETROS DE ENTRADA

Validar um boleto — Recursos do endpoint

Objeto Descrição
code Obrigatório Boleto barcode (44 digits) or digitable line (47 or 48 digits). Dots, dashes and spaces are ignored. Alternatively send it in the JSON body.

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

code
RESPOSTA DE EXEMPLO DA API
JSON
{
    "valid": true,
    "type": "bank_slip",
    "input_format": "digitable_line",
    "barcode": "21299758700000020000001121100012100447561740",
    "digitable_line": "21290001192110001210904475617405975870000002000",
    "digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000",
    "checks": {
        "field_1_dv": true,
        "field_2_dv": true,
        "field_3_dv": true,
        "barcode_dv": true
    },
    "errors": [],
    "warnings": [],
    "bank": {
        "code": "212",
        "name": "Banco Original"
    },
    "currency": "BRL",
    "segment": null,
    "amount_cents": 2000,
    "amount": "20.00",
    "due_date": "2018-07-16",
    "due_date_status": "ok",
    "overdue": true
}
Validar um boleto — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32113/validate+a+boleto?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Requisição
Converte um boleto brasileiro entre suas duas representações: o código de barras de 44 dígitos e a linha digitável de 47/48 dígitos Aceita qualquer formato como entrada e retorna o boleto em ambos os formatos Os dígitos verificadores do boleto devem ser válidos para que a conversão seja bem-sucedida — se não forem, este endpoint retorna um erro em vez de um resultado convertido
Endpoint ID: 32115
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32115/convert+between+digitable+line+and+barcode
PARÂMETROS DE ENTRADA

Converter entre linha digitável e código de barras — Recursos do endpoint

Objeto Descrição
code Obrigatório Boleto barcode (44 digits) or digitable line (47 or 48 digits). Dots, dashes and spaces are ignored. Alternatively send it in the JSON body.

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

code
RESPOSTA DE EXEMPLO DA API
JSON
{
    "converted": true,
    "type": "bank_slip",
    "barcode": "21299758700000020000001121100012100447561740",
    "digitable_line": "21290001192110001210904475617405975870000002000",
    "digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000"
}
Converter entre linha digitável e código de barras — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32115/convert+between+digitable+line+and+barcode?code=21290.00119 21100.012109 04475.617405 9 75870000002000' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Requisição
Procura um banco brasileiro pelo seu código COMPE de 3 dígitos (por exemplo 341 para Itaú 001 para Banco do Brasil) e retorna seu nome A tabela de consulta cobre apenas bancos conhecidos e não é exaustiva — um código não reconhecido retorna um 404 o que não significa que o boleto em si seja inválido apenas que este banco não está na lista
Endpoint ID: 32117
GET https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32117/look+up+a+bank+by+its+3-digit+compe+code
PARÂMETROS DE ENTRADA

Solicitações gratuitas de teste restantes: 3 de 3.

RESPOSTA DE EXEMPLO DA API
JSON
{
    "code": "341",
    "name": "Itaú Unibanco"
}
Procure um banco pelo seu código COMPE de 3 dígitos — TRECHOS DE CÓDIGO

curl --location --request GET 'https://zylalabs.com/api/13930/brazilian+boleto+validator+api/32117/look+up+a+bank+by+its+3-digit+compe+code&code=Required' --header 'Authorization: Bearer YOUR_API_KEY' 


    

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Validador de Boleto Brasileiro API basta incluir seu token Bearer no cabeçalho Authorization.

Cabeçalhos
Cabeçalho Descrição
Authorization Obrigatório Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.

(Economize 2 meses com cobrança anual 🎉)

🚀 Plano Empresarial

A partir de
$ 10.000/Ano


  • Volume personalizado
  • Limite de taxa personalizado
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real

Visão Geral

Valide boletos brasileiros (slips bancários e contas de serviços/taxes), verifique dígitos de verificação, extraia banco, valor e data de vencimento, e converta entre linha digitável e código de barras

Validador de Boleto Brasileiro API FAQs

Cada ponto final retorna dados JSON contendo informações sobre boletos brasileiros, incluindo resultados de validação, detalhes bancários, valores de pagamento, datas de vencimento e resultados de conversão entre linhas digitáveis e códigos de barras

Os campos chave incluem "válido" (booleano), "banco" (objeto com "código" e "nome"), "valor" (string), "data_vencimento" (string) e "cheques" (objeto detalhando validações de dígito de cheque). Esses campos fornecem informações essenciais sobre a validade e os detalhes do boleto

Os dados retornados estão estruturados em formato JSON, com objetos aninhados para dados complexos. Por exemplo, o campo "banco" é um objeto contendo "código" e "nome", enquanto "cheques" fornece resultados de validação para cada dígito de verificação

Cada endpoint fornece informações sobre a validação do boleto, incluindo verificação de dígito de verificação, detalhes do banco emissor, valores de pagamento, datas de vencimento e conversão entre linhas digitáveis e códigos de barras

Os endpoints de validação GET e POST aceitam um boleto em formato de código de barras ou linha digitável. Os endpoints de conversão aceitam qualquer formato como entrada, garantindo que os dígitos de verificação sejam válidos para uma conversão bem-sucedida

Os dados da resposta estão organizados em pares de chave-valor com os resultados de validação primária no nível superior e informações detalhadas (como detalhes bancários e verificações) aninhadas dentro de objetos específicos permitindo fácil acesso aos dados relevantes

Casos de uso típicos incluem validar a integridade de boletos brasileiros antes de processar pagamentos, converter entre formatos para conveniência do usuário e buscar informações bancárias com base em códigos COMPE para aplicações financeiras

A precisão dos dados é mantida através do uso de algoritmos de dígito verificador oficiais da FEBRABAN para validação A API realiza verificações matemáticas sem depender de fontes de dados externas garantindo resultados consistentes e confiáveis

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]