Valex

A Typescript designed project to manage benefit cards among companies and employees

Valex

Built With

Description

Valex simulates an API that manages a benefit card, generally made available by companies to their employees.

Features

Get the card balance and transactions
Create cards
Activate / Block / Unlock a card
Recharge a card
Make card payments

API Reference

Create a card

POST /create

Request:

Headers	Type	Description
`x-api-key`	`string`	Required. api key

Body	Type	Description
`employeeId`	`integer`	Required. user Id
`typeCard`	`string`	Required. type of card benefit

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

Response:

{
	"number": "1111 1111 1111 1111",
	"cardholderName": "NAME N NAME",
	"cardCvv": "111",
	"cardExpirationDate": "01/27",
	"type": "card type"    
}

Activate a card

PUT /activation

Request:

Body	Type	Description
`number`	`string`	Required. card number
`securityCode`	`string`	Required. card cvv
`password`	`string`	Required. card password

Password length: 4

Password pattern: only numbers

Cvv length: 3

Block a card

PUT /block

Request:

Body	Type	Description
`number`	`string`	Required. card number
`password`	`string`	Required. card password

Unlock a card

PUT /unlock

Request:

Body	Type	Description
`number`	`string`	Required. card number
`password`	`string`	Required. card password

Get card transactions

GET /transactions

Request:

Body	Type	Description
`cardId`	`integer`	Required. card Id

Recharge a card

POST /createRecharge

Request:

Headers	Type	Description
`x-api-key`	`string`	Required. api key

Body	Type	Description
`number`	`string`	Required. card number
`amount`	`integer`	Required. recharge amount

Card payments

POST /createPayment

Request:

Body	Type	Description
`number`	`string`	Required. card number
`businessName`	`string`	Required. business name
`password`	`string`	Required. card password
`amount`	`integer`	Required. payment amount

Environment Variables

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

DATABASE_URL = postgres://UserName:Password@Hostname:5432/DatabaseName

PORT = number #recommended:5000

Run Locally

Clone the project

  git clone https://github.com/Leticia-Pinheiro/Valex_BackEnd

Go to the project directory

  cd Valex_BackEnd/

Install dependencies

  npm install

Create database

  cd database/

  bash ./create-database

  cd ../

Start the server

  npm start

Authors

Letícia Gomez Pinheiro

Linkedin: https://www.linkedin.com/in/leticia-pinheiro-33354a1b6/

GitHub: https://github.com/Leticia-Pinheiro