Gift Cards

The Global-e cartridges support purchasing gift cards as regular products and redeeming gift cards on the Global-e checkout. This page covers the custom (non-native) gift card flow; for SFCC native gift certificates, see Native Gift Certificates.

The cartridges include the framework plus a demo implementation based on SFCC custom objects of type DEMO_GLOBALE_GIFT_CARDS. The demo is a working example only — replace it with your own provider before production. Do not import demo custom-object data from metadata/demo/ into production.

This is an optional feature. It requires both Business Manager configuration and project code. See Required customization.

Selling a gift card as a product

A gift card is sold like any other product. In Business Manager, create the product and enable the product custom attribute Is Globale Gift Card (geIsGiftCard) under the product attributes. The product can be a standalone SKU or a master with variants for different amounts.

The shopper adds it to the basket and purchases it like any other product.

Redeeming a gift card on checkout

On the Global-e checkout, the shopper enters the card details and applies the card. The number of input fields (Card ID only, Card ID + PIN, and so on) is configured on the Global-e side per project.

The redemption uses three Global-e requests handled on the SFCC side:

Request	When it is sent	What SFCC does
Validate	When the shopper applies the card	Parses the payload and checks the card with SFCC custom objects or an external provider (for example Givex). Returns a valid/invalid response; invalid cards show an error. A valid card’s balance is converted to the checkout currency and the totals refresh.
Redeem	After the shopper clicks Pay and Place Order and Global-e creates the order on its side (before the SFCC order is created)	Performs the redeem operation for the card. If redeem fails, the shopper sees an error and no SFCC order is created. If it succeeds, the confirmation page is shown and the SFCC order is created.
Refund	When a refund case is created on the Global-e side (for example, the order is cancelled)	Reverses the redemption for the card.

After a card is applied, checkout totals show how much of the order is covered by the gift card.

• If the card covers the full order total, the shopper can place the order without any additional payment.
• If the card covers only part of the total, the shopper selects a payment method for the remainder.

Details of the cards used are added to the SendOrderToMerchant and PaymentNotification payloads.

Required customization

Purchase (create the gift card after payment)

To create gift cards when a card product is purchased through the Global-e checkout, implement the globale.onAfterPaymentUpdate hook in your project cartridge (or in int_globale_sfra / int_globale_sitegenesis, depending on your architecture).

./hooks.json

{
    "hooks": [
        {
            "name": "globale.onAfterPaymentUpdate",
            "script": "./cartridge/scripts/globale/hooks/onAfterPaymentUpdate.js"
        }
    ]
}

./cartridge/scripts/globale/hooks/onAfterPaymentUpdate.js

'use strict';

exports.onAfterPaymentUpdate = function (order, payload) {
    var globaleHelpers = require('*/cartridge/scripts/helpers/globaleHelpers');
    var logger = globaleHelpers.getLogger();
    try {
        var GiftCardStrategy = require('*/cartridge/models/globale/alternativePayments/GiftCardStrategy');
        var giftCard = new GiftCardStrategy(payload);
        giftCard.create(order);
    } catch (e) {
        logger.error('PAYMENTS_GIFT_CARD_CREATE: {0}', logger.message(e));
    }
};

Redemption (provide a real card provider)

The demo implementation uses SFCC custom objects of type DEMO_GLOBALE_GIFT_CARDS. Override it with a provider that integrates your gift card system:

int_globale/cartridge/scripts/globale/alternativePayments/providers/GiftCardProvider.js

The strategy that drives validate/redeem/refund/create lives at int_globale/cartridge/models/globale/alternativePayments/GiftCardStrategy.js.

Summary

The demo (based on SFCC custom objects) is a minimal reference that shows the core moving parts of the gift card feature. Production projects supply their own provider and, where required, an onAfterPaymentUpdate handler. Never deploy the demo DEMO_GLOBALE_GIFT_CARDS provider or demo object data to production.

See also

• Native Gift Certificates · Loyalty Points Cards
• globale.onAfterPaymentUpdate hook
• Metadata reference — geIsGiftCard, DEMO_GLOBALE_GIFT_CARDS