Extension Config


To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.

Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
deploymentUristring

Base URI where the endpoints are called. Wix eCommerce appends the endpoint path to the base URI. For example, to call the Get Balance endpoint at https://my-gift-cards.com/v1/balance, the base URI you provide here is https://my-gift-cards.com/.


Was this helpful?
Yes
No

getBalance( )


Important: This is a handler function. Implement it only as part of the service plugin.


This method retrieves gift card data from your app. Wix calls this method when a customer applies a gift card as a payment method at checkout.

Method Declaration
Copy
Method Parameters
payloadGetBalanceEnvelope
Returns
Return Type:GetBalanceResponse | Promise<GetBalanceResponse>
Errors
GiftCardDisabledWixErrorclass
GiftCardExpiredWixErrorclass
GiftCardNotFoundWixErrorclass
Was this helpful?
Yes
No