Gift cards

Overview

Gift cards function both as purchasable products and as a payment method. Omnium manages gift cards as the master system, while Sitoo interacts with them through SPI (Service Provider Interface) endpoints.

For more information on Sitoo’s side, see their Sitoo GiftCard SPI Documentation.

The integration supports Sitoo’s “Pre-printed Cards” configuration, meaning that Sitoo does not create or store gift card data; instead, it triggers transactions on gift cards managed by Omnium.

How it works

1. Creating Gift Cards:
   Before you can sell a gift card in Sitoo, it must already exist in Omnium. This means Omnium manages the gift card codes and tracks their balances. You also need to have a gift card product set up in Sitoo.

2. Selling Gift Cards in Sitoo:
   When a customer purchases a gift card in-store using the Sitoo system, you can enter the desired amount and scan or enter the pre-printed gift card code. The gift card appears as a product in the order, but Sitoo does not create or store the actual gift card details.

3. Gift cards are updated in Omnium through SPI endpoint AddTransaction:
   After a gift card is sold, Sitoo uses the SPI endpoint to add a transaction to the corresponding gift card in Omnium.

4. Paying with Gift Cards in Sitoo:
   When a customer chooses to pay with a gift card, Sitoo checks with Omnium to confirm that there is sufficient balance. If there is, Sitoo triggers Omnium to create a negative transaction on the gift card to deduct the used amount.

5. Refunds and Balance Checks:
   If a payment made with a gift card is refunded, Omnium adds the refunded amount back to the card. Additionally, whenever Sitoo needs to check the remaining balance on a gift card, it queries Omnium for the current amount.

Visualization of the operations:

Configuration

In Omnium

Set this property on the Sitoo connector (per market):

{
  "key": "GiftCardApiKey",
  "value": "{apiKey}"
}

Set giftCardSku under orderSettings in json:

  "giftCardSku": "{skuId}"

Or in gui:

Create a gift card product.

In Sitoo Backoffice

1. Go to: Settings → Custom Gift Card
2. Set the following:

   • URL:

     Environment	Destination URL
     Test	https://apitest.omnium.no/api/sitooGiftCard/{tenantId}/{marketId}/
     Prod	https://api.omnium.no/api/sitooGiftCard/{tenantId}/{marketId}/

   • API Token:
     {apiKey} (same as configured in Omnium)

3. Go to Settings -> General -> GiftCards:
   • Set Gift Card Service to Custom Gift Card.
   • Set Gift Card Type to Pre-printed Cards

4. Create a gift card product in Sitoo with skuId equal giftCardSku from settings in Omnium. The productType has to be GiftCard.