Premiers pas
À propos du générateur Boleto
Générateur de boleto au standard FEBRABAN : ligne typable et code barre.
Pas de rendu HTML, PDF ou graphique – juste des données prêtes pour JSON.
Idéal pour la génération de masse pour les tests automatisés.
Installation
Installez la bibliothèque à l'aide de votre gestionnaire de paquets préféré :
NPM
Shell
Installer via NPMYarn
Shell
Installer via YarnPNPM
Shell
Installer via PNPMImporter
Importez les fonctions de la bibliothèque dans votre projet TypeScript ou JavaScript :
JS
import { gerarBoleto } from '@box4dev/gerador-boleto';JS
const { gerarBoleto } = require('@box4dev/gerador-boleto');Usage
Générez facilement des données complètes de bordereau bancaire à l’aide de valeurs par défaut ou personnalisées.
Utilisation de base avec des données aléatoires
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.'} */Exemples par banque
JS
console.log(gerarBoleto({ banco: 'bradesco' }));console.log(gerarBoleto({ banco: 'caixa' }));console.log(gerarBoleto({ banco: 'itau' }));console.log(gerarBoleto({ banco: 'santander' }));Paramètres d'utilisation
JS
console.log( gerarBoleto({ banco: 'bradesco', valorDocumento: 15990, nossoNumero: '12345678901', agencia: '1229', codigoCedente: '0000469', carteira: '9', }));Paramètres d'utilisation
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', }));Banques prises en charge
Actuellement, la bibliothèque prend officiellement en charge les banques suivantes :
| Banque | Description |
|---|---|
| santander | Banco Santander (Code 033) |
| bradesco | Banco Bradesco (Code 237) |
| caixa | Caixa Econômica Federal (Code 104) |
| itau | Banco Itaú Unibanco (Code 341) |
Contribution
Les contributions sont les bienvenues ! Consultez le guide de contribution sur GitHub :
Dépôt GitHub @box4dev/gerador-boletoLicence
Distribué sous licence MIT. Libre pour une utilisation personnelle et commerciale.
Sécurité
Les bordereaux générés sont purement informatiques et destinés à des tests. Aucune donnée bancaire sensible n’est collectée ni envoyée à des serveurs externes.
Foire aux questions
Qu'est-ce qu'un bordereau bancaire (boleto) exactement ?
Un boleto est un document de crédit standardisé utilisé au Brésil pour le recouvrement des factures. Il contient un code-barres, une ligne saisissable, le montant, la date d'échéance et les informations sur le cédant (émetteur). Il peut être payé jusqu'à 90 jours après la date d'échéance dans les banques, les points de loterie et les plateformes en ligne.
A quoi sert le générateur Boleto ?
Il crée des boletos fictifs à des fins de test. Utilisez-le pour valider les masques de saisie, tester le traitement des lignes saisies, simuler des paiements dans des environnements de développement ou former des équipes sans utiliser de données réelles.
Les boletos générés sont-ils valides et peuvent-ils être payés ?
Non. Les boletos générés sont structurellement valides (suivre les normes techniques) mais n'ont aucune validité juridique ou financière. Aucune banque brésilienne n'acceptera le paiement d'un boleto généré par cet outil. Ils n'existent que sous forme de données de test.
Puis-je utiliser les boletos générés pour émettre des frais réels ?
Absolument pas. C'est une fraude et c'est un crime. L'utilisation de boletos falsifiés pour tenter de recevoir des paiements, tromper des personnes ou commettre une fraude viole la loi brésilienne (Loi sur la cybercriminalité - Loi 12.737/12 et Loi sur la fraude - Code pénal, article 171). Cela peut entraîner des poursuites pénales, des amendes substantielles et des peines d'emprisonnement.
Quelle banque dois-je utiliser pour les tests ?
N'importe quelle banque de la liste fonctionne pour les tests. Choisissez celui que votre demande doit traiter. Les algorithmes de validation des codes-barres sont les mêmes pour tous. Ce qui diffère, ce sont le code bancaire et les règles spécifiques de l'agence/du compte pour certaines banques.