PayNow

GiftcardResult

idFlakeIdRequired
giftcardGiftCardDtoOptional
Represents a gift card in the PayNow system.
balanceintegerRequired
The current balance remaining on the gift card in cents.
codestringRequired
The unique code that customers use to redeem the gift card.
enabledbooleanRequired
Indicates whether the gift card is currently enabled and can be used.
idFlakeIdRequired
starting_balanceintegerRequired
The original balance when the gift card was first created in cents.
store_idFlakeIdRequired
usable_atstringRequired
The date and time when the gift card becomes usable.
canceled_atstringOptional
The date and time when the gift card was canceled, if applicable.
canceled_byActorDtoOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
idFlakeIdOptional
created_atstringOptional
The date and time when the gift card was created.
created_byActorDtoOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
idFlakeIdOptional
expires_atstringOptional
The date and time when the gift card expires, if applicable.
notestringOptional
Optional note or description associated with the gift card.
updated_atstringOptional
The date and time when the gift card was last updated, if applicable.
updated_byActorDtoOptional
typeenumRequired
Possible enum values
  • anonymous
  • user
  • api_key
  • customer
  • game_server
  • internal
  • admin
  • platform
  • global_customer
idFlakeIdOptional
store_idFlakeIdOptional
Example
{
  "id": "411486491630370816",
  "store_id": "411486491630370816",
  "giftcard": {
    "balance": 2500,
    "code": "GIFT-2024-ABCD1234",
    "enabled": true,
    "id": "411486491630370816",
    "starting_balance": 5000,
    "store_id": "411486491630370816",
    "usable_at": "2024-01-01T00:00:00Z",
    "note": "string",
    "expires_at": "2024-01-01T00:00:00Z",
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "canceled_at": "2024-01-01T00:00:00Z",
    "canceled_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
}