Gift Card Object


GiftCard is the main entity of GiftCardService. It contains basic information such as gift card code, balance, and expiration date, as well as information about the source of the gift card (e.g., purchase, migration, etc.).

Properties
idstringRead-onlyformat GUID

Unique ID of the Gift Card.


codestringminLength 8maxLength 20immutable

Gift Card code for redemption.


initialValuestringformat DECIMAL_VALUEimmutabledecimalValue {"gte":"0","maxScale":2}

Initial value of the Gift Card.


balancestringRead-onlyformat DECIMAL_VALUEdecimalValue {"gte":"0","maxScale":2}

Current balance of the Gift Card.


sourceInfoSourceInfo

Information about the source of the gift card.


revisionstringRead-onlyformat int64

Gift Card revision.


currencystringformat CURRENCYimmutable

Gift Card currency.


expirationDatestringformat date-time

Gift Card expiration date.


createdDatestringRead-onlyformat date-time

Gift Card creation date.


updatedDatestringRead-onlyformat date-time

Gift Card last update date.


lastTransactionIdstringRead-onlydeprecated - use id insteadformat GUID

ID of the last transaction that modified the gift card balance.


disableDatestringRead-onlyformat date-time

Gift Card disable date, if the gift card was disabled.


idempotencyKeystringminLength 1maxLength 100immutable

Gift Card idempotency key, to prevent duplicate creation.


codeSuffixstringRead-onlymaxLength 4

Last 4 characters of the gift card code for easier reference and searching.


transactionDetailsTransactionDetailsRead-only

Transaction details related to the gift card.

Did this help?