redeemGiftCard( )

Redeems a gift card. Creates a transaction and lowers the card balance by the transaction amount.

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
Change Gift Card Balances
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
codestringRequired

Gift card code.

optionsRedeemGiftCardOptions

Field options. amount and appId must be passed.

Returns
Return Type:Promise<RedeemGiftCardResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 3 errors with this status code.

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

Did this help?