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 as payment for an order by applying the gift card balance to the order total.

Creates a gift card payment transaction and deducts the specified amount from the gift card balance. The redeemed amount reduces the order's outstanding balance.

Note The following prerequisites apply:

  • Gift card must be active and not expired.
  • Gift card must have sufficient balance.
  • Order must not be cancelled or fully paid.
  • Gift card currency must match order currency.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Orders
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/order-billing/redeem-gift-card
Errors
400Invalid Argument

There is 1 error with this status code.

404Not Found

There are 2 errors with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There are 7 errors with this status code.

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

Did this help?