redeemGiftCard( )

Developer Preview

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

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

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.
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?