Documentação V1

LICENÇA

AGPL-3.0 License

Formato da url

http://localhost/{versao-api}/{recurso}/{path}

Recursos e requisições

1. Account
   • conta com os tipos poupança, corrente e pagamento
   • bloquear e desbloquear cada conta
   • limite de transações diários por valor
   • limite de saque diário por valor
   • extrato por periodo
2. User
   • listar todos os usuários
   • buscar um determinado usuario
3. Transaction
   • listar todas as transações
   • buscar uma transação por codigo publico
   • realiza operação de deposito em uma conta;
   • realiza operação de saque em uma conta;
   • realiza operação de transferencia entre contas do sistema;
   • simular confirmação de deposito(boleto) por serviço externo

---

Documentação tecnica (paths) e exemplos

• utilizar o insomnia,

  Importar o arquivo Insomnia.json

  Pastas com cada recurso do sistema

  Requisição já contem informações e documentação (depois da aba Header, existe Docs)

---

Banco de dados (postgres)

• Diagrama

---

cronJOB

• A cada 15 minutos das 6:00 até 18:00 de segunda a sexta, será confirmado depositos por boletos (simulação serviço externo)

---

Instruções instalação e utilização

• Manual de execução

---

Observações

• Após cria um deposito, Só será possivel fazer movimentações com esse dinheiro depois que o cronJOB executar e confirmar os boletos
• Ao executar o script npm run build faz os seguintes inserts:
  • Tipos de contas
  • Tipos de transações
  • Status de uma transação
  • Tipo de movimentação que contem uma transação
  • Usuários com nome basico completo
  • Conta para usuários basico completo