GiftcardResult

idFlakeIdRequired

giftcardGiftCardDtoOptional

Represents a gift card in the PayNow system.

idFlakeIdRequired

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.

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

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

created_atstringOptional

The date and time when the gift card was created.

created_byActorDtoOptional

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

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

Represents the actor that performed an action, such as the user, API key or game server that created or changed a record.

idFlakeIdOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

store_idFlakeIdOptional

Example

{
  "id": "411486491630370816",
  "giftcard": {
    "id": "411486491630370816",
    "balance": 2500,
    "code": "GIFT-2024-ABCD1234",
    "enabled": true,
    "starting_balance": 5000,
    "store_id": "411486491630370816",
    "usable_at": "2024-01-01T00:00:00Z",
    "canceled_at": "2024-01-01T00:00:00Z",
    "canceled_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "created_at": "2024-01-01T00:00:00Z",
    "created_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    },
    "expires_at": "2024-01-01T00:00:00Z",
    "note": "string",
    "updated_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "id": "411486491630370816",
      "type": "anonymous"
    }
  },
  "store_id": "411486491630370816"
}