Skip to content

Jay200123/Reservation-API

BranchesTags

Repository files navigation

Reservation-API

Created a Reservation API using node js & typescript

Installation

git clone https://github.com/Jay200123/Reservation-API.git

cd Reservation-API

npm install

npm run dev

Authorization

All requests requires an Authorization header.

  • Basic Authentication Provide a base64-encoded username:password in the Authorization header.

  • JWT Authentication Use a valid jwt access_token & refresh_token obtained after successful login.

  • Role based Authentication Some API's are restricted to specific users (e.g. admin, user)

🐳 Docker Setup

This project uses Docker Compose for containerization.

Build & Start Services

docker compose up -d --build

docker compose logs -f

docker compose down

docker compose up -d --build
Builds fresh images (using the Dockerfile) and starts new containers in detached mode (running in the background).

docker compose logs -f

  • Shows the logs from all running containers.
  • -f (follow) keeps streaming new log output in real time (similar to tail -f).
  • Useful for debugging, especially if you want to watch your app or database logs as they happen.

docker compose down

  • Stops and removes all containers, networks, and volumes created by docker compose up.
  • Use this when you want to cleanly shut down your application.
  • Unlike docker compose stop, it also removes the default network, so the environment resets fully.

AUTH API's

Register User API

Method: POST

Endpoint: /api/v1/register

Headers

  • Authorization: Basic
  • Content-type: application/json

body

{
  "username": "johndoe",
  "password": "j0hnDo3123",
  "fullname": "John Doe",
  "email": "johndoe@gmail.com",
  "contact_number": "09123456789",
  "address": "Test Address",
  "city": "Test City"
}

response

{
  "status": 201,
  "details": {
    "0": {
      "username": "johndoe",
      "password": "$2b$10$DupMmHPWD7Gczmux5LU1vO58xhvf7Cd93cEXOp6Jh4z.CvpTgR7NC",
      "status": "PENDING",
      "role": "USER",
      "_id": "68d8cbbd83295b3feb2c77d6",
      "createdAt": "2025-09-28T05:46:37.266Z",
      "updatedAt": "2025-09-28T05:46:37.266Z",
      "__v": 0
    },
    "details": {
      "0": {
        "user": "68d8cbbd83295b3feb2c77d6",
        "fullname": "John Doe",
        "email": "johndoe@gmail.com",
        "contact_number": "0923456789",
        "address": "Test Address",
        "city": "Test City",
        "_id": "68d8cbbd83295b3feb2c77d8",
        "createdAt": "2025-09-28T05:46:37.307Z",
        "updatedAt": "2025-09-28T05:46:37.307Z",
        "__v": 0
      }
    }
  },
  "message": "User registered successfully"
}

Errors

  • 400 - "Username already exists".
  • 422 - "missing required fields"/ "Unknown fields".

Login API

Method: POST

Endpoint: /api/v1/login

Headers

  • Authorization: Basic
  • Content-type: application/json

body

{
  "username": "johndoe",
  "password": "j0hnDo3123"
}

response

{
  "status": 200,
  "details": {
    "user": {
      "_id": "68d8cbbd83295b3feb2c77d6",
      "username": "johndoe",
      "password": "$2b$10$DupMmHPWD7Gczmux5LU1vO58xhvf7Cd93cEXOp6Jh4z.CvpTgR7NC",
      "status": "PENDING",
      "role": "USER",
      "createdAt": "2025-09-28T05:46:37.266Z",
      "updatedAt": "2025-09-28T05:46:37.266Z",
      "__v": 0
    },
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjY4ZDhjYmJkODMyOTViM2ZlYjJjNzdkNiIsInVzZXJuYW1lIjoiam9obmRvZSIsInBhc3N3b3JkIjoiJDJiJDEwJER1cE1tSFBXRDdHY3ptdXg1TFUxdk81OHhodmY3Q2Q5M2NFWE9wNkpoNHouQ3ZwVGdSN05DIiwic3RhdHVzIjoiUEVORElORyIsInJvbGUiOiJVU0VSIiwiY3JlYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIiwidXBkYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIn0sImlhdCI6MTc1OTAzODQ0OSwiZXhwIjoxNzU5MDQyMDQ5fQ.dufgiFqpx05Xrfd1OXBFtaVJHR6f2PrNgXqpzHlzokY",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjY4ZDhjYmJkODMyOTViM2ZlYjJjNzdkNiIsInVzZXJuYW1lIjoiam9obmRvZSIsInBhc3N3b3JkIjoiJDJiJDEwJER1cE1tSFBXRDdHY3ptdXg1TFUxdk81OHhodmY3Q2Q5M2NFWE9wNkpoNHouQ3ZwVGdSN05DIiwic3RhdHVzIjoiUEVORElORyIsInJvbGUiOiJVU0VSIiwiY3JlYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIiwidXBkYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIn0sImlhdCI6MTc1OTAzODQ0OSwiZXhwIjoxNzYxNjMwNDQ5fQ.9Oja14MhBRcotZeDvQbgDl0INaf3aGjusESHVHHBpn0"
  },
  "message": "User logged in Successfully."
}

