Quick Start Guide for Roomex PMS API

Step 1: Get API Access

Sign Up: Contact Corpay to request and obtain credentials for sandbox, test, and production environments.
Obtain Credentials: You will receive:
- Client ID
- Client Secret
This will be used for Authentication.

Step 2: Authentication

Follow the steps in Authentication Guide to obtain your access_token.

Usage:

Include the access_token in the Authorization header for subsequent requests:

Authorization: Bearer your-access-token

Step 3: Implement Core Workflows

Create a Check-In

Endpoint: POST /api/v1/reservation/checkin:

Request Body:

{
    "hotelConfirmationNumber": "13212",
    "clcHotelId": "776655",
    "employeeIdentifier": "999999",
    "supplierReservationId": "19457856A3",
    "source": "HOS",
    "checkInDateTime": "2026-10-17T14:30:00-05:00",
    "expectedCheckOutDateTime": "2026-10-19T14:30:00-05:00",
    "roomNumber": "201",
    "folio": "201",
    "guestFirstName": "Adam",
    "guestLastName": "Addams",
    "roomType": "Single",
    "occupancy": 1,
    "loyalty": true,
    "numberOfNights": 2,
    "reservationInformation": "Reservation details"
  }

Response:

Successful response will return a 200 response code with a token in the body:

{
  "token": "someToken123"
}

Create a Check-Out

Endpoint: POST /api/v1/reservation/checkout

Request Body:

{   
  "token": "12345"
}

Response:

Successful response will return a 200 response code with no body.

Step 4: Testing Your Integration

Use the Sandbox Environment: All API endpoints are available in a sandbox environment for testing without impacting live data.

Base URL: https://l89hmcdo52.execute-api.eu-south-2.amazonaws.com/default

Run Test Scenarios:

Simulate valid and invalid requests.
Validate error handling and success responses.

Step 5: Move to Production

Switch to Production:

Update your base URL to the production environment (provided during production setup).
Use live API credentials.

Helpful Tips

Monitor Usage: Set up logs to monitor API usage and ensure you meet rate limits.
Error Handling: Always handle errors gracefully and retry failed requests where appropriate.
Keep Tokens Secure: Store tokens securely and refresh them before expiration.

Support

If you encounter any issues:

Visit the API Documentation section in the same page below.
Reach out to Roomex support at support@roomex.com.

By following this guide, you’ll have your PMS integrated with the PMS API in no time. Happy coding!