DragonPass API Developer Platform
v2
  • v2
  • v1
HomepageOfficial SiteContact Us
HomepageOfficial SiteContact Us
API Version
v2
  • v2
  • v1
  1. Migration Guide
  • Implementation Guide
    • DragonPass Modules
    • Get Started
    • Our API Solution
  • Development Guide
    • Response Format
    • Error Codes
    • Multiple Language Support and Fallback
    • UI Design Guidelines
    • Authentication
    • Sandbox Order Simulation
  • DragonPass API Push Event
    • Instructions
    • Lounge/Dining Walk-in Redemption Event
    • Prebooking Order Status Change Event
    • Resource Update Push Service
  • Using the API
    • Search for Resources
      • Search for Resources
      • Check Prebooking Resource & Option Availability
      • Pricing Query
      • Image Parameters
    • Order Lifecycle
      • Walk-in & Prebooking Order
      • Order Status Enumeration
    • E-pass
      • Querying E-pass Usage Orders and Details
      • Issuing, Querying, and Cancelling an E-pass
      • Utilizing The E-pass
        • Lounge
        • Fast Track
        • Dining
        • Fitness
        • eSIM
        • Cross Module
    • Membership
      • Manage Memberships & Entitlements
      • Querying Membership Usage Orders and Details
      • Utilizing DragonPass Membership
        • Lounge
        • Fast Track
        • Dining
        • Fitness
        • eSIM
    • User
      • User Management
  • Release Notes
    • 2026
    • 2025
  • Migration Guide
    • From V1 to V2
  • API Reference
    • Authentication
      • Generate Access Token
    • User Management
      • User Creation
      • Update User Information
      • Retrieve User Information
      • Retrieve User E-passes List
      • Retrieve User Memberships List
      • Delete A User
    • Search
      • Retrieve Available Modules by Location
      • Aggregated Search by Keyword
    • Transport Hubs
      • Retrieve Transport Hub
      • Retrieve Transport Hub Details
    • Resources
      • Retrieve Resource List
        • Retrieve Resources List
      • Search For Resources
        • Retrieve Resource Details
        • List Updated Resources
      • Check Resource Availability
        • Check Prebooking Resource Availability
        • Check Prebooking Option Availability
      • Fitness
        • Retrieve Fitness Resources Schedule
        • Retrieve Fitness Resource Option Details
      • eSIM
        • Retrieve eSIM Resouces Options
        • Retrieve eSIM Resource Option Details
      • Pricing
        • Retrieve Resource Pricing Information
        • Retrieve Prebooking Option Pricing Information
    • Entitlement Management
      • Update Membership Entitlements
      • Retrieve Membership Entitlement Information
    • Membership Management
      • Membership Registration
      • Update A Membership
      • Retrieve Membership Information
      • Generate Membership Dynamic QR Codes
      • Change Membership Program(Upgrade/Downgrade)
    • Orders Management
      • Preview Orders
        • Membership
          • Preview Membership Prebooking Order
      • Create Orders
        • E-pass
          • Issue An E-pass
            • Create E-pass Order
          • Lounge Prebooking
            • Create E-pass Prebooking Order - Lounge
            • Create E-pass with Prebooking Order - Lounge
          • Fast Track
            • Create E-pass Prebooking Order - Fast Track
            • Create E-pass with Prebooking Order - Fast Track
          • Fitness
            • Create E-pass Prebooking Order - Fitness
            • Create E-pass with Prebooking Order - Fitness
          • eSIM
            • Create E-pass Prebooking Order - eSIM
            • Create E-pass with Prebooking Order - eSIM
            • Top up eSIM data package - E-pass
        • Membership
          • Create Membership Prebooking Order - Lounge
          • Create Membership Prebooking Order - Fast Track
          • Create Membership Prebooking Order - Fitness
          • Create Membership Prebooking Order - eSIM
          • Top up eSIM data package - Membership
      • Retrieve Order List
        • Retrieve E-pass Order List
        • Retrieve Membership Order List
      • Cancel Orders
        • Cancel an Order
      • Retrieve Order Details
        • E-pass
          • Retrieve E-pass Details
          • Retrieve E-pass Usage Order Details
        • Membership
          • Retrieve Membership Usage Order Details
      • Module Specific APIs
        • Fitness
          • Fitness Order Check-In
        • eSIM
          • Retrieve eSIM Order Live Extended Details
          • Check eSIM Top-up Availability
          • Retrieve eSIM Data Packages
    • [Sandbox Only] Simulation
      • Lounge
        • Simulate Lounge Redemption - Walk in
        • Simulate Lounge Redemption - Prebooking
        • Simulate Lounge Order Cancellation
      • Fast Track
        • Simulate Fast Track Redemption - Prebooking
        • Simulate Fast Track Order Cancellation
    • Push Event Recovery
      • Push Event Recovery
  • Our Team
  1. Migration Guide

