Bank Management System

This is a simple bank management system that allows you to create a bank account, deposit money, withdraw money, and check your balance.

How to run

Clone the repository
Open the project in your IDE
Install the dependencies by running mnv clean install
Run the project
Open your browser and go to localhost:8080/swagger-ui.html to see the API documentation

Requirements

Java 17
Maven
PostgresSql

API Documentation

The API documentation can be found at localhost:8080/swagger-ui.html

Database

The database is a PostgresSql database. The database name is bank_management_system and the username is _yourUserName_ and the password is _yourPassword_. You can change the database name, username, and password in the application.properties file.

Endpoints

Create Customer

POST /v1/customer

Request

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "nationalId": "string"
}

Response

{
  "firstName": "string",
  "lastName": "string",
  "nationalId": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "isActive": true,
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "accounts": []
}

Update Customer

PUT /v1/customer/{id}

Request

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  }
}

Response

{
  "firstName": "string",
  "lastName": "string",
  "nationalId": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "isActive": true,
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "accounts": [
    {
      "accountNumber": "string",
      "balance": 0,
      "isActive": true,
      "accountType": "SAVINGS",
      "accountStatus": "ACTIVE",
      "accountLimit": 0,
      "accountLimitType": "DAILY",
      "accountLimitStatus": "ACTIVE",
      "accountLimitAmount": 0,
      "accountLimitStartDate": "2022-12-07",
      "accountLimitEndDate": "2022-12-07"
    }
  ]
}

Delete Customer

DELETE /v1/customer/{id}

Response

{
  "firstName": "string",
  "lastName": "string",
  "nationalId": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "isActive": false,
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "accounts": [
    {
      "accountNumber": "string",
      "balance": 0,
      "isActive": false,
      "accountType": "SAVINGS",
      "accountStatus": "INACTIVE",
      "accountLimit": 0,
      "accountLimitType": "DAILY",
      "accountLimitStatus": "INACTIVE",
      "accountLimitAmount": 0,
      "accountLimitStartDate": "2022-12-07",
      "accountLimitEndDate": "2022-12-07"
    }
  ]
}

Get Customer ById

GET /v1/customer/getCustomerById/{id}

Response

{
  "firstName": "string",
  "lastName": "string",
  "nationalId": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "isActive": true,
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "accounts": [
    {
      "accountNumber": "string",
      "balance": 0,
      "isActive": true,
      "accountType": "SAVINGS",
      "accountStatus": "ACTIVE",
      "accountLimit": 0,
      "accountLimitType": "DAILY",
      "accountLimitStatus": "ACTIVE",
      "accountLimitAmount": 0,
      "accountLimitStartDate": "2022-12-07",
      "accountLimitEndDate": "2022-12-07"
    }
  ]
}

Get Customer By NationalId

GET /v1/customer/{nationalId}

Response

{
  "firstName": "string",
  "lastName": "string",
  "nationalId": "string",
  "email": "string",
  "password": "string",
  "phone": "string",
  "isActive": true,
  "address": {
    "addressLine": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "zipCode": "string"
  },
  "accounts": [
    {
      "accountNumber": "string",
      "balance": 0,
      "isActive": true,
      "accountType": "SAVINGS",
      "accountStatus": "ACTIVE",
      "accountLimit": 0,
      "accountLimitType": "DAILY",
      "accountLimitStatus": "ACTIVE",
      "accountLimitAmount": 0,
      "accountLimitStartDate": "2022-12-07",
      "accountLimitEndDate": "2022-12-07"
    }
  ]
}

Get All Customers

GET /v1/customer

Response

[
  {
    "firstName": "string",
    "lastName": "string",
    "nationalId": "string",
    "email": "string",
    "password": "string",
    "phone": "string",
    "isActive": true,
    "address": {
      "addressLine": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "zipCode": "string"
    },
    "accounts": [
      {
        "accountNumber": "string",
        "balance": 0,
        "isActive": true,
        "accountType": "SAVINGS",
        "accountStatus": "ACTIVE",
        "accountLimit": 0,
        "accountLimitType": "DAILY",
        "accountLimitStatus": "ACTIVE",
        "accountLimitAmount": 0,
        "accountLimitStartDate": "2022-12-07",
        "accountLimitEndDate": "2022-12-07"
      }
    ]
  }
]

Account

Create Account

POST /v1/account

Request

{
  "accountType": "SAVINGS",
  "accountLimitType": "DAILY",
  "customerId": 0
}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Update Account

PUT /v1/account/{accountNumber}

Request

{
  "accountType": "SAVINGS",
  "accountLimitType": "DAILY"
}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Delete Account

DELETE /v1/account/{accountNumber}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Get All Accounts

GET /v1/account

Response

[
  {
    "accountNumber": "string",
    "balance": 0,
    "isActive": true,
    "accountType": "SAVINGS",
    "accountStatus": "ACTIVE",
    "accountLimit": 0,
    "accountLimitType": "DAILY",
    "accountLimitStatus": "ACTIVE",
    "accountLimitAmount": 0,
    "accountLimitStartDate": "2022-12-07",
    "accountLimitEndDate": "2022-12-07"
  }
]

Get Account By Account Number

GET /v1/account/{accountNumber}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Add Money To Account

POST /v1/account/add/{accountNumber}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Withdraw Money From Account

POST /v1/account/withdraw/{accountNumber}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Transfer Money From Account

POST /v1/account/transfer/{accountNumber}

Request

{
  "fromAccountNumber": "string",
  "toAccountNumber": "string",
  "amount": 0
}

Response

{
  "accountNumber": "string",
  "balance": 0,
  "isActive": true,
  "accountType": "SAVINGS",
  "accountStatus": "ACTIVE",
  "accountLimit": 0,
  "accountLimitType": "DAILY",
  "accountLimitStatus": "ACTIVE",
  "accountLimitAmount": 0,
  "accountLimitStartDate": "2022-12-07",
  "accountLimitEndDate": "2022-12-07"
}

Built With

Spring Boot - The web framework used
Maven - Dependency Management
PostgreSQL - Database
Swagger - API Documentation
Docker - Containerization

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
src		src
DockerFile		DockerFile
README.md		README.md
devBank.iml		devBank.iml
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pom.xml		pom.xml

BerkayMehmetSert/spring-boot-devBank

Folders and files

Latest commit

History

Repository files navigation

Bank Management System

How to run

Requirements

API Documentation

Database

Endpoints

Create Customer

Request

Response

Update Customer

Request

Response

Delete Customer

Response

Get Customer ById

Response

Get Customer By NationalId

Response

Get All Customers

Response

Account

Create Account

Request

Response

Update Account

Request

Response

Delete Account

Response

Get All Accounts

Response

Get Account By Account Number

Response

Add Money To Account

Response

Withdraw Money From Account

Response

Transfer Money From Account

Request

Response

Built With

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages