RetrieveGiftCardFromGAN

v1.0.0

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

Input

{
  "type": "object",
  "description": "A request to retrieve gift cards by their GANs.",
  "required": [
    "gan"
  ],
  "properties": {
    "gan": {
      "type": "string",
      "description": "The gift card account number (GAN) of the gift card to retrieve.\nThe maximum length of a GAN is 255 digits to account for third-party GANs that have been imported.\nSquare-issued gift cards have 16-digit GANs."
    }
  }
}

Output

{
  "type": "object",
  "description": "A response that contains a `GiftCard`. This response might contain a set of `Error` objects\nif the request resulted in errors.",
  "properties": {
    "errors": {
      "type": "array",
      "description": "Any errors that occurred during the request.",
      "items": {
        "type": "object",
        "description": "Represents an error encountered during a request to the Connect API.\n\nSee [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.",
        "required": [
          "category",
          "code"
        ],
        "properties": {
          "category": {
            "type": "string",
            "description": "The high-level category for the error."
          },
          "code": {
            "type": "string",
            "description": "The specific code of the error."
          },
          "detail": {
            "type": "string",
            "description": "A human-readable description of the error for debugging purposes."
          },
          "field": {
            "type": "string",
            "description": "The name of the field provided in the original request (if any) that\nthe error pertains to."
          }
        }
      }
    },
    "gift_card": {
      "type": "object",
      "description": "Represents a Square gift card.",
      "required": [
        "type"
      ],
      "properties": {
        "balance_money": {
          "type": "object",
          "description": "Represents an amount of money. `Money` fields can be signed or unsigned.\nFields that do not explicitly define whether they are signed or unsigned are\nconsidered unsigned and can only hold positive amounts. For signed fields, the\nsign of the value indicates the purpose of the money transfer. See\n[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)\nfor more information.",
          "properties": {
            "amount": {
              "type": "integer",
              "format": "int64",
              "description": "The amount of money, in the smallest denomination of the currency\nindicated by `currency`. For example, when `currency` is `USD`, `amount` is\nin cents. Monetary amounts can be positive or negative. See the specific\nfield description to determine the meaning of the sign in a particular case."
            },
            "currency": {
              "type": "string",
              "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](https://developer.squareup.com/reference/square_2021-08-18/enums/Currency) for possible values."
            }
          }
        },
        "created_at": {
          "type": "string",
          "description": "The timestamp when the gift card was created, in RFC 3339 format. \nIn the case of a digital gift card, it is the time when you create a card \n(using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).  \nIn the case of a plastic gift card, it is the time when Square associates the card with the \nseller at the time of activation."
        },
        "customer_ids": {
          "type": "array",
          "description": "The IDs of the customers to whom this gift card is linked.",
          "items": {
            "type": "string"
          }
        },
        "gan": {
          "type": "string",
          "description": "The gift card account number."
        },
        "gan_source": {
          "type": "object"
        },
        "id": {
          "type": "string",
          "description": "The Square-assigned ID of the gift card."
        },
        "state": {
          "type": "object"
        },
        "type": {
          "type": "object"
        }
      }
    }
  }
}