From V1 to V2

This document outlines the key changes introduced in API version V2 compared to version V1. The upgrade aims to improve consistency, scalability, and usability across all endpoints.

Endpoint Path Changes#

All API endpoints in V2 have been moved under a new versioned base path to ensure clear versioning and easier maintenance.
Old Base Path (V1): /api/v1/...
New Base Path (V2): /api/v2/...
This change affects all API categories. Make sure to update your integration accordingly by replacing all v1 paths with v2.
Example:
GET /api/v1/resources → GET /api/v2/resources

Endpoints Change Summary#

EndpointPathStatusNotes
Membership Registration/v2/membershipsUpdatedNow supports specifying the activation date
Update A Membership/v2/memberships/updateUpdatedNow supports updating the activation date and various membership statuses
Retrieve Membership Information/v2/memberships/searchUpdatedThe structure of the request and/or response payload has been modified to support new features
Update Membership Entitlements/v2/entitlements/updateUpdatedNow supports entitlements for the Fitness and eSIM modules
Retrieve Membership Entitlement Information/v2/entitlements/searchUpdatedNow supports entitlements for the Fitness and eSIM modules
Retrieve Resources List/v2/resourcesUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve Resource Details/v2/resources/{resourceId}UpdatedThe structure of the request and/or response payload has been modified to support new features
Check Prebooking Resource Availability/v2/resources/prebookings/availabilityUpdatedThe structure of the request and/or response payload has been modified to support new features
Check Prebooking Option Availability/v2/resources/options/prebookings/availabilityUpdatedThe structure of the request and/or response payload has been modified to support new features
Create E-pass Order/v2/orders/{module}/ePassesUpdatedNow supports specifying the activation date
Create E-pass Prebooking Order/v2/orders/{module}/ePasses/prebookingUpdatedThe structure of the request and/or response payload has been modified to support new features
Create E-pass with Prebooking Order/v2/orders/{module}/ePasses/bundleUpdatedThe structure of the request and/or response payload has been modified to support new features
Create Membership Prebooking Order - Lounge/v2/orders/lounges/memberships/prebookingUpdatedThe structure of the request and/or response payload has been modified to support new features
Create Membership Prebooking Order - Fast Track/v2/orders/fastTrack/memberships/prebookingUpdatedThe structure of the request and/or response payload has been modified to support new features
Create Membership Prebooking Order - Fitness/v2/orders/fitness/memberships/prebookingUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve E-pass Order List/v2/orders/ePassesUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve Membership Order List/v2/orders/membershipsUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve E-pass Details/v2/orders/ePasses/searchUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve E-pass Usage Order Details/v2/orders/ePasses/detailsUpdatedThe structure of the request and/or response payload has been modified to support new features
Retrieve Membership Usage Order Details/v2/orders/memberships/detailsUpdatedThe structure of the request and/or response payload has been modified to support new features
Generate Access Token/v2/auth/tokenUnchangedNo changes, only base path updated to /v2/
Generate Membership Dynamic QR Codes/v2/memberships/qrCodesUnchangedNo changes, only base path updated to /v2/
Retrieve Transport Hub/v2/transportHubsUnchangedNo changes, only base path updated to /v2/
Retrieve Transport Hub Details/v2/transportHubs/{transportHubId}UnchangedNo changes, only base path updated to /v2/
List Updated Resources/v2/resources/updatesUnchangedNo changes, only base path updated to /v2/
Cancel an Order/v2/ordersUnchangedNo changes, only base path updated to /v2/
Retrieve Fitness Resource Option Details/v2/resources/fitness/{resourceId}/options/{optionId}NewNew API module introduced in V2
Retrieve Fitness Resouces Schedule/v2/resources/fitness/{resourceId}/scheduleNewNew API module introduced in V2
Retrieve eSIM Resource Option Details/v2/resources/esims/{resourceId}/options/{optionId}NewNew API module introduced in V2
Retrieve eSIM Resouces Options/v2/resources/esims/{resourceId}/optionsNewNew API module introduced in V2
Top up eSIM data package - E-pass/v2/orders/esims/ePasses/topupNewNew API module introduced in V2
Create Membership Prebooking Order - eSIM/v2/orders/esims/memberships/prebookingNewNew API module introduced in V2
Top up eSIM data package - Membership/v2/orders/esims/memberships/topupNewNew API module introduced in V2
Fitness Order Check-In/v2/orders/fitness/checkinNewNew API module introduced in V2
Retrieve eSIM Order Extended Details/v2/orders/esims/detailsNewNew API module introduced in V2
Check eSIM Top-up Availability/v2/orders/esims/topup/availabilityNewNew API module introduced in V2
Retrieve eSIM Data Packages/v2/orders/esims/packages/queryNewNew API module introduced in V2

