{
"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
}
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'
{
"converted": true,
"type": "bank_slip",
"barcode": "21299758700000020000001121100012100447561740",
"digitable_line": "21290001192110001210904475617405975870000002000",
"digitable_line_formatted": "21290.00119 21100.012109 04475.617405 9 75870000002000"
}
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'
{
"code": "341",
"name": "Itaú Unibanco"
}
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'
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ç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 🎉)
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
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