POST

Redeem Gift Card

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.
Endpoint
POST
https://www.wixapis.com/ecom/v1/gift-cards/redeem
Body Params
codestringRequiredminLength 8maxLength 20

Gift card code.

amountAmountRequired

Amount to redeem from the gift card.

orderIdstringformat GUID

Order ID to apply the gift card transaction, when applying a gift card after order creation. Order ID can be collected from the Order Created webhook or by calling Search Orders.

appIdstringRequiredformat GUID

App ID of the gift card provider.

contextContext

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

Response Object
transactionIdstringminLength 1maxLength 100

Gift card transaction ID.

Redeem Gift Card
Request
cURL
Response
JSON
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?