Key Changes and New Features in V2#

New API modules launch: Fitness & eSIM API
Authentication Method Update: the HS256 algorithm has been deprecated, we now use the RS256 algorithm for JWT token signing,
Activation Date Control: activation date can now be specified when issuing or registering an E-pass or Membership
Dynamic language fallback:the API now supports a dynamic language fallback mechanism
Simplified request/response structures
Improved error messaging with standardized error codes

New API modules launch#

We are excited to announce the release of the Fitness & eSIM module. Clients can now place fitness and eSIM orders via both E-pass and Membership solutions.
For more information, please check the E-pass or Membership sections.

Authentication Method Update#

The authentication method has been updated to enhance security and align with industry best practices.
The HS256 algorithm has been deprecated. We now use the RS256 algorithm for JWT token signing, which leverages asymmetric encryption (private/public key pair).
For more information, please check the Authentication page.

Activation Date Control#

In V2, the API now supports explicitly specifying the activation date when issuing an E-pass or registering a Membership. This provides more control and flexibility in lifecycle management, especially for scenarios involving scheduled activations or delayed benefits.
New Request Field#
"activationDate": "2028-10-31T23:59:59+00:00"
Optional field
If omitted, the system defaults to activating the membership or E-pass immediately upon issuance
New Parameters and Enumerations#
New Parameters: ePassStatus - New Field for E-pass State Tracking
New Enumerations: New Pending Activation State for membership.status
Status Enumeration
CodeStatusDescription
0Pending ActivationE-pass/Membership has been issued/registered but is not yet active (e.g., future activationDate).
1ActiveE-pass/Membership is active and can be used.
2SuspendedE-pass/Membership temporarily disabled.
3CancelledE-pass/Membership has been manually cancelled.
9ExpiredE-pass/Membership is no longer valid due to expiration date.
Endpoints Affected#
/v2/orders/{module}/ePasses
/v2/orders/{module}/ePasses/bundle
/v2/orders/ePasses/search
/v2/memberships
/v2/memberships/update
/v2/memberships/search
Use Cases#
Allow clients to schedule and update activation to align with their campaign launches
Enable time-based entitlements or usage controls

Dynamic language fallback#

V2 introduces a new query parameter fallbackAllowed to enhance multi-language support. When enabled, this parameter allows the API to gracefully fall back to a default language (en-US) if the requested language is not fully available for a given resource.
New Query Parameter#
ParameterTypeRequiredDescription
fallbackAllowedbooleanOptionalWhen set to true, content not available in the requested language will default to en-US. Default behavior is false.
Endpoints Affected#
/v2/transportHubs/{transportHubId}
/v2/resources/{resourceId}
/v2/resources/fitness/{resourceId}/options/{optionId}
/v2/resources/esims/{resourceId}/options/{optionId}
As of this release, fallback support is only available for "detail" endpoints.
List endpoints (e.g., /v2/resources) do not support fallback at the moment and will return only what is available in the requested language.
Behavior#
If fallbackAllowed is enabled=true, the response will default to en-US when the requested language is unavailable.
If fallbackAllowed is disabled=false, the API will return an error message indicating that the translation for the requested language is missing.
Use Cases#
Ensures users receive complete information even if some translations are missing.
Enhances user experience in multilingual UIs, reducing the risk of incomplete or broken displays.
Modified at 2025-08-25 06:49:27
Previous
2025
Next
Generate Access Token