🏦 CENTRAL BANK OF LEARNABLE

Central Bank of Learnable is a banking service platform that makes online banking seamless for their customers.

BACKEND API ENDPOINTS

Data can be fetched with any kind of methods you know (fetch API, Axios, ...)
The following endpoints are available from the API perspective.

Home Route

curl -X GET  http://localhost:8800/api/

Admin Endpoints

Register as Admin

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  http://localhost:8800/api/admin/register \
  -d '{
    "username": "Cyril",
    "firstName": "Cyril",
    "lastName": "Chukwuebuka",
    "tel": "08138678993",
    "email": "cyrilchuks@gmail.com",
    "password": "123456"
}'

Response

"Admin registration was successful"

Login as Admin

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  http://localhost:8800/api/admin/login \
  -d '{
    "email": "cyrilchuks@gmail.com",
    "password": "123456"
}'

Response
Admin token

{
  "authentication-token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"  
}

Delete User

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/delete/:userAccount 

Response
returns json of deleted user

    {
        "username": "Cyril",
        "firstName": "Cyril",
        "lastName": "Chukwuebuka",
        "email": "cyrilchuks@gmail.com",
        "tel": "08138678993",
        "password": "...",
        "balance": 0,
        "transactionId": ...,
        "account": "...",
        "isAccountDisabled": false,
        "credit": [],
        "debit": [],
        "_id": "...",
        "date": "2021-12-14T16:14:28.607Z",
        "createdAt": "2021-12-14T16:14:28.619Z",
        "updatedAt": "2021-12-14T16:14:28.619Z",
        "__v": 0
    }

Get all registered User

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X GET \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/users

Response
Returns list of registered user object

[
    [
        {
        "username": "Cyril",
        "firstName": "Cyril",
        "lastName": "Chukwuebuka",
        "email": "cyrilchuks@gmail.com",
        "tel": "08138678993",
        "password": "...",
        "balance": 0,
        "transactionId": ...,
        "account": "...",
        "isAccountDisabled": false,
        "credit": [],
        "debit": [],
        "_id": "...",
        "date": "2021-12-14T16:14:28.607Z",
        "createdAt": "2021-12-14T16:14:28.619Z",
        "updatedAt": "2021-12-14T16:14:28.619Z",
        "__v": 0
    },
    {
      ...
    },
    ...
    ]
]

Disable User (De-activate User)

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/deactivate-account/:userAccount

Response

"The account <userAccount> has been disabled"

Enable User (Re-activate User)

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/reactivate-account/:userAccount

Response

"The account <userAccount> has been reactivated"

Reverse Transaction (Transfer)

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/reverse-transaction/:transactionID

Response

"The transaction with transactionID: <transactionID> has been reversed"

Get all transactions ever made on the banking platform

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X GET \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/admin/transactions

Response

{
    "credits": [
        {
            "type": "CREDIT",
            "id": 1639383662644,
            "sender": {
                "name": "Cyril Chukwuebuka",
                "account": "7508145145"
            },
            "receiver": {
                "name": "Chuks Muofunanya",
                "account": "7508145145"
            },
            "amount": 4000,
            "date": 1639383662659
        },
        {
            ...
        },
        ...
    ],
    "debits": [
        {
            "type": "DEBIT",
            "id": 163940896099,
            "sender": {
                "name": "Chuks Muofunanya",
                "account": "2706995779"
            },
            "receiver": {
                "name": "Cyril Chukwuebuka",
                "account": "7508145145"
            },
            "amount": 2000,
            "date": 1639408960988
        },
        {
            ...
        },
        ...
    ]
}

Auth Endpoints

Add User (Register User)

Only logged in Admin with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  -H 'authentication-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9' \
  http://localhost:8800/api/auth/register \
  -d '{
    "username": "Cyril",
    "firstName": "Cyril",
    "lastName": "Chukwuebuka",
    "tel": "08138678993",
    "email": "cyrilchuks@gmail.com",
    "password": "123456"
}'

Response
returns json of registered user

    {
        "username": "Cyril",
        "firstName": "Cyril",
        "lastName": "Chukwuebuka",
        "email": "cyrilchuks@gmail.com",
        "tel": "08138678993",
        "password": "...",
        "balance": 0,
        "transactionId": ...,
        "account": "...",
        "isAccountDisabled": false,
        "credit": [],
        "debit": [],
        "_id": "...",
        "date": "2021-12-14T16:14:28.607Z",
        "createdAt": "2021-12-14T16:14:28.619Z",
        "updatedAt": "2021-12-14T16:14:28.619Z",
        "__v": 0
    }

Login as a User

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \
  http://localhost:8800/api/auth/login \
  -d '{
    "email": "cyrilchuks@gmail.com",
    "password": "123456"
}'

Response
User token

{
    "authentication-token": "axJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}

User Endpoints

Deposit

Only logged in User with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \  
  -H 'authentication-token: axJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
  http://localhost:8800/api/user/deposit?amount=<amount>  
  

Response

" <amount> deposited sucessfully "

Withdraw

Only logged in User with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \  
  -H 'authentication-token: axJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
  http://localhost:8800/api/user/withdraw?amount=<amount>  
  

Response

" <amount> withdrawn sucessfully "

Transfer

Only logged in User with verified authentication token can perform this function

Request Example:

curl -X POST \
  -H 'Content-Type: application/json' \  
  -H 'authentication-token: axJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
  http://localhost:8800/api/user/transfer?amount=<amount>&receiver=<account no>  
  

Response

" <amount> transfered sucessfully "

User Transactions(Get all transactions personal to the user)

Only logged in User with verified authentication token can perform this function

Request Example:

curl -X GET \
  -H 'Content-Type: application/json' \  
  -H 'authentication-token: axJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
  http://localhost:8800/api/user/transactions 
  

Response

{
    "credits": [
        {
            "type": "CREDIT",
            "id": 1639383662644,
            "sender": {
                "name": "Cyril Chukwuebuka",
                "account": "7508145145"
            },
            "receiver": {
                "name": "Chuks Muofunanya",
                "account": "7508145145"
            },
            "amount": 4000,
            "date": 1639383662659
        },
        {
            ...
        },
        ...
    ],
    "debits": [
        {
            "type": "DEBIT",
            "id": 163940896099,
            "sender": {
                "name": "Chuks Muofunanya",
                "account": "2706995779"
            },
            "receiver": {
                "name": "Cyril Chukwuebuka",
                "account": "7508145145"
            },
            "amount": 2000,
            "date": 1639408960988
        },
        {
            ...
        },
        ...
    ]
}