okabamac/Banka-API

Documentation for Banka API

Banka-API

Documentation for Banka API v0.0.0 url: https://banka-ch-api.herokuapp.com Root: /api/v1/

• Account

  • Create account
  • Delete account
  • Retrieve account
  • Retrieve accounts
  • Update account

• Auth

  • Authenticate Signup
  • Authenticate Signin

• User

  • Create user
  • Delete user
  • Retrieve user
  • Retrieve users

• Transaction

  • Credit account
  • Debit account

Account

Create Account

POST /accounts

Parameters

Name	Type	Description
firstName	String	user first name.
lastName		user last name
dob	ISO Date(1995-05-25)	user date of birth.
sex	String	user sex
email		user email
phone		user phone
type		'current' or 'savings'
currency		'Naira' or 'Dollar'
address		user address

Delete account

DELETE /accounts/:account-number

Parameters

Name	Type	Description
account-number	Integer	Account number to be deleted

Retrieve account

GET /accounts/:account-number

Retrieve accounts

GET /accounts

Update account

PATCH /accounts/:account-number

Parameters

Name	Type	Description
status	String	Status to patch; 'active' or 'dormant'

Auth

Authenticate Signup

POST /auth/signup

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
access_token	String	JWT token

Authenticate Signin

POST /auth/signin

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
access_token	String	JWT token

User

Create user

POST /users

Parameters

Name	Type	Description
firstName	String	user first name.
lastName		user last name
email		user email
password	String	user password
confirmPassword

Delete user

DELETE /users/:id

Parameters

Name	Type	Description
id	Integer	User id.

Retrieve user

GET /users/:id

Retrieve users

GET /users

Parameters

Name	Type	Description
id	Integer	User id.

Transaction

Credit Account

POST /transactions/:account-number/credit

Parameters

Name	Type	Description
amount	Integer	Amount to Credit
transactionType	String	'Credit' or 'Debit'

Debit Account

POST /transactions/:account-number/debit

Parameters

Name	Type	Description
amount	Integer	Amount to debit
transactionType	String	'Credit' or 'Debit'