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 both Sitoo’s main options for gift cards; “Pre-printed Cards” and "Vouchers".

How it works

1. Creating Gift Cards:
   This step differs depending on the type of gift card setting in Sitoo.

   Pre-printed cardsVoucher

   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 of gift card payments:

   Pre-printed cardsVoucher

   If a payment made with a gift card is refunded, Omnium adds the refunded amount back to the card.

6. Balance Checks: Whenever Sitoo needs to check the remaining balance on a gift card, it queries Omnium for the current amount.

7. Visualization of the operations:

Configuration

In Omnium

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

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

2. Set giftCardSku under orderSettings in json:

  "giftCardSku": "{skuId}"

Or in gui:

3. Create a gift card product.

4. To use this gift card integration with Sitoo, you also need to enable the Omnium gift card provider. Ask Omnium to do this.

In Sitoo Backoffice

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

   • URL:

     Environment	Destination URL
     Dev	https://apidev.omnium.no/api/sitooGiftCard/{tenantId}/{marketId}/
     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 or Vouchers.

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

Currently not supported

1. Use of pin codes on gift cards
2. Return of gift cards

Retur av ordre betalt med gavekort -> tilbakebetal til gavekort -> blir laget et nytt kort??