POST

Void Transaction

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Voids a gift card transaction. Transaction IDs are returned in the Redeem Gift Card call.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Change Gift Card Balances
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/gift-cards/void
Body Params
transactionIdstringRequiredminLength 1maxLength 100

Gift card transaction ID, as returned from Redeem Gift Card.

appIdstringRequiredformat GUID

App ID of the gift card provider.

contextContext

Contextual information for the request, including the physical location ID if applicable.

Response Object
Returns an empty object.
Void Transaction
Request
cURL
curl -X POST \
  'https://www.wixapis.com/ecom/v1/gift-cards/void' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
        "transactionId": "12121212-1212-2121-2121-122112211221",
        "appId": "11169077-1222-3331-ba4f-36ef8c4c1e11"
      }'
Response
JSON
{}
Errors
404Not Found

There is 1 error with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?