This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
This method requests that a transaction be created by your app. Wix calls this method when a customer completes a purchase that includes a gift card as a payment method at checkout.
Gift card code.
App ID of the Gift Card provider. Deprecated.
Amount to redeem from the gift card.
Order ID the gift card transaction is applied to. Order details can be collected from eCommerce Search Orders.
Currency code.
Physical location ID. Can be based on the Locations API or an external provider.
Remaining balance on the Gift Card after the redemption.
Currency code.
Transaction ID.
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/redeem' \
-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",
"amount": 20.00,
"currencyCode": "USD",
"orderId": "00000000-0000-0000-0000-000000000001"
}'
{
"remainingBalance": 80.00,
"currencyCode": "USD",
"transactionId: "00000000-0000-0000-0000-000000000001"
}