aryelgois/bank-interchange

Generate Bank Billets and Shipping Files, and read Return Files to interact with Banks

Bank Interchange

Index:, _(*1)

• Intro
  • pt_BR | en_US
• Setup
• TODO
• Documentation
• Changelog

Intro

pt_BR

Esse pacote implementa as especificações do CNAB240 e do CNAB400, definido pelo FEBRABAN, e contém geradores de boleto para diversos bancos, em PHP., _(*2)

O CNAB permite a comunicação entre empresas e bancos, organizando as informações em arquivos de texto com uma estrutura predefinida, _(*3)

O objetivo desse pacote é automatizar a criação de Boletos bancários e Arquivos Remessa, e facilitar a leitura de Arquivos Retorno em um servidor web:, _(*4)

1. Quando o cliente realiza uma compra, por exemplo, um Título bancário é criado

• Esse Título pode ser representado como um boleto, em PDF

1. Um Arquivo Remessa, contendo um ou mais Títulos, é gerado e enviado ao banco antes que o cliente efetue o pagamento, _(*5)

2. O banco envia um Arquivo Retorno informando se o Título foi aceito, pago, tem algum erro, ou alguma outra ocorrência, _(*6)

3. Após o administrador conferir o resultado, o banco de dados é atualizado com novos dados, _(*7)

en_US

This package implements CNAB240 and CNAB400 specifications, defined by FEBRABAN (a Brazilian organization), and contains bank billet generators for various banks, in PHP., _(*8)

The CNAB allows a comunication between enterprises and banks, organizing the information in text files with a predefined layout, _(*9)

This package aims to automate the generation of bank billets and Shipping Files, and to help reading Return Files in a web server:, _(*10)

1. When your client buys something, for exemple, a banking Title is created

• This Title can be rendered as a bank billet, in PDF

1. A Shipping File, containing one or more Titles, is generated and sent to the bank before the client makes the payment, _(*11)

2. The bank sends a Return File informing if the Title was accepted, paid, has an error, or some other occurrence, _(*12)

3. After the administrator checks the result, the database is updated with new data, _(*13)

Setup

1. Clone with Git, _(*14)

2. Create a web server with PHP 7 or higher, _(*15)

• Using Apache is recommended because the .htaccess files are already created, _(*16)

  • Enable the AllowOverride directive

• Set the Document Root to public/, _(*17)

• If you are using HTTPS, uncomment the line with SSLRequireSSL directive in public/.htaccess. It is highly recommended that you use SSL, _(*18)

1. Build the databases and run the generated SQL: see YASQL-PHP, _(*19)

   composer yasql-build && cat build/*.sql | mysql -u root -p
   

2. Change the database credentials in config/medools.php see Medools, _(*20)

3. Configure the Authentication secret in config/router.yml see Medools Router, _(*21)

• You also need to register users in the authentications table and add their authorizations

1. Now you can develop inside public/

• Make your app ajax request from server's /api/

TODO

• [ ] Real world tests
• [ ] A nice web interface

Documentation

Changelog