Caio-Pedras/projeto18-valex

API Reference

In this section, you will find the API's endpoints and their respective descriptions, along with the request and response examples. All data is sent and received as JSON.

Routes

Cards /cards

• Create a card
• Activate a card
• Get Balance and transactions
• Block a card
• Unblock a card
• Create a virtual card

Payments /payment

• New payment

Recharges /recharge

• New recharge

Cards

  ‣   Create a card

Create a card

POST https://valex-t6.herokuapp.com/cards

  ☰   Request

Body

{
  "employeeId": "1",
  "cardType": "restaurant"
}

Headers

{
  "x-api-key": "this-is-a-needlessly-long-placeholder-api-key"
}

  ☰   Responses

Status Code	Description	Properties
201	Created	data: {cardData}
400	Bad Request	error: { message, details }
401	Unauthorized	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

cardData example

{
  "number": "5379-6040-7875-1659",
  "cardholderName": "CICLANA M MADEIRA",
  "securityCode": "175",
  "expirationDate": "09/27",
  "type": "health",
  "employeeId": 2,
  "isVirtual": false,
  "isBlocked": false
}

  ‣   Activate a card

Activate a card

PUT https://valex-t6.herokuapp.com/cards/activate/${cardId}

  ☰   Request

Body

{
  "cvc": "950",
  "password": "1234"
}

  ☰   Responses

Status Code	Description	Properties
200	OK	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

  ‣   Get Balance and Transactions

Get Balance and Transactions

GET https://valex-t6.herokuapp.com/cards/transactions/${cardId}

  ☰   Responses

Status Code	Description	Properties
200	OK	data: {transactionsData}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

transactionsData example

{
  "balance": 600,
  "transactions": [
    {
      "id": 18,
      "cardId": 10,
      "businessId": 5,
      "timestamp": "2022-09-05T19:02:31.000Z",
      "amount": 150,
      "businessName": "Unimed"
    },
    {
      "id": 19,
      "cardId": 10,
      "businessId": 5,
      "timestamp": "2022-09-05T19:02:35.000Z",
      "amount": 250,
      "businessName": "Unimed"
    }
  ],
  "recharges": [
    {
      "id": 5,
      "cardId": 10,
      "timestamp": "2022-09-05T19:02:17.000Z",
      "amount": 1000
    }
  ]
}

  ‣   Block a card

Block a card

POST https://valex-t6.herokuapp.com/card/block/${cardId}

  ☰   Request

Body

{
  "password": "1234"
}

  ☰   Responses

Status Code	Description	Properties
200	OK	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

  ‣   Unblock a card

Unblock a card

POST https://valex-t6.herokuapp.com/card/unblock/${cardId}

  ☰   Request

Body

{
  "password": "1234"
}

  ☰   Responses

  ‣   Create a virtual card

Create a virtual card

POST https://valex-t6.herokuapp.com/cards/virtual${originalCardId}

  ☰   Request

Body

{
  "password": "1234"
}

  ☰   Responses

Status Code	Description	Properties
200	OK	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

Payments

  ‣   New payment

Create a new payment

POST https://valex-t6.herokuapp.com/payment

  ☰   Request

Body

{
  "cardId": 1,
  "password": "1234",
  "businessId": 3,
  "amount": 100
}

  ☰   Responses

Status Code	Description	Properties
201	Created	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

  ‣   New online payment

Create a online payment

POST https://valex-t6.herokuapp.com/payment/online

  ☰   Request

Body

{
  "number": "5273-9536-2600-3288",
  "cardHolderName": "CICLANA M MADEIRA",
  "expirationDate": "09/27",
  "cvc": "389",
  "businessId": 3,
  "amount": 100
}

  ☰   Responses

Status Code	Description	Properties
201	Created	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }

Recharges

  ‣   New recharge

Create a online payment

POST https://valex-t6.herokuapp.com/payment/${cardId}

  ☰   Request

Body

{
  "amount": 1000
}

Headers

{
  "x-api-key": "this-is-a-needlessly-long-placeholder-api-key"
}

  ☰   Responses

Status Code	Description	Properties
201	Created	data: {}
400	Bad Request	error: { message, details }
404	Not Found	error: { message, details }
422	Unprocessable Entity	error: { message, details }
500	Internal Server Error	error: { message, details }