create-gift-card-request.md

Create Gift Card Request

Represents a CreateGiftCard request.

Structure

CreateGiftCardRequest

Fields

Name	Type	Tags	Description	Getter	Setter
idempotencyKey	string	Required	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency. Constraints: Minimum Length: 1, Maximum Length: 128	getIdempotencyKey(): string	setIdempotencyKey(string idempotencyKey): void
locationId	string	Required	The ID of the location where the gift card should be registered for reporting purposes. Gift cards can be redeemed at any of the seller's locations. Constraints: Minimum Length: 1	getLocationId(): string	setLocationId(string locationId): void
giftCard	GiftCard	Required	Represents a Square gift card.	getGiftCard(): GiftCard	setGiftCard(GiftCard giftCard): void

Example (as JSON)

{
  "gift_card": {
    "type": "DIGITAL",
    "id": "id0",
    "gan_source": "SQUARE",
    "state": "ACTIVE",
    "balance_money": {
      "amount": 146,
      "currency": "BBD"
    },
    "gan": "gan6"
  },
  "idempotency_key": "NC9Tm69EjbjtConu",
  "location_id": "81FN9BNFZTKS4"
}