> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Retrieve Gift Card From GAN

> Retrieves a gift card using the gift card account number (GAN).

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

## Example

```ts automations/square-retrieve-gift-card-from-gan.automation.ts theme={null}
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](https://developer.squareup.com/reference/square/gift-cards-api/retrieve-gift-card-from-gan) 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.