Errors

  • 400 - "Invalid email or password".
  • 422 - "missing required fields"/ "Unknown fields".
  • 401 - "Invalid Request".

Refresh Token API

Method: GET

Endpoint: /api/v1/refresh

Headers

  • Authorization: refresh_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjY4ZDhjYmJkODMyOTViM2ZlYjJjNzdkNiIsInVzZXJuYW1lIjoiam9obmRvZSIsInBhc3N3b3JkIjoiJDJiJDEwJER1cE1tSFBXRDdHY3ptdXg1TFUxdk81OHhodmY3Q2Q5M2NFWE9wNkpoNHouQ3ZwVGdSN05DIiwic3RhdHVzIjoiUEVORElORyIsInJvbGUiOiJVU0VSIiwiY3JlYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIiwidXBkYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIn0sImlhdCI6MTc1OTAzODc4NCwiZXhwIjoxNzU5MDQyMzg0fQ.75GnXZPTlGMyU3mQGNU0LJPeW8r_nlmAdYw7u-WjbUg",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Il9pZCI6IjY4ZDhjYmJkODMyOTViM2ZlYjJjNzdkNiIsInVzZXJuYW1lIjoiam9obmRvZSIsInBhc3N3b3JkIjoiJDJiJDEwJER1cE1tSFBXRDdHY3ptdXg1TFUxdk81OHhodmY3Q2Q5M2NFWE9wNkpoNHouQ3ZwVGdSN05DIiwic3RhdHVzIjoiUEVORElORyIsInJvbGUiOiJVU0VSIiwiY3JlYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIiwidXBkYXRlZEF0IjoiMjAyNS0wOS0yOFQwNTo0NjozNy4yNjZaIn0sImlhdCI6MTc1OTAzODc4NCwiZXhwIjoxNzYxNjMwNzg0fQ.6DnIZ3pk4_1vaBR6QRkTDyrvJIc5JR_Tf_8r1224hzI"
  },
  "message": "Success"
}

Errors

  • 400 - "Invalid Request".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

Logout API

Method: POST

Endpoint: /api/v1/logout

Headers

  • Authorization: access_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": [],
  "message": "Logout successfully"
}

Errors

  • 400 - "Invalid Request".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

USER API's

GET ALL USERS API

Method: GET

Endpoint: /api/v1/users

