kylemassacre-mcc/bank

A bank module for the MCC api

MCC-API-Bank

For Laravel 5.1

Installation

Install via cli php artisan module:install kylemassacre-mcc/bank Open up app/Providers/AppServiceProvider.php and add in the register method:, _(*1)

$this->app->bind([
    ...
    \Modules\Bank\Providers\BankServiceProvider::class
]);

Run the artisan command: php artisan vendor:publish --provider="Modules\Bank\Providers\BankServiceProvider", _(*2)

API Endpoints:

Sample Responses

Successful Withdraw

{
  "success": {
    "message": "You have withdrew $1 from your account",
    "txn_details": {
      "amount": "$2",
      "past_balance": "$5",
      "new_balance": "$3",
      "fees": "$1"
    }
  }
}

Successful Deposit

{
  "success": {
    "message": "You have deposited $1 into your account",
    "txn_details": {
      "amount": "$2",
      "past_balance": "$3",
      "new_balance": "$4",
      "fees": "$1"
    }
  }
}

Invalid Responses

Malformed Amount, _(*3)

{
  "message": "422 Unprocessable Entity",
  "errors": {
    "amount": [
      "You must provide a valid transaction amount",
      "Your transaction amount must be at least $2"
    ]
  }
  ```
  *_Not enough funds_*
  ```json
  {
    "message": "You don't have enough funds to put that in your bank",
    "status_code": 200,
  }
  ```
  ```json
  {
    "message": "You don't have enough funds in your Cyber Bank",
    "status_code": 200,
  }
  ```
  *_No Bank_*
  ```json
  {
    "message": "You must own a Cyber Bank",
    "status_code": 200,
  }
  ```
  *_Purchase Bank_*
  ```json
{
    "success": "You have purchased a Bank"
}

Can't afford Bank, _(*4)

{
  "message": "You do not have $10,000,000 to open an account",
  "status_code": 200,
}

Already Own Bank, _(*5)

{
  "message": "You already own a Bank",
  "status_code": 200,
}