Zum Hauptinhalt springen
Zum Hauptinhalt springen

@box4dev/gerador-boleto Dokumentation

Generieren Sie online FEBRABAN-konforme Boletos mit typisierbarer Linie und Barcode.

@box4dev/gerador-boleto ist eine leichtgewichtige Open-Source-Bibliothek für das Node.js-Ökosystem, die speziell für die dynamische Generierung von Bank-Boleto-Daten im FEBRABAN-Standard entwickelt wurde.

NPM versionNPM downloads

Erste Schritte

Über den Boleto-Generator

Boleto-Generator im FEBRABAN-Standard: typierbare Zeile und Barcode.

Kein HTML-, PDF- oder Grafik-Rendering – nur JSON-fähige Daten.

Ideal für die Massengenerierung für automatisierte Tests.

Installation

Installieren Sie die Bibliothek mit Ihrem bevorzugten Paketmanager:

NPM

Shell
Installation über NPM

Yarn

Shell
Installation über Yarn

PNPM

Shell
Installation über PNPM

Import

Importieren Sie die Bibliotheksfunktionen in Ihr TypeScript- oder JavaScript-Projekt:

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

Verwendung

Generieren Sie vollständige Zahlscheindaten ganz einfach mit Standard- oder benutzerdefinierten Werten.

Grundlegende Verwendung mit Zufallsdaten

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.'
}
*/

Beispiele nach Bank

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

Nutzungsparameter

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

Nutzungsparameter

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',
})
);

Unterstützte Banken

Derzeit unterstützt die Bibliothek offiziell folgende Banken:

BankBeschreibung
santanderBanco Santander (Code 033)
bradescoBanco Bradesco (Code 237)
caixaCaixa Econômica Federal (Code 104)
itauBanco Itaú Unibanco (Code 341)

Beitrag

Beiträge sind willkommen! Siehe Leitfaden für Beiträge auf GitHub:

GitHub-Repository von @box4dev/gerador-boleto

Lizenz

Vertrieben unter der MIT-Lizenz. Frei für persönliche und kommerzielle Nutzung.

Sicherheit

Generierte Zahlscheine sind rein rechnerisch und für Testzwecke bestimmt. Es werden keine sensiblen Bankdaten gesammelt oder an externe Server übertragen.

Häufig gestellte Fragen

Was genau ist ein Bankbeleg (Boleto)?
Ein Boleto ist ein standardisiertes Kreditdokument, das in Brasilien zum Inkasso von Rechnungen verwendet wird. Es enthält einen Barcode, eine schreibbare Zeile, einen Betrag, ein Fälligkeitsdatum und Informationen zum Zedenten (Aussteller). Die Auszahlung kann bis zu 90 Tage nach Fälligkeit bei Banken, Lotteriestellen und Online-Plattformen erfolgen.
Wozu dient der Boleto-Generator?
Zu Testzwecken werden fiktive Boletos erstellt. Nutzen Sie es, um Eingabemasken zu validieren, typisierbare Zeilenverarbeitung zu testen, Zahlungen in Entwicklungsumgebungen zu simulieren oder Teams zu schulen, ohne echte Daten zu verwenden.
Sind generierte Boletos gültig und können sie bezahlt werden?
Nein. Generierte Boletos sind strukturell gültig (entsprechen technischen Standards), haben jedoch keine rechtliche oder finanzielle Gültigkeit. Keine brasilianische Bank akzeptiert die Zahlung eines mit diesem Tool generierten Boletos. Sie existieren nur als Testdaten.
Kann ich generierte Boletos verwenden, um echte Gebühren zu erheben?
Absolut nicht. Das ist Betrug und ein Verbrechen. Die Verwendung gefälschter Boletos für den Versuch, Zahlungen entgegenzunehmen, Menschen zu täuschen oder Betrug zu begehen, verstößt gegen brasilianisches Recht (Cyberkriminalitätsgesetz – Gesetz 12.737/12 und Betrugsgesetz – Strafgesetzbuch, Artikel 171). Dies kann eine strafrechtliche Verfolgung, hohe Geldstrafen und Freiheitsstrafen nach sich ziehen.
Welche Bank soll ich zum Testen nutzen?
Zum Testen funktioniert jede Bank aus der Liste. Wählen Sie eine aus, die Ihre Bewerbung bearbeiten muss. Die Algorithmen zur Barcode-Validierung sind für alle gleich. Was sich unterscheidet, ist die Bankleitzahl und die spezifischen Agentur-/Kontoregeln einiger Banken.