Headers

  • Authorization: access_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": [
    {
      "_id": "68bfbe00ec958d03b007fe13",
      "user": {
        "_id": "68bfbe00ec958d03b007fe11",
        "username": "john123",
        "password": "$2b$10$2lsL62zMfjGP1PwXw.oVF.l3AmnJjrR2QSyLSAN5wm2ZGraCfrP4y",
        "createdAt": "2025-09-09T05:41:20.681Z",
        "updatedAt": "2025-09-16T09:39:45.506Z",
        "__v": 0
      },
      "fullname": "John Doe",
      "email": "john.doe@gmail.com",
      "contact_number": "09123456789",
      "address": "New Orleans Washington",
      "city": "Chicago",
      "createdAt": "2025-09-09T05:41:20.733Z",
      "updatedAt": "2025-09-09T05:41:20.733Z",
      "__v": 0
    },
    {
      "_id": "68c92931b00d0f36a921e688",
      "user": {
        "_id": "68c92931b00d0f36a921e686",
        "username": "jay123",
        "password": "$2b$10$T.bmnz6s4MeBtXKIVy5U6u12V6WBKYriK9SxUSBMPVHJwQ7OGR5mO",
        "status": "PENDING",
        "role": "USER",
        "createdAt": "2025-09-16T09:09:05.451Z",
        "updatedAt": "2025-09-16T09:09:05.451Z",
        "__v": 0
      },
      "fullname": "Renyel Jay Sioc",
      "email": "renyeljay.sioc@yahoo.com",
      "contact_number": "09308650272",
      "address": "Block 156 Lot 17 Central Bicutan Arago Street",
      "city": "Taguig City",
      "createdAt": "2025-09-16T09:09:05.517Z",
      "updatedAt": "2025-09-16T09:09:05.517Z",
      "__v": 0
    },
    {
      "_id": "68d10ef0bd04042bdaee1031",
      "user": {
        "_id": "68d10ef0bd04042bdaee102f",
        "username": "admin",
        "password": "$2b$10$MnZmRCSDoZToBPCNvVzvQe3csHsqh5aLOBlPA07PU7/8mCpxfucpC",
        "status": "PENDING",
        "role": "ADMIN",
        "createdAt": "2025-09-22T08:55:12.007Z",
        "updatedAt": "2025-09-22T08:55:12.007Z",
        "__v": 0
      },
      "fullname": "Renyel Jay Sioc",
      "email": "jayAdmin@yahoo.com",
      "contact_number": "09505798533",
      "address": "Block 156 Lot 17 Central Bicutan Arago Street",
      "city": "Taguig City",
      "createdAt": "2025-09-22T08:55:12.050Z",
      "updatedAt": "2025-09-22T08:55:12.050Z",
      "__v": 0
    },
    {
      "_id": "68d8cbbd83295b3feb2c77d8",
      "user": {
        "_id": "68d8cbbd83295b3feb2c77d6",
        "username": "johndoe",
        "password": "$2b$10$DupMmHPWD7Gczmux5LU1vO58xhvf7Cd93cEXOp6Jh4z.CvpTgR7NC",
        "status": "PENDING",
        "role": "USER",
        "createdAt": "2025-09-28T05:46:37.266Z",
        "updatedAt": "2025-09-28T05:46:37.266Z",
        "__v": 0
      },
      "fullname": "John Doe",
      "email": "johndoe@gmail.com",
      "contact_number": "0923456789",
      "address": "Test Address",
      "city": "Test City",
      "createdAt": "2025-09-28T05:46:37.307Z",
      "updatedAt": "2025-09-28T05:46:37.307Z",
      "__v": 0
    }
  ],
  "message": "Success"
}

Errors

  • 404 - "Users not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

GET USER BY ID API

Method: GET

Endpoint: /api/v1/user/:id

parameters

  • id - unique user ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": {
    "_id": "68bfbe00ec958d03b007fe13",
    "user": {
      "_id": "68bfbe00ec958d03b007fe11",
      "username": "john123",
      "password": "$2b$10$2lsL62zMfjGP1PwXw.oVF.l3AmnJjrR2QSyLSAN5wm2ZGraCfrP4y",
      "createdAt": "2025-09-09T05:41:20.681Z",
      "updatedAt": "2025-09-16T09:39:45.506Z",
      "__v": 0
    },
    "fullname": "John Doe",
    "email": "john.doe@gmail.com",
    "contact_number": "09123456789",
    "address": "New Orleans Washington",
    "city": "Chicago",
    "createdAt": "2025-09-09T05:41:20.733Z",
    "updatedAt": "2025-09-09T05:41:20.733Z",
    "__v": 0
  },
  "message": "Success"
}

Errors

  • 404 - "User not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

UPDATE USER BY ID API

Method: PATCH

Endpoint: /api/v1/user/edit/:id

Parameters

  • id - unique user ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

body

{
  "contact_number": "091124671235"
}

response

