Gift Card (Object)

auto_reload_enabled
Type: boolean

Whether auto-reload is enabled for a gift card or not
card_background_image
Type: string

URL of the image that is displayed as the gift card background in the app of a business
card_number
Type: string

Unique gift card number as issued by the gift card processor (e.g., Aloha, Vantiv, Valutec, etc.) used by the business
created_at
Format: date-timeenum
const:
YYYY-MM-DDThh:mm:ssZ

Date/time when the gift card was created in the system, in ISO 8601 format
design_id
Type: integer

Identification of a particular gift card design selected by the user while purchasing a gift card
epin
Type: string

Security PIN associated with a gift card. A "null" value indicates that no epin is associated with the gift card.
gc_user_auto_reload_default_amount
Type: numberFormat: float

Default amount with which a gift card would be auto-reloaded
gc_user_auto_reload_preferred_payment
Type: string

UUID of the preferred payment card, which is used for making payments when auto-reloading the gift card
gc_user_auto_reload_threshold_amount
Type: numberFormat: float

Threshold amount below which a gift card becomes eligible for auto-reload
gift_card_id
Type: integer

Unique ID assigned to each gift card by the Punchh system. This ID will be passed in the push notification payload to app clients in the key gc. By mapping this, the app client can fetch the updated balance of a particular gift card.
last_fetched_amount
Type: numberFormat: float

The balance amount of a gift card last fetched from the gift card processor
last_fetched_at
Format: date-timeenum
const:
YYYY-MM-DDThh:mm:ssZ

The last time the balance amount of a gift card was fetched from the gift card processor. This indicates when it was cached.
name

Name of the card that has been assigned by the user. In case of purchase of a gift card from an app, users cannot add a name to the card. A "null" value indicates that a name has not been added to the card. A name can be added later using the Update Gift Cards API.
preferred
Type: boolean

A "true" value for a gift card indicates that a user has selected it to be the preferred gift card for payment.
status
Type: string

The status of a gift card. The only value exposed to a gift card in the app is "active". Other statuses are maintained for internal tracking.
updated_at
Format: date-timeenum
const:
YYYY-MM-DDThh:mm:ssZ

Date/time when the gift card was updated in the system, in ISO 8601 format
usb_scannable_card_number
Type: string

Easily scannable form of a gift card's number by adding ~ and ^ as prefix and suffix, respectively, to the gift card number. This is done to avoid issues at certain POS systems while scanning the QR code.
users
Type:

Includes details about the users who are registered on a particular business

Properties: 46
uuid
Type: string

Unique ID of the gift card issued by and maintained in the Punchh system

Games (Array Object)

Gift Card Default Amounts (Object)