Retrieve Gift Card From GAN - Automate.ax

square.retrieveGiftCardFromGAN retrieves a gift card using the gift card account number (GAN).

Example

automations/square-retrieve-gift-card-from-gan.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Retrieve Square Gift Card From GAN", () => {
  onDashboardRun({ title: "Retrieve Square Gift Card From GAN" })

  square.retrieveGiftCardFromGAN({
    gan: "7783320001001635",
  })
})

Inputs

Every input accepts a compatible signal. It requires GIFTCARDS_READ.

Field	Type	Required	Default	Description
`gan`	`string`	Yes	—	The gift card account number (GAN) of the gift card to retrieve. The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. Square-issued gift cards have 16-digit GANs.

Use the official RetrieveGiftCardFromGAN reference for provider field semantics and limits.

Output

Returns the official Square.GetGiftCardFromGanResponse response as a codec-safe object. Square integer money amounts remain bigint values.