{
  "status": 200,
  "details": {
    "_id": "68bfbe00ec958d03b007fe13",
    "user": "68bfbe00ec958d03b007fe11",
    "fullname": "John Doe",
    "email": "john.doe@gmail.com",
    "contact_number": "091124671235",
    "address": "New Orleans Washington",
    "city": "Chicago",
    "createdAt": "2025-09-09T05:41:20.733Z",
    "updatedAt": "2025-09-28T06:17:14.470Z",
    "__v": 0
  },
  "message": "Success"
}

Errors

  • 404 - "User not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

SERVICE API's

GET ALL SERVICES API

Method: GET

Endpoint: /api/v1/services

Headers

  • Authorization: access_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": [
    {
      "_id": "68ca7274cd30a085301cac7f",
      "service_name": "Service 1",
      "service_price": 150,
      "description": "Lorem Ipsum",
      "duration": "1 hour",
      "createdAt": "2025-09-17T08:33:56.957Z",
      "updatedAt": "2025-09-17T08:33:56.957Z",
      "__v": 0
    },
    {
      "_id": "68ca72d177828cebe1a8ff00",
      "service_name": "Service updated 1",
      "service_price": 250,
      "description": "Lorem Ipsum",
      "duration": "1 hour",
      "createdAt": "2025-09-17T08:35:29.434Z",
      "updatedAt": "2025-09-17T08:35:29.434Z",
      "__v": 0
    }
  ],
  "message": "Success"
}

Errors

  • 404 - "Services not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden"

GET SERVICE BY API

Method: GET

Endpoint: /api/v1/service/:id

Parameters:

  • id - unique service ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

response

{
  "status": 200,
  "details": {
    "_id": "68ca7274cd30a085301cac7f",
    "service_name": "Service 1",
    "service_price": 150,
    "description": "Lorem Ipsum",
    "duration": "1 hour",
    "createdAt": "2025-09-17T08:33:56.957Z",
    "updatedAt": "2025-09-17T08:33:56.957Z",
    "__v": 0
  },
  "message": "Success"
}

Errors

  • 404 - "Services not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 400 - "Invalid Request/Missing service ID".

CREATE SERVICE API

Method: POST

Endpoint: /api/v1/services

Body

{
  "service_name": "Service 3",
  "service_price": 150.0,
  "duration": "1 hour",
  "description": "Lorem Ipsum"
}

Response

{
  "status": 201,
  "details": {
    "service_name": "Service 3",
    "service_price": 150,
    "description": "Lorem Ipsum",
    "duration": "1 hour",
    "_id": "68d9576a1af5b6b59cda765e",
    "createdAt": "2025-09-28T15:42:34.810Z",
    "updatedAt": "2025-09-28T15:42:34.810Z",
    "__v": 0
  },
  "message": "New service created successfully."
}

Errors

  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".

EDIT SERVICE API

Method: PATCH

Endpoint: /api/v1/edit/service/:id

Parameters

  • id - unique service ID.

Body

{
  "service_name": "Updated Service 3",
  "service_price": 150.0,
  "duration": "1 hour",
  "description": "Lorem Ipsum Dolor Es Qui"
}

Response

{
  "status": 200,
  "details": {
    "_id": "68ca72d177828cebe1a8ff00",
    "service_name": "Updated Service 3",
    "service_price": 150,
    "description": "Lorem Ipsum Dolor Es Qui",
    "duration": "1 hour",
    "createdAt": "2025-09-17T08:35:29.434Z",
    "updatedAt": "2025-09-17T08:35:29.434Z",
    "__v": 0
  },
  "message": "Service updated successfully."
}

Errors

  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".
  • 400 - "Invalid Request/Missing service ID".

TIMESLOT API's

GET ALL TIMESLOT API

Method: GET

Endpoint: /api/v1/timeslots

Headers

  • Authorization: access_token
  • Content-type: application/json

Response

