Gift Card Object


A gift card represents a prepaid payment method that customers can use to make purchases. Gift cards store monetary value that can be redeemed during checkout and support email delivery to recipients with personalized messaging. All balance changes are automatically tracked for audit and reporting purposes.

Properties
balanceAmountRead-only

Current available balance that can be spent.

Decreases when the gift card is used for purchases and increases with refunds.


codestringimmutableminLength 8maxLength 20

Gift card code used for redemption.

Notes:

  • The gift card code can be custom-provided or automatically generated by omitting the field.
  • When returned by Create Gift Card, the code field contains the full gift card code, for example, 1111-2222-3333-4444.
  • In any other method response, as well as in the Gift Card Created domain event, the code field contains the obfuscated gift card code, for example, ****-****-****-4444.

codeSuffixstringRead-onlyminLength 4maxLength 4

Last 4 characters of the gift card code for search and identification purposes.


createdDatestringRead-onlyformat date-time

Date and time the gift card was created.


currencystringimmutableformat CURRENCY

Three-letter currency code in ISO 4217 format. For example, "USD", "EUR".


disabledDatestringRead-onlyformat date-time

Date and time the gift card was disabled, if applicable.


expirationDatestringimmutableformat date-time

Date and time when the gift card expires and becomes unusable.


idstringRead-onlyformat GUID

Gift card ID.


initialValueAmountimmutable

Initial monetary value assigned to the gift card when created.


notificationInfoNotificationInfoimmutable

Email notification settings including recipient, sender, and delivery options.


sourcestringimmutable

How the gift card was created.


orderInfoOrderInfoimmutable

Order details when the gift card was purchased through an order.


updatedDatestringRead-onlyformat date-time

Date and time the gift card was last updated.

Did this help?