Gift Certificate - 010702

Adapter Stored Value Server - 01070200001

This adapter is used for communication with the Stored Value Server (SVS) for subsequent posting of gift certificate transactions (created offline). The Interface Gift Certificate Server - 01070200002 web service interface is used.

The interface methods for the following use cases are described below:

  • Top up an amount to a gift certificate. Gift cards with variable credit can be topped up as many times as desired. Gift certificates (in paper form) are generally topped up (activated) once.
  • Cancel transactions using a transaction ID

General Rules

  • Parameters are not case-sensitive.
  • NULL values:
    • Values transferred as NULL are handled as NULL values (i.e. reset if applicable)
    • Values that should remain unchanged are not transferred.

Use Cases

  • Create gift certificate
  • Sell gift certificate
  • Top up gift certificate
  • Cancel transactions on the Stored Value Server

The parameters transferred when calling an interface method are transferred to the Interface Gift Certificate Server - 01070200002 Stored Value Server interface as described below. Some parameters are filled from properties in a manner similar to that of the POS Client.

A description is also given of how to handle information that is returned by the Interface Gift Certificate Server - 01070200002 interface.

Interface Gift Certificate Server - 01070200002

This interface is used for subsequent posting of gift certificate transactions if the POS Client cannot reach a Gift Certificate Server.

The gift certificate number, amount, and type are saved in the receipt. The POS Server works as a client and uses this interface to communicate with a Gift Certificate Server via an interface adapter.

The interface methods are called via a POS Server process which searches receipts for offline gift certificate transactions (Gift cert reconciliation agent - 01280200001).

Use Cases

  • Create a new gift certificate
  • Sell a gift certificate
  • Top up a gift certificate
  • Cancel a gift certificate transaction

Condition for usage of the correct adapter

The POS Client transaction provides the relevant Gift Certificate Server in ExternalSystemAdapterName. This value determines the Gift Certificate Server on which subsequent posting is performed. In other words, which adapter is used.

GiftCertificateLineItem.ExternalSystemAdapterName = NULL means that default Stored Value Server - SVS is used.