{
  "status": 200,
  "details": [
    {
      "_id": "68cbe84860c6e666efcdff2c",
      "start_time": "08:00 A.M",
      "end_time": "09:00 A.M",
      "createdAt": "2025-09-18T11:08:56.646Z",
      "updatedAt": "2025-09-18T11:08:56.646Z",
      "__v": 0
    },
    {
      "_id": "68d10f5fbd04042bdaee1044",
      "start_time": "09:00 A.M",
      "end_time": "10:00 A.M",
      "createdAt": "2025-09-22T08:57:03.959Z",
      "updatedAt": "2025-09-22T08:57:03.959Z",
      "__v": 0
    },
    {
      "_id": "68d10f70bd04042bdaee1049",
      "start_time": "10:00 A.M",
      "end_time": "11:00 A.M",
      "createdAt": "2025-09-22T08:57:20.151Z",
      "updatedAt": "2025-09-22T08:57:20.151Z",
      "__v": 0
    },
    {
      "_id": "68d10f7abd04042bdaee104c",
      "start_time": "11:00 A.M",
      "end_time": "12:00 P.M",
      "createdAt": "2025-09-22T08:57:30.053Z",
      "updatedAt": "2025-09-22T08:57:30.053Z",
      "__v": 0
    }
  ],
  "message": "Success"
}

Errors

  • 404 - "Timeslots not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".

GET TIMESLOT BY ID API

Method: GET

Endpoint: /api/v1/timeslot/:id

Parameter

  • id - unique timeslot ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

Response

{
  "status": 200,
  "details": {
    "_id": "68cbe84860c6e666efcdff2c",
    "start_time": "08:00 A.M",
    "end_time": "09:00 A.M",
    "createdAt": "2025-09-18T11:08:56.646Z",
    "updatedAt": "2025-09-18T11:08:56.646Z",
    "__v": 0
  },
  "message": "Success"
}

Errors

  • 400 - "Invalid Request/Missing timeslot ID".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 404 - "Timeslot not found".

CREATE TIMESLOT API

Method: POST

Endpoint: /api/v1/timeslots

Headers

  • Authorization: access_token
  • Content-type: application/json

Body

{
  "start_time": "01:00 P.M",
  "end_time": "02:00 P.M"
}

Response

{
  "status": 201,
  "details": {
    "start_time": "01:00 P.M",
    "end_time": "02:00 P.M",
    "_id": "68d95ae21af5b6b59cda7668",
    "createdAt": "2025-09-28T15:57:22.592Z",
    "updatedAt": "2025-09-28T15:57:22.592Z",
    "__v": 0
  },
  "message": "Timeslot created successfully."
}

Errors

  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".

UPDATE TIMESLOT BY ID API

Method: PATCH

Endpoint: /api/v1/edit/timeslot/:id

Headers

  • Authorization: access_token
  • Content-type: application/json

Body

{
  "start_time": "01:30 P.M",
  "end_time": "02:30 P.M"
}

Response

{
  "status": 200,
  "details": {
    "_id": "68d95ae21af5b6b59cda7668",
    "start_time": "01:30 P.M",
    "end_time": "02:30 P.M",
    "createdAt": "2025-09-28T15:57:22.592Z",
    "updatedAt": "2025-09-28T16:01:50.409Z",
    "__v": 0
  },
  "message": "Timeslot updated successfully."
}

Errors

  • 400 - "Invalid Request/Missing timeslot ID".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".

Reservation API's

GET ALL RESERVATIONS API

Method: GET

Endpoint: /api/v1/reservations

Headers

  • Authorization: access_token
  • Content-type: application/json

Response

