Saltar al contenido principal
Omitir yendo al contenido principal

Documentación @box4dev/gerador-boleto

Generador de boleto estándar FEBRABAN con línea digitable y código de barras.

El @box4dev/gerador-boleto es una biblioteca open-source ligera para el ecosistema Node.js, diseñada específicamente para la generación dinámica de datos de boletos bancarios en el estándar FEBRABAN.

NPM versionNPM downloads

Primeros Pasos

Sobre el Generador de Boleto

Generador de Boleto en el estándar FEBRABAN: Línea Digitable y Código de Barras.

Sin HTML, PDF o renderización gráfica — solo datos listos para JSON.

Ideal para generación masiva para pruebas automatizadas.

Instalación

Instale la biblioteca utilizando su administrador de paquetes preferido:

NPM

Shell
Instalar vía NPM

Yarn

Shell
Instalar vía Yarn

PNPM

Shell
Instalar vía PNPM

Importación

Importe las funciones de la biblioteca en su proyecto TypeScript o JavaScript:

JS
import { gerarBoleto } from '@box4dev/gerador-boleto';
JS
const { gerarBoleto } = require('@box4dev/gerador-boleto');

Uso

Genere datos completos de boletos fácilmente usando valores predeterminados o personalizados.

Uso Básico con Datos Aleatorios

JS
const dados = gerarBoleto();
console.log(dados.codigoBarras);
// '03396145000000996689025708991834007174230101'
console.log(dados.linhaDigitavel);
// '03399.02579 08991.834006 71742.301014 6 14500000099668'
console.log(dados);
/*
{
codigoBarras: '03396145000000996689025708991834007174230101',
linhaDigitavel: '03399.02579 08991.834006 71742.301014 6 14500000099668',
banco: 'santander',
codigoBanco: '033-7',
dataEmissao: '2026-05-13T00:00:00.000Z',
dataVencimento: '2026-05-18T00:00:00.000Z',
valorDocumento: 99668,
nossoNumero: 918340071742,
nossoNumeroDv: 3,
agencia: 1674,
codigoCedente: 257089,
carteira: '101',
localPagamento: 'Até o vencimento, preferencialmente no Banco Santander',
instrucoesPagamento: 'Sr. Caixa, cobrar multa de 2% após o vencimento. Receber até 10 dias após o vencimento.'
}
*/

Ejemplos por Banco

JS
console.log(gerarBoleto({ banco: 'bradesco' }));
console.log(gerarBoleto({ banco: 'caixa' }));
console.log(gerarBoleto({ banco: 'itau' }));
console.log(gerarBoleto({ banco: 'santander' }));

Parámetros de Uso

JS
console.log(
gerarBoleto({
banco: 'bradesco',
valorDocumento: 15990,
nossoNumero: '12345678901',
agencia: '1229',
codigoCedente: '0000469',
carteira: '9',
})
);

Parámetros de Uso

JS
console.log(
gerarBoleto({
banco: 'caixa',
dataEmissao: new Date(),
dataVencimento: vencimento,
valorDocumento: 88800,
nossoNumero: '12345678987654321',
agencia: '1234',
codigoCedente: '654321',
carteira: '14',
localPagamento: 'Local Teste',
numeroDocumento: '999888',
cedente: 'Empresa Teste LTDA',
cedenteCnpj: '54811186000198',
instrucoesPagamento: 'Instrução Teste',
identificadorEmissao: '4',
})
);

Bancos soportados

Actualmente la biblioteca admite oficialmente los siguientes bancos:

BancoDescripción
santanderBanco Santander (Código 033)
bradescoBanco Bradesco (Código 237)
caixaCaixa Econômica Federal (Código 104)
itauBanco Itaú Unibanco (Código 341)

Contribución

¡Las contribuciones son bienvenidas! Consulte la guía de contribución en GitHub:

Repositorio GitHub de @box4dev/gerador-boleto

Licencia

Distribuido bajo la licencia MIT. Libre para uso personal y comercial.

Seguridad

Los boletos generados son puramente computacionales y destinados a pruebas. No se recopila ni envía información bancaria confidencial a servidores externos.

Preguntas Frecuentes

¿Qué es exactamente un boleto bancario?
Un boleto es un título de crédito estandarizado en Brasil usado para cobros. Contiene código de barras, línea digitable, valor, fecha de vencimiento y datos del cedente. Puede pagarse hasta 90 días después del vencimiento en bancos, loterías y en línea.
¿Para qué sirve el Generador de Boleto?
Sirve para crear boletos ficticios para fines de prueba. Úselo para validar máscaras de entrada, probar el procesamiento de líneas digitables, simular pagos en entornos de desarrollo o capacitar equipos sin usar datos reales.
¿Los boletos generados son válidos y se pueden pagar?
No. Los boletos generados son estructuralmente válidos (siguen el estándar técnico), pero no tienen validez legal o financiera. Ningún banco brasileño aceptará el pago de un boleto generado por esta herramienta.
¿Puedo usar los boletos generados para emitir cobros reales?
Absolutamente no. Esto es fraude y es un crimen. Usar boletos falsificados para intentar recibir pagos es ilegal según la ley brasileña.
¿Qué banco debo usar para las pruebas?
Todos los bancos de la lista funcionan para pruebas. Elija el que su aplicación necesite procesar. Los algoritmos de validación de código de barras son iguales para todos.