This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
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.
Gift card code.
App ID of the Gift Card provider. Deprecated.
The physical location ID. Can be based on the Locations API or an external provider.
Current balance.
Currency code.
External ID in the gift card provider's system. Used for integration and tracking across different platforms.
The data payload will include the following object as an encoded JWT. For the purposes of this example, we show the request and response objects decoded.
curl -X POST \
'http://provider.example.com/v1/balance' \
-H 'user-agent: Wix' \
-H 'accept-encoding: gzip, deflate' \
-H 'content-type: text/plain; charset=utf-8' \
-d '{
"code": "GIFT-CARD-CODE-123",
"appInstanceId": "044667f4-c13f-46c2-8506-de9e42293896",
}'
{
"balance": 100.0,
"currencyCode": "USD"
}