Activating Loyalty-Integrated Gift Cards

A Loyalty-Integrated Gift Card (LIGC) is a card that holds both Loyalty details and gift card credit for payment, enabling Loyalty members to perform both loyalty and gift-card activities using a single card.

There are a number of ways to activate a Loyalty-Integrated Gift Card (LIGC) in Connect:

• create an order with loyalty memberships and LIGC activation for a new member
• log in with existing loyalty member without card and add a new LIGC for a member
• log in with existing loyalty member with card and replace card with a new LIGC for a member

Creating a new Loyalty member with LIGC activation

The recommended call flow for this scenario is as follows:

• V2.Order.CreateOrder
• V2.Loyalty.GetMembershipPackages
• V2.Loyalty.SetOrderMembershipPackages
• V2.Loyalty.GetLoyaltyIntegratedGiftCardActivationOptions
  • returns LIGC activation options configured in Connect
• V2.Loyalty.SetLoyaltyIntegratedGiftCardActivation
  • Adds an LIGC activation option to the order
  • Pass in the id of any of LIGC activation option from the GET LIGC activation options endpoint
• V2.Orders.CompleteOrder
  • When the order is completed, a new Loyalty member is created, and a new LIGC will be activated for the newly-created member based on the activation option selected

Acquiring LIGC activation options

GET: /loyalty-integrated-gift-cards/{{cinemaId}}/activation-options

Response:

{
    "activationOptions": [
        {
            "cinemaId": "0000000001",
            "id": "700703",
            "priceInCents": 5000,
            "taxInCents": 690,
            "requiresPin": false,
            "description": "LIGC activation",
            "descriptionTranslations": [],
            "extendedDescription": "LIGC activation extended description",
            "extendedDescriptionTranslations": []
        }
    ]
}

Adding an LIGC activation option to an order

POST: /orders/{{userSessionId}}/set-loyalty-integrated-gift-card-activation

Request:

{
	"id": "700703"
}

Response:

{
    "order": {
        "cinemaId": "0000000001",
        "userSessionId": "a53ac319775849499dd04fd23a6c867b",
        "orderTotalValueInCents": 5000,
        "taxValueInCents": 690,
        "loyaltyIntegratedGiftCardActivation": {
            "id": "1",
            "loyaltyIntegratedGiftCardActivationId": "700703",
            "description": "LIGC activation",
            "finalPriceInCents": 5000,
            "originalPriceInCents": 5000,
            "taxInCents": 690,
            "dealDefinitionId": null,
            "dealDescription": null,
            "dealSequence": null
        }
		...
    },
    "suggestedDeals": []
}

Adding or replacing an existing Loyalty member's LIGC

The recommended call flow for this scenario is as follows:

• V2.Order.CreateOrder
• V2.Loyalty.ValidateMember
  • The response will have IsGiftCard=true if the member has an existing gift card
• V2.Loyalty.GetLoyaltyIntegratedGiftCardActivationOptions
• V2.Loyalty.SetLoyaltyIntegratedGiftCardCActivation
• Ticketing.CompleteOrder
  • After the order is completed, the new LIGC is activated, and will be associated with the logged-in Loyalty member
  • If the Loyalty member doesn't have an existing LIGC card, a new card will be created for that member. Otherwise, it will deactivate the old card and create a new one.

Removing LIGC activation option from an order

You can remove an LIGC activation that's been added to an order using the Remove Loyalty Integrated Gift Card Activation endpoint.

DELETE: /orders//remove-loyalty-integrated-gift-card-activation

Response:

{
    "order": {
        "cinemaId": "0000000001",
        "userSessionId": "a53ac319775849499dd04fd23a6c867b",
        "orderTotalValueInCents": 5000,
        "taxValueInCents": 690,
        "loyaltyIntegratedGiftCardActivation": null
		...
    },
    "suggestedDeals": []
}