Gift Card Object

Properties
obfuscatedCodestringmaxLength 30

Gift card obfuscated code.

For example: "--****-1234".

balanceobject

Gift card balance.

statusstring
4 enum supported values:
UNKNOWN_STATUSVALIDEXPIREDDISABLED

Current gift card status. Supported values:

  • VALID: Gift card is active and can be used for purchases.
  • EXPIRED: Gift card expiration date has passed and can no longer be used.
  • DISABLED: Gift card has been disabled by the merchant and can no longer be used.
appIdstringformat GUID

App ID of the gift card provider, as returned in Get Checkout or List Transactions for Single Order.

Was this helpful?
Yes
No