About the Wix eCommerce Gift Vouchers API

The Wix eCommerce Gift Vouchers API enables clients to perform various operations related to gift cards, including retrieving gift card data, applying gift card balances to purchases, and voiding previously redeemed transactions.

Use cases

• Check a gift card balance during checkout
• Apply a gift card balance to a purchase
• Void a gift card transaction

Before you begin

• Redeem and Void actions require the appId of the gift card provider, as returned in Get Checkout giftCard.appId or List Transactions for Single Order payments.giftcardPaymentDetails.appId.
• For these APIs to function, a gift card provider must be integrated into the site.
  For apps, this integration can be achieved by any of the following:
  • Marking your app as dependent on Wix Stores, Wix Bookings, or Wix Restaurants, which blocks the installation of your app and prompts users to install the required app first.
  • Making your app dependent on a third-party app that implements the Service Plugin, such as Gifted. There is currently no way to block installation on sites that don't have the third-party app installed, or to check that a site has installed the required app.
  • Building your own app that implements the Wix eCommerce Gift Cards Service Plugin.

Terminology

• Redeem: Applying a gift card balance to a purchase, including subtracting the applied value from the gift card balance.
• Void: Reversing a redeem action and returning the applied value to the gift card balance.