Skip to content
/
Quick Start Guide
Last updated

Quick Start Guide for Roomex PMS API

Step 1: Get API Access

  1. Sign Up: Contact Corpay to request API credentials and access to the sandbox environment.

  2. Obtain Credentials: You will receive:

    • Client ID

    • Client Secret

Step 2: Authentication

Before using the API, you need to authenticate and obtain a bearer token.

Endpoint: POST /auth/token
Request Headers:
{ "Content-Type": "application/json" }
Request Body:
{   
  "client_id": "your-client-id",
  "client_secret": "your-client-secret" 
}
Response:
{   
  "access_token": "your-access-token",   
  "expires_in": 3600 
}
Usage:

Include the access_token in the Authorisation header for subsequent requests:

{   
  "Authorization": "Bearer your-access-token" 
}

Step 3: Implement Core Workflows

Create a Check-In
Endpoint: POST /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 201 response code with no body.

Create a Check-Out

Endpoint: POST /reservation/checkout
Request Body:
{   
  "reservation_id": "12345",   
  "check_out_date": "2024-12-20"
}
Response:

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

Handle Errors

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://sandbox.roomex.com/api/v1

Run Test Scenarios:

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

Step 5: Move to Production

Certification:

  • Complete integration tests using Roomex’s Integration Test Suite.
  • Submit test results for certification.

Switch to Production:

  • Update your base URL to the production environment: https://developer.corpay-lodging.com/
  • 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.

Example Postman Setup

  1. Download the Roomex PMS API Postman Collection.

  2. Import the collection into Postman.

  3. Configure your environment variables:

    • {{base_url}}: https://developer.corpay-lodging.com/

    • {{access_token}}: Your generated token.

Support

If you encounter any issues:

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

Previous page
Next page