eduardoconti/boleto

API para gerenciamento de cobranças. É possível gerar cobranças com boleto a partir de um arquivo .csv ou um JSON, após criado a cobrança será enviado um email com as informações para o devedor.

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Este é um projeto de API para geração e processamento de pagamentos via boleto.

A partir do endpoint /cobranca é possivel criar um cobrança com boleto de forma síncrona.

A partir do endpoint /cobranca/csv todo processamento de geração de cobrança, boleto e envio de email ocorre totalmente de forma assincrona.

A documentação dos endpoints pode ser vista neste endpoint após iniciar a aplicação

Requisitos

Precisamos criar um sistema de cobrança que:

• Seja capaz de receber uma lista via API, com um CSV de nomes, CPFs, e-mails, valor da divida, vencimento da divida e cod. da divida.

name,governmentId,email,debtAmount,debtDueDate,debtId
John [Doe,11111111111,johndoe@kanastra.com.br,1000000.00,2022-10-12,8291](mailto:Doe,11111111111,johndoe@kanastra.com.br,1000000.00,2022-10-12,8291) 

• Baseado nos inputs, o sistema precisa regularmente gerar os boletos p/ cobrança e disparar e-mails cobrando a lista
• O sistema também precisa ser capaz de receber uma comunicação JSON do banco (webhook), avisando que um boleto foi pago e liquidado diretamente em nossa conta bancária, para dar baixa desse boleto no sistema. Exemplo de payload do webhook JSON que iremos receber para cada registro de pagamento:

{
	"debtId": "8291",
	"paidAt": "2022-06-09 10:00:00",
	"paidAmount": 100000.00,
	"paidBy": "John Doe"
}

Installation

$ yarn

Running the app

# development
$ sh start.sh

Test

# unit tests
$ yarn test

# test coverage
$ yarn test:cov

License

Nest is MIT licensed.