{
  "status": 200,
  "details": [
    {
      "_id": "68d26ccc81d47a0911bf12c4",
      "user": "68c92931b00d0f36a921e688",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d26ccc81d47a0911bf12c5"
        },
        {
          "service": "68ca72d177828cebe1a8ff00",
          "_id": "68d26ccc81d47a0911bf12c6"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "CASH",
      "status": "PENDING",
      "amount": 400,
      "reservation_date": "2025-09-22T00:00:00.000Z",
      "createdAt": "2025-09-23T09:47:56.687Z",
      "updatedAt": "2025-09-23T09:47:56.687Z",
      "__v": 0
    },
    {
      "_id": "68d7cd596d8e403e4825826f",
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d7cd596d8e403e48258270"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "ONLINE_PAYMENT",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-09-27T00:00:00.000Z",
      "createdAt": "2025-09-27T11:41:13.016Z",
      "updatedAt": "2025-09-27T11:41:13.016Z",
      "__v": 0
    },
    {
      "_id": "68d7cd8e9d14e3303f49a2d2",
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d7cd8e9d14e3303f49a2d3"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "ONLINE_PAYMENT",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-09-27T00:00:00.000Z",
      "createdAt": "2025-09-27T11:42:06.473Z",
      "updatedAt": "2025-09-27T11:42:06.473Z",
      "__v": 0
    },
    {
      "_id": "68d7cdc3e387e86e89ac07fd",
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d7cdc3e387e86e89ac07fe"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "ONLINE_PAYMENT",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-09-27T00:00:00.000Z",
      "createdAt": "2025-09-27T11:42:59.297Z",
      "updatedAt": "2025-09-27T11:42:59.297Z",
      "__v": 0
    },
    {
      "_id": "68d7cecfc5ef765dccf9af73",
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d7cecfc5ef765dccf9af74"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "ONLINE_PAYMENT",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-09-27T00:00:00.000Z",
      "createdAt": "2025-09-27T11:47:27.194Z",
      "updatedAt": "2025-09-27T11:47:27.194Z",
      "__v": 0
    }
  ],
  "message": "Reservations retrieved successfully"
}

Errors

  • 404 - "Reservations not found".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".

GET RESERVATION BY ID API

Method: GET

Endpoint: /api/v1/reservation/:id

Parameters

  • id - unique reservation ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

Response

{
  "status": 200,
  "details": {
    "_id": "68d26ccc81d47a0911bf12c4",
    "user": "68c92931b00d0f36a921e688",
    "services": [
      {
        "service": "68ca7274cd30a085301cac7f",
        "_id": "68d26ccc81d47a0911bf12c5"
      },
      {
        "service": "68ca72d177828cebe1a8ff00",
        "_id": "68d26ccc81d47a0911bf12c6"
      }
    ],
    "timeslot": "68cbe84860c6e666efcdff2c",
    "payment_type": "CASH",
    "status": "PENDING",
    "amount": 400,
    "reservation_date": "2025-09-22T00:00:00.000Z",
    "createdAt": "2025-09-23T09:47:56.687Z",
    "updatedAt": "2025-09-23T09:47:56.687Z",
    "__v": 0
  },
  "message": "Reservation retrieved successfully"
}

Errors

  • 400 - "Invalid Request/Missing reservation ID".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".

CREATE RESERVATION API

Method: POST

Endpoint: /api/v1/reservations

Headers

  • Authorization: access_token
  • Content-type: application/json

With payment CASH type.

Body

{
  "user": "68c92931b00d0f36a921e686",
  "services": [
    {
      "service": "68ca7274cd30a085301cac7f"
    }
  ],
  "timeslot": "68cbe84860c6e666efcdff2c",
  "payment_type": "CASH",
  "reservation_date": "2025-10-01"
}

Response

{
  "status": 200,
  "details": {
    "0": {
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d9f2cdda1b463ba47d8c84"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "CASH",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-10-01T00:00:00.000Z",
      "_id": "68d9f2cdda1b463ba47d8c83",
      "createdAt": "2025-09-29T02:45:33.347Z",
      "updatedAt": "2025-09-29T02:45:33.347Z",
      "__v": 0
    },
    "payment": {}
  },
  "message": "Reservations created successfully"
}

With payment ONLINE_PAYMENT type.

Body

{
  "user": "68c92931b00d0f36a921e686",
  "services": [
    {
      "service": "68ca7274cd30a085301cac7f"
    }
  ],
  "timeslot": "68cbe84860c6e666efcdff2c",
  "payment_type": "ONLINE_PAYMENT",
  "reservation_date": "2025-09-30"
}

Response

