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. Associate a gift card to a market if you want to restrict its availability to that specific market.
A gift card object is returned as part of the response body of each successful list, retrieve, create or update API call.
The gift card unique identifier
The gift card endpoint URL
The gift card status, one of 'draft', 'inactive', 'active', or 'redeemed'.
The gift card code UUID. If not set, it's automatically generated.
The international 3-letter currency code as defined by the ISO 4217 standard.
The gift card initial balance, in cents.
The gift card initial balance, float.
The gift card initial balance, formatted.
The gift card balance, in cents.
The gift card balance, float.
The gift card balance, formatted.
The gift card balance max, in cents.
The gift card balance max, float.
The gift card balance max, formatted.
The gift card balance log. Tracks all the gift card transactions.
Indicates if the gift card can be used only one.
Indicates if the gift card can be recharged.
The URL of an image that represents the gift card.
Time at which the gift card will expire.
Any identifier of the third party system that defines the reference code
The email address of the associated recipient. When creating or updating a gift card, this is a shortcut to find or create the associated recipient by email.
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.
Send this attribute if you want to activate a gift card.
Send this attribute if you want to deactivate a gift card.
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The associated market (optional).
The associated gift card recipient (optional).
The associated attachments.
The resource environment (can be one of