Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.98 KB

gift-card.md

File metadata and controls

34 lines (25 loc) · 1.98 KB

Gift Card

Represents a Square gift card.

Structure

GiftCard

Fields

Name Type Tags Description
id string | undefined Optional The Square-assigned ID of the gift card.
type string Required Indicates the gift card type.
ganSource string | undefined Optional Indicates the source that generated the gift card
account number (GAN).
state string | undefined Optional Indicates the gift card state.
balanceMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
gan string | undefined Optional The gift card account number (GAN). Buyers can use the GAN to make purchases or check
the gift card balance.
createdAt string | undefined Optional 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.
customerIds string[] | undefined Optional The IDs of the customer profiles to whom this gift card is linked.

Example (as JSON)

{
  "type": "PHYSICAL",
  "gan_source": null,
  "state": null,
  "balance_money": null,
  "gan": null
}