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 gift card transaction be voided by your app. Wix calls this method when a purchase fails after gift card redemption.
App ID of the Gift Card provider. Deprecated.
Transaction ID to void.
Physical location ID. Can be based on the Locations API or an external provider.
Remaining balance on the Gift Card after voiding the transaction.
Currency code.
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/void' \
-H 'user-agent: Wix' \
-H 'accept-encoding: gzip, deflate' \
-H 'content-type: text/plain; charset=utf-8' \
-d '{
"transactionId": "00000000-0000-0000-0000-000000000001"
}'
{
"remainingBalance": 100.0,
"currencyCode": "USD"
}