Retrieve Gift Card - Automate.ax

square.retrieveGiftCard retrieves a gift card using the gift card ID.

Example

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

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

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

  square.retrieveGiftCard({
    id: "id",
  })
})

Inputs

Every input accepts a compatible signal. It requires GIFTCARDS_READ.

Field	Type	Required	Default	Description
`id`	`string`	Yes	—	The ID of the gift card to retrieve.

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

Output

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