Valex

18th Project of Driven Education

An API Project to manage benefit cards

Built With

• Get the card balance and transactions
• Create cards
• Activate / Block / Unlock a card
• Recharge a card
• Make card payments with online payment option

{
    "x-api-key": string
}

{
    "employeeId": integer,
    "cardType": string
}

{   
    "cardId": 1,
	"number": "1111 1111 1111 1111",
	"cardholderName": "NAME N NAME",
	"creditCardCVC": "111",
	"expirationDate": "01/27",
}

{
    "employeeId": integer,
    "secutiryCode": string,
    "password": string
}

{
    "x-api-key": string
}

{
    "cardId": integer,
    "value": integer,
}

{
    "cardId": integer,
    "password": string
}

{
    "cardId": integer,
    "password": string
}

{
    "cardId": integer
}

{
    "cardId": integer,
    "businessId": integer,
    "cardPassword": string,
    "value": integer 

    // value: use 4000 instead of 40.00 
}

POST /cards/create

Valid types: [groceries, restaurant, transport, education, health]

{   
    "cardId": 1,
	"number": "1111 1111 1111 1111",
	"cardholderName": "NAME N NAME",
	"creditCardCVC": "111",
	"expirationDate": "01/27",
}

PATCH /cards/activate

Password length: 4

Password pattern: only numbers

CVV max length: 3

CVV pattern: only numbers

POST /cards/recharge

PATCH /cards/block

Password length: 4

Password pattern: only numbers

PATCH /cards/unlock

Password length: 4

Password pattern: only numbers

GET /cards/statement/:cardId

{
"balance": 35000,
"transactions": [
{ "id": 1, "cardId": 1, "businessId": 1, "businessName": "DrivenEats", "timestamp": "22/01/2022", "amount": 5000 },{...},{...}
],
"recharges": [
{ "id": 1, "cardId": 1, "timestamp": "21/01/2022", "amount": 40000 },{...},{...}
]
}

POST /purchases/pos/

Value: must be without period, like '4000' instead of '40.00'

To run this project, you will need to add the following environment variables to your .env file

DATABASE_URL = postgres://YOUR-USER-NAME:YOUR-PASSWORD@Hostname:5432/DatabaseName

PORT = number

CRYPTR_SECRET = any string

Clone the project

  git clone https://github.com/DarlonGomes/projeto18-valex

Go to the project directory

  cd projeto18-valex/

Install dependencies

  npm install

Create database

  cd valex-setup/

  bash ./create-database

  cd ../../..

Start the server

  npm run start

• API Architecture
• TypeScript interfaces
• TypeScript types
• Classes
• Constructor
• Object Literals

• Badges for Github
• README inspiration

• Darlon Gomes is a student at Driven Education and is putting effort into switch careers. Nowadays he works with Fine Woodworking looking forward to become a Fullstack Dev.