retrieve-gift-card-response.md

Retrieve Gift Card Response

A response that contains a GiftCard. The response might contain a set of Error objects if the request resulted in errors.

Structure

Retrieve Gift Card Response

Fields

Name	Type	Tags	Description
errors	Array<Error Hash>	Optional	Any errors that occurred during the request.
gift_card	Gift Card Hash	Optional	Represents a Square gift card.

Example (as JSON)

{
  "gift_card": {
    "balance_money": {
      "amount": 1000,
      "currency": "USD"
    },
    "created_at": "2021-05-20T22:26:54.000Z",
    "gan": "7783320001001635",
    "gan_source": "SQUARE",
    "id": "gftc:00113070ba5745f0b2377c1b9570cb03",
    "state": "ACTIVE",
    "type": "DIGITAL"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    },
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}