Gift cards
The gift card object and the allowed CRUD operations on the related resource endpoint
Last updated
API reference
The gift card object and the allowed CRUD operations on the related resource endpoint
Last updated
A gift card is a special type of payment instrument that can be either purchased or used to pay for an order — in total or in part — depending on its outstanding balance. All gift cards must be activated before being used. Rechargeable gift cards can be reloaded at any time. Single-use gift cards become redeemed after the first usage, whatever the balance is used.
You can associate a gift card to a market if you want to restrict its availability to that specific market. Check the balance_log attribute to browse the history of a gift card's balance changes and the usage_log attribute for more information about how, when, and by which order the gift card has been used.
Unless you set the distribute_discount attribute to false (default is true) at the single gift card level, the total discount due to gift cards used to pay for an order is calculated and distributed on all the of the order, based on the ratio between the line item amount and the sum of the amounts of all the line items to which the promotion is applied.
If you set the distribute_discount attribute to false and the price list associated with the market where you're placing the order does not include taxes (i.e. the price list tax_included attribute is set to false), the discount will be applied to the whole order amount plus taxes. This means that if the gift card balance is greater enough, it will saturate both the order amount and taxes amount. In any other case, only the order amount (taxes excluded) will be considered when applying the gift card discount.