🏦API REST Sistema bancário
Este projeto foi desenvolvido para o desafio do Módulo 2 do Curso Desenvolvimento de Software com foco em BackEnd pela Cubos Academy.
-
Criar Conta Bancária: Crie facilmente uma nova conta bancária.
-
Listar Contas Bancárias: Consulte uma lista completa de todas as contas bancárias cadastradas.
-
Atualizar Dados do Usuário: Atualize informações do titular da conta, como nome, data de nascimento e telefone.
-
Excluir Conta Bancária: Encerre uma conta bancária existente.
-
Depositar: Faça depósitos em sua conta bancária para aumentar o saldo.
-
Sacar: Realize saques de sua conta para retirar dinheiro.
-
Transferir Valores: Transfira fundos entre diferentes contas bancárias.
-
Consultar Saldo: Verifique o saldo atual de sua conta.
-
Emitir Extrato Bancário: Obtenha um extrato detalhado das transações em sua conta.
📌Listar contas bancárias
GET /contas?senha_banco=Cubos123Bank
Este endpoint tem a finalidade de listar todas as contas bancárias existentes.
É obrigatório verificar se a senha do banco foi informada como parâmetro de consulta na URL e validar se a senha do banco está correta.
A requisição deve incluir o seguinte parâmetro de consulta: "senha_banco".
A resposta esperada é uma listagem de todas as contas bancárias existentes.
📌Criar conta bancária
POST /contas
Este endpoint cria uma nova conta bancária, gerando um número exclusivo para identificação.
As verificações incluem campos únicos para CPF e e-mail, garantindo que todos os campos obrigatórios estejam preenchidos e definindo um saldo inicial de 0.
📌Excluir Conta
DELETE /contas/:numeroConta
Esse endpoint deve excluir uma conta banária existente.
ele só permite exluir se o saldo da coonta for zero.
Você deve passar o número da conta como paramtero URL e ele verifica se é válido.
📌Depositar
POST /transacoes/depositar
Esse endpoint deverá somar o valor do depósito ao saldo de uma conta válida e registrar essa transação.
Ele vai verificar se o numero da conta e o valor do depósito foi informado no body. Verifica se a conta existe e não permite valores de depósito zerados.
Vai somar o valor dos depósitos no saldo da conta.
📌Sacar
POST /transacoes/sacar
Este endpoint permite realizar saques em contas bancárias.
É necessário fornecer o número da conta, valor do saque e senha. Ele verifica se a conta existe, se a senha é válida, se há saldo disponível e registra a transação.
📌Tranferir
POST /transacoes/transferir
Este endpoint permite transferir recursos entre contas bancárias. É necessário fornecer número da conta de origem, número da conta de destino, senha da conta de origem e valor da transferência.
Ele verifica se ambas as contas existem,se a senha é válida, se há saldo disponível na conta de origem e registra a transação.
📌Saldo
GET /contas/saldo?numero_conta=123&senha=123
Este endpoint retorna o saldo de uma conta bancária.
Você deve fornecer o número da conta e a senha como query params na URL.
O endpoint verifica se a conta existe, se a senha é válida e exibe o saldo da conta em questão como resposta.
📌Extrato
GET /contas/extrato?numero_conta=123&senha=123
Este endpoint lista as transações realizadas em uma conta específica.
Você deve fornecer o número da conta e a senha como query params na URL.
O endpoint verifica se a conta existe, se a senha é válida e retorna um relatório com as transferências, depósitos e saques realizados na conta em questão.
💻 Rodando o projeto :
# 1. Clone o projeto
git clone <urlProjeto>
# 2. Instale as dependências
npm install
# 3. Execute
npm run dev
🚩 Contribua com o projeto:
- Realize o fork
- Faça as modificações
- Realize o Pull Request(PR)
✒️ Autora
- Paula Borges