post/gift-cards

Request body

amountnumber required
descriptionstring required
messagestring required

Response

createGiftCard 200 response

GiftCard required

A gift card can be redeemed online for credits or at a retail store as a form of payment.

It can be in one of the following states:

  1. pending: This occurs before a gift card's payment has been captured and before it has been synchronized to the ERP system. We separate this step from the gift card creation so that we don't charge a customer's credit card, then fail to record this detail in the database.

  2. active: This gift card is ready to be applied (or "claimed"), and has been synchronized to the ERP system.

  3. applied: This gift card has been applied to a user account and recorded in their AccountBalance.

  4. voided: The gift card has been voided and is no longer usable.

The ERP system is the source of truth for gift cards, so any operations affecting a gift cards status or balance should first confirm the operation with the ERP.

Changes

No recorded changes to this endpoint across all 1 revision of this API.