voidTransaction( )

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 Redeem Gift Card.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Change Gift Card Balances
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function voidTransaction(
  transactionId: string,
  options: VoidTransactionOptions,
): Promise<void>;
Method Parameters
transactionIdstringRequired

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

optionsVoidTransactionOptions

Field options. appId must be passed.

JavaScript
import { giftVouchers } from "@wix/ecom";

async function voidTransaction(transactionId, options) {
  const response = await giftVouchers.voidTransaction(transactionId, options);
}
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?