Lounge/Dining Walk-in Redemption Event

Description

Event Name: walkin.redemption

Payload Focus:

Redemption order details

Redemption time

Actual usage information

Supported Modules

Lounge Walk-in

Set Meal

Dining Coupon

Message Example

{
    "eventType":"walkin.redemption",
    "orderId": "DP00000000000001",
    "programId": "1888000000000001",
    "dpId": "8888000066668888",
    "module": 1,
    "status": 2,
    "orderCreatedDate": "2024-12-31T00:00:00+00:00",
    "usageDate": "2024-12-31T00:00:00+00:00",
    "orderCancelledDate": null, // Only return in the order cancellation notification.
    "transportHubId": "A10045",
    "transportHubName": "Gatwick Airport",
    "resourceId": "N00129",
    "resourceName": "No1 Lounge Gatwick North",
    "passengers": {
        "cardholder": 1,
        "guests": 1
    }
}

Field Descriptions

Please note: in the V2 callback, the status enum values have been updated to 2 = Order Created and 3 = Order Cancelled, to align with the order status enumeration used in the API response.

If you are upgrading from the V1 callback to the V2 callback, please make sure to review and update your enum value configuration accordingly.

Column	Description	Example
eventType	Specifies the type of push event. Used to distinguish between different kinds of notifications, e.g., `walkin.redemption`, `prebooking.statusChanged`.	walkin.redemption
orderId	Unique identifier of the usage order, generated by DragonPass each time a user utilizes their Membership or E-pass.	DP00000000000001
programId	Unique identifier of the program. Assigned by DragonPass when a new program was onboarded.	1888000000000001
dpId	Unique ID for the DragonPass Membership or E-pass.	8888000066668888
module	Specifies the module associated with the order(s), e.g. "Lounge", "Fast Track".	1
category	Specifies the category of orders, e.g. "Walk-in", "Prebooking". `1 - Walk-in` `2 - Prebooking`	1
status	Order status. `2 - Order Created` `3 - Order Cancelled`	2
orderCreatedDate	Specifies the date and time when an order was created (in UTC+0).	2024-12-31T00:00:00+00:00
usageDate	Specifies the date and time when an order was redeemed (in local time).	2024-12-31T00:00:00+00:00
orderCancelledDate	Specifies the date and time when an order was cancelled (if applicable, in UTC+0). This field will only be returned in the order cancellation notification message.	2024-12-31T00:00:00+00:00
transportHubId	Unique ID for the transport hub.	A10045
transportHubName	Name of the transport hub.	Gatwick Airport
resourceId	Unique ID for the DragonPass resource.	N00129
resourceName	Name of the DragonPass resource.	No1 Gatwick North
cardholder	Specifies the number of cardholder.	1
guests	Specifies the number of guests.	1

Event Logic

Walk-in Order Creation

When a user redeems their visits, our system automatically sends the order notification to the client’s system.

Walk-in Order Cancellation

If a user requests to cancel the order after redemption due to some reason, our system will send another order cancellation notification to the client’s system. This notification uses the same order number to ensure that the client can easily connect the two events.

📌

In some instances, due to network delays or other unforeseen issues, order creation notifications might not be delivered before order cancellation notifications. Our system ensures the integrity and traceability of events through unique order IDs.

If an order cancellation notification is received without a prior creation notification, the client should treat the order as cancelled. The system should record the cancellation and ignore any subsequent creation notification for the same order ID.

Response

A push is considered successfully received only if the client returns HTTP status code 200 OK along with following JSON response:

{
  "status": "success"
}

Description#

Supported Modules#

Message Example#

Field Descriptions#

Event Logic#