Skip to content

A basic banking service API. Features account registration, money transfer, deposits, withdrawal and admin privileges like adding users, disabling a user's account, reverting transactions and deleting user accounts

Notifications You must be signed in to change notification settings

breellz/basic-banking-service-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation can be found here: https://documenter.getpostman.com/view/11784799/UVREiitp

Deployed here: https://breellz-banking-service-api.herokuapp.com/

Local Server url: localhost:3000

production server url: https://breellz-banking-service-api.herokuapp.com

Features

Users can:

  • Login
  • Deposit money
  • Withdraw money
  • Transfer funds to other users
  • See a list of their transactions

Admin can:

  • Add users
  • Delete users
  • Reverse transactions(transfer)
  • Disable a user’s account

Feature breakdown:

To use Admin priviledges, create an admin account and use the provided token. Also, to use user features,create account as a user and use the provided token

Every user has a createdby property which contains the Id of the admin that created the user

Once a user deposits money a transaction of type "DEPOSIT" is created for that user, same goes for withdrawal with appropriate type of transaction created.

when a user transfers funds, a transaction of type "TRANSFER" is created for them and the recepient, a transaction of type "CREDIT" is created.

Users can see a list of their transactions, be it deposit, withdrawal, transfer, credit or all of them.

Only administrators can create accounts for users

Admins can delete user accounts(all their transactions are deleted also)

Admins can reverse a transaction and also disable a user's account

Getting Started

1 fork the repo

  1. clone to your local machine

  2. npm install

  3. npm start

Prerequisites

  • npm packages

npm install

Installation

  1. fork the repo

  2. clone the Repo

  3. install dependencies npm install

  4. run dev server npm run dev

  5. Test components npm test

About

A basic banking service API. Features account registration, money transfer, deposits, withdrawal and admin privileges like adding users, disabling a user's account, reverting transactions and deleting user accounts

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published