{
  "status": 200,
  "details": {
    "0": {
      "user": "68c92931b00d0f36a921e686",
      "services": [
        {
          "service": "68ca7274cd30a085301cac7f",
          "_id": "68d9ef81da1b463ba47d8c78"
        }
      ],
      "timeslot": "68cbe84860c6e666efcdff2c",
      "payment_type": "ONLINE_PAYMENT",
      "status": "PENDING",
      "amount": 150,
      "reservation_date": "2025-09-30T00:00:00.000Z",
      "_id": "68d9ef81da1b463ba47d8c77",
      "createdAt": "2025-09-29T02:31:29.341Z",
      "updatedAt": "2025-09-29T02:31:29.341Z",
      "__v": 0
    },
    "payment": {
      "checkoutId": "d90e71ab-93b2-42b3-87e4-23917a61666b",
      "redirectUrl": "https://payments-web-sandbox.maya.ph/v2/checkout?id=d90e71ab-93b2-42b3-87e4-23917a61666b"
    }
  },
  "message": "Reservations created successfully"
}
  • When using the PayMaya Sandbox environment, a payment link will be generated. The customer can use this link to simulate an online payment flow (checkout, entering card details, success/failure, etc.).

PayMaya Sandbox Test Card Payment Credentials

  • Card Number: 5123456789012346
  • Expiry Month & Year: 12/25
  • CSC/CVV: 111

Notes

  • These credentials work only in the PayMaya Sandbox environment — they will not process real payments.
  • Use them to test different checkout flows (successful payments, declines, etc.).
  • For real payments, you’ll need to switch from Sandbox to Production keys in your PayMaya account.

UPDATE RESERVATION STATUS BY ID API

Method: PATCH

Endpoint: /api/v1/reservation/status/:id

Parameters

  • id - unique reservation ID.

Headers

  • Authorization: access_token
  • Content-type: application/json

Body

{
  "status": "PENDING"
}

Response

{
  "status": 200,
  "details": {
    "_id": "68d26ccc81d47a0911bf12c4",
    "user": "68c92931b00d0f36a921e688",
    "services": [
      {
        "service": "68ca7274cd30a085301cac7f",
        "_id": "68d26ccc81d47a0911bf12c5"
      },
      {
        "service": "68ca72d177828cebe1a8ff00",
        "_id": "68d26ccc81d47a0911bf12c6"
      }
    ],
    "timeslot": "68cbe84860c6e666efcdff2c",
    "payment_type": "CASH",
    "status": "PENDING",
    "amount": 400,
    "reservation_date": "2025-09-22T00:00:00.000Z",
    "createdAt": "2025-09-23T09:47:56.687Z",
    "updatedAt": "2025-09-23T09:47:56.687Z",
    "__v": 0
  },
  "message": "Reservation updated successfully."
}

Errors

  • 400 - "Invalid Request/Missing reservation ID".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".

RESCHEDULE RESERVATION API

Method: PATCH

Endpoint: /api/v1/reservation/reschedule/:id

Headers

  • Authorization: access_token
  • Content-type: application/json

Body

{
  "timeslot": "68cbe84860c6e666efcdff2c",
  "reservation_date": "2025-10-02",
  "reason": "Has urgent meeting related to corporate work."
}

Response

{
  "status": 200,
  "details": {
    "_id": "68d26ccc81d47a0911bf12c4",
    "user": "68c92931b00d0f36a921e688",
    "services": [
      {
        "service": "68ca7274cd30a085301cac7f",
        "_id": "68d26ccc81d47a0911bf12c5"
      },
      {
        "service": "68ca72d177828cebe1a8ff00",
        "_id": "68d26ccc81d47a0911bf12c6"
      }
    ],
    "timeslot": "68cbe84860c6e666efcdff2c",
    "payment_type": "CASH",
    "status": "RESCHEDULED",
    "amount": 400,
    "reservation_date": "2025-10-02T00:00:00.000Z",
    "createdAt": "2025-09-23T09:47:56.687Z",
    "updatedAt": "2025-09-23T09:47:56.687Z",
    "__v": 0,
    "reason": "Has urgent meeting related to corporate work."
  },
  "message": "Reservation rescheduled successfully."
}

Errors

  • 400 - "Invalid Request/Missing reservation ID".
  • 401 - "Unauthorized".
  • 403 - "Forbidden".
  • 422 - "Missing required fields/Unknown fields".

About

Created a Reservation API using node js & typescript

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages