• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index
You are viewing an old version of the API
GiftCard

Represents a Square gift card.

Properties
Name Description
id
string

Read only The Square-assigned ID of the gift card.
type
string
Required

The gift card type.
gan_source
string

The source that generated the gift card account number (GAN). The default value is SQUARE.
state
string

Read only The current gift card state.
balance_money
Money

Read only The current gift card balance. This balance is always greater than or equal to zero.
gan
string

The gift card account number (GAN). Buyers can use the GAN to make purchases or check the gift card balance.
created_at
string

Read only The timestamp when the gift card was created, in RFC 3339 format. In the case of a digital gift card, it is the time when you create a card (using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).
In the case of a plastic gift card, it is the time when Square associates the card with the seller at the time of activation.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00
customer_ids
string [ ]

Read only The IDs of the customer profiles to whom this gift card is linked.