The Wix eCommerce Gift Cards Provider Service Plugin allows you to integrate with Wix as a gift card service provider, enabling Wix merchants to utilize your gift card functionalities directly on their sites, providing a seamless experience for their customers.
By integrating your service with Wix, you can facilitate key gift card operations such as balance retrieval, redemption, and voiding transactions. These operations are seamlessly integrated into the site's checkout page, enhancing the overall customer experience.
The integration process involves creating an app in the Wix App Market via the Wix Studio workspace, and configuring the Gift Cards Provider service plugin extension.
It's important to ensure that your implementation of the gift cards provider service plugin endpoints adheres to the provided specifications.
Implementation of this Service Plugin is dependent on configuration of the eCommerce Gift Cards Provider extension in the app dashboard:
| Name | Type | Description |
|---|---|---|
deploymentUri | string | Required. Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the Balance Retrieval endpoint at https://my-gift-cards.com/v1/getBalance, the base URI you provide here is https://my-gift-cards.com/. |
componentName | string | Unique name for this component, that appears only in the app dashboard. |
Configuration setup: When a site owner installs and authorizes your app to provide gift card operations, Wix will send a JSON Web Token (JWT) with an instance ID to your deployment URI + endpoint path. The app should collect the JWT, decode it, and store the resulting instance ID.
For example, the token in this request:
Decodes into: