{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-list-loyalty-promotions-response-schema.json",
  "title": "ListLoyaltyPromotionsResponse",
  "description": "Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions) response.\nOne of `loyalty_promotions`, an empty object, or `errors` is present in the response.\nIf additional results are available, the `cursor` field is also present along with `loyalty_promotions`.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/square-loyalty-api-openapi.yml#/components/schemas/ListLoyaltyPromotionsResponse",
  "type": "object",
  "x-release-status": "PUBLIC",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Error"
      },
      "description": "Any errors that occurred during the request."
    },
    "loyalty_promotions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/LoyaltyPromotion"
      },
      "description": "The retrieved loyalty promotions."
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use in your next call to this endpoint to retrieve the next page of results\nfor your original request. This field is present only if the request succeeded and additional\nresults are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination)."
    }
  },
  "$defs": {
    "Currency": {
      "type": "string",
      "enum": [
        "UNKNOWN_CURRENCY",
        "AED",
        "AFN",
        "ALL",
        "AMD",
        "ANG",
        "AOA",
        "ARS",
        "AUD",
        "AWG",
        "AZN",
        "BAM",
        "BBD",
        "BDT",
        "BGN",
        "BHD",
        "BIF",
        "BMD",
        "BND",
        "BOB",
        "BOV",
        "BRL",
        "BSD",
        "BTN",
        "BWP",
        "BYR",
        "BZD",
        "CAD",
        "CDF",
        "CHE",
        "CHF",
        "CHW",
        "CLF",
        "CLP",
        "CNY",
        "COP",
        "COU",
        "CRC",
        "CUC",
        "CUP",
        "CVE",
        "CZK",
        "DJF",
        "DKK",
        "DOP",
        "DZD",
        "EGP",
        "ERN",
        "ETB",
        "EUR",
        "FJD",
        "FKP",
        "GBP",
        "GEL",
        "GHS",
        "GIP",
        "GMD",
        "GNF",
        "GTQ",
        "GYD",
        "HKD",
        "HNL",
        "HRK",
        "HTG",
        "HUF",
        "IDR",
        "ILS",
        "INR",
        "IQD",
        "IRR",
        "ISK",
        "JMD",
        "JOD",
        "JPY",
        "KES",
        "KGS",
        "KHR",
        "KMF",
        "KPW",
        "KRW",
        "KWD",
        "KYD",
        "KZT",
        "LAK",
        "LBP",
        "LKR",
        "LRD",
        "LSL",
        "LTL",
        "LVL",
        "LYD",
        "MAD",
        "MDL",
        "MGA",
        "MKD",
        "MMK",
        "MNT",
        "MOP",
        "MRO",
        "MUR",
        "MVR",
        "MWK",
        "MXN",
        "MXV",
        "MYR",
        "MZN",
        "NAD",
        "NGN",
        "NIO",
        "NOK",
        "NPR",
        "NZD",
        "OMR",
        "PAB",
        "PEN",
        "PGK",
        "PHP",
        "PKR",
        "PLN",
        "PYG",
        "QAR",
        "RON",
        "RSD",
        "RUB",
        "RWF",
        "SAR",
        "SBD",
        "SCR",
        "SDG",
        "SEK",
        "SGD",
        "SHP",
        "SLL",
        "SLE",
        "SOS",
        "SRD",
        "SSP",
        "STD",
        "SVC",
        "SYP",
        "SZL",
        "THB",
        "TJS",
        "TMT",
        "TND",
        "TOP",
        "TRY",
        "TTD",
        "TWD",
        "TZS",
        "UAH",
        "UGX",
        "USD",
        "USN",
        "USS",
        "UYI",
        "UYU",
        "UZS",
        "VEF",
        "VND",
        "VUV",
        "WST",
        "XAF",
        "XAG",
        "XAU",
        "XBA",
        "XBB",
        "XBC",
        "XBD",
        "XCD",
        "XDR",
        "XOF",
        "XPD",
        "XPF",
        "XPT",
        "XTS",
        "XXX",
        "YER",
        "ZAR",
        "ZMK",
        "ZMW",
        "BTC",
        "XUS"
      ],
      "x-enum-elements": [
        {
          "name": "UNKNOWN_CURRENCY",
          "description": "Unknown currency"
        },
        {
          "name": "AED",
          "description": "United Arab Emirates dirham"
        },
        {
          "name": "AFN",
          "description": "Afghan afghani"
        },
        {
          "name": "ALL",
          "description": "Albanian lek"
        },
        {
          "name": "AMD",
          "description": "Armenian dram"
        },
        {
          "name": "ANG",
          "description": "Netherlands Antillean guilder"
        },
        {
          "name": "AOA",
          "description": "Angolan kwanza"
        },
        {
          "name": "ARS",
          "description": "Argentine peso"
        },
        {
          "name": "AUD",
          "description": "Australian dollar"
        },
        {
          "name": "AWG",
          "description": "Aruban florin"
        },
        {
          "name": "AZN",
          "description": "Azerbaijani manat"
        },
        {
          "name": "BAM",
          "description": "Bosnia and Herzegovina convertible mark"
        },
        {
          "name": "BBD",
          "description": "Barbados dollar"
        },
        {
          "name": "BDT",
          "description": "Bangladeshi taka"
        },
        {
          "name": "BGN",
          "description": "Bulgarian lev"
        },
        {
          "name": "BHD",
          "description": "Bahraini dinar"
        },
        {
          "name": "BIF",
          "description": "Burundian franc"
        },
        {
          "name": "BMD",
          "description": "Bermudian dollar"
        },
        {
          "name": "BND",
          "description": "Brunei dollar"
        },
        {
          "name": "BOB",
          "description": "Boliviano"
        },
        {
          "name": "BOV",
          "description": "Bolivian Mvdol"
        },
        {
          "name": "BRL",
          "description": "Brazilian real"
        },
        {
          "name": "BSD",
          "description": "Bahamian dollar"
        },
        {
          "name": "BTN",
          "description": "Bhutanese ngultrum"
        },
        {
          "name": "BWP",
          "description": "Botswana pula"
        },
        {
          "name": "BYR",
          "description": "Belarusian ruble"
        },
        {
          "name": "BZD",
          "description": "Belize dollar"
        },
        {
          "name": "CAD",
          "description": "Canadian dollar"
        },
        {
          "name": "CDF",
          "description": "Congolese franc"
        },
        {
          "name": "CHE",
          "description": "WIR Euro"
        },
        {
          "name": "CHF",
          "description": "Swiss franc"
        },
        {
          "name": "CHW",
          "description": "WIR Franc"
        },
        {
          "name": "CLF",
          "description": "Unidad de Fomento"
        },
        {
          "name": "CLP",
          "description": "Chilean peso"
        },
        {
          "name": "CNY",
          "description": "Chinese yuan"
        },
        {
          "name": "COP",
          "description": "Colombian peso"
        },
        {
          "name": "COU",
          "description": "Unidad de Valor Real"
        },
        {
          "name": "CRC",
          "description": "Costa Rican colon"
        },
        {
          "name": "CUC",
          "description": "Cuban convertible peso"
        },
        {
          "name": "CUP",
          "description": "Cuban peso"
        },
        {
          "name": "CVE",
          "description": "Cape Verdean escudo"
        },
        {
          "name": "CZK",
          "description": "Czech koruna"
        },
        {
          "name": "DJF",
          "description": "Djiboutian franc"
        },
        {
          "name": "DKK",
          "description": "Danish krone"
        },
        {
          "name": "DOP",
          "description": "Dominican peso"
        },
        {
          "name": "DZD",
          "description": "Algerian dinar"
        },
        {
          "name": "EGP",
          "description": "Egyptian pound"
        },
        {
          "name": "ERN",
          "description": "Eritrean nakfa"
        },
        {
          "name": "ETB",
          "description": "Ethiopian birr"
        },
        {
          "name": "EUR",
          "description": "Euro"
        },
        {
          "name": "FJD",
          "description": "Fiji dollar"
        },
        {
          "name": "FKP",
          "description": "Falkland Islands pound"
        },
        {
          "name": "GBP",
          "description": "Pound sterling"
        },
        {
          "name": "GEL",
          "description": "Georgian lari"
        },
        {
          "name": "GHS",
          "description": "Ghanaian cedi"
        },
        {
          "name": "GIP",
          "description": "Gibraltar pound"
        },
        {
          "name": "GMD",
          "description": "Gambian dalasi"
        },
        {
          "name": "GNF",
          "description": "Guinean franc"
        },
        {
          "name": "GTQ",
          "description": "Guatemalan quetzal"
        },
        {
          "name": "GYD",
          "description": "Guyanese dollar"
        },
        {
          "name": "HKD",
          "description": "Hong Kong dollar"
        },
        {
          "name": "HNL",
          "description": "Honduran lempira"
        },
        {
          "name": "HRK",
          "description": "Croatian kuna"
        },
        {
          "name": "HTG",
          "description": "Haitian gourde"
        },
        {
          "name": "HUF",
          "description": "Hungarian forint"
        },
        {
          "name": "IDR",
          "description": "Indonesian rupiah"
        },
        {
          "name": "ILS",
          "description": "Israeli new shekel"
        },
        {
          "name": "INR",
          "description": "Indian rupee"
        },
        {
          "name": "IQD",
          "description": "Iraqi dinar"
        },
        {
          "name": "IRR",
          "description": "Iranian rial"
        },
        {
          "name": "ISK",
          "description": "Icelandic króna"
        },
        {
          "name": "JMD",
          "description": "Jamaican dollar"
        },
        {
          "name": "JOD",
          "description": "Jordanian dinar"
        },
        {
          "name": "JPY",
          "description": "Japanese yen"
        },
        {
          "name": "KES",
          "description": "Kenyan shilling"
        },
        {
          "name": "KGS",
          "description": "Kyrgyzstani som"
        },
        {
          "name": "KHR",
          "description": "Cambodian riel"
        },
        {
          "name": "KMF",
          "description": "Comoro franc"
        },
        {
          "name": "KPW",
          "description": "North Korean won"
        },
        {
          "name": "KRW",
          "description": "South Korean won"
        },
        {
          "name": "KWD",
          "description": "Kuwaiti dinar"
        },
        {
          "name": "KYD",
          "description": "Cayman Islands dollar"
        },
        {
          "name": "KZT",
          "description": "Kazakhstani tenge"
        },
        {
          "name": "LAK",
          "description": "Lao kip"
        },
        {
          "name": "LBP",
          "description": "Lebanese pound"
        },
        {
          "name": "LKR",
          "description": "Sri Lankan rupee"
        },
        {
          "name": "LRD",
          "description": "Liberian dollar"
        },
        {
          "name": "LSL",
          "description": "Lesotho loti"
        },
        {
          "name": "LTL",
          "description": "Lithuanian litas"
        },
        {
          "name": "LVL",
          "description": "Latvian lats"
        },
        {
          "name": "LYD",
          "description": "Libyan dinar"
        },
        {
          "name": "MAD",
          "description": "Moroccan dirham"
        },
        {
          "name": "MDL",
          "description": "Moldovan leu"
        },
        {
          "name": "MGA",
          "description": "Malagasy ariary"
        },
        {
          "name": "MKD",
          "description": "Macedonian denar"
        },
        {
          "name": "MMK",
          "description": "Myanmar kyat"
        },
        {
          "name": "MNT",
          "description": "Mongolian tögrög"
        },
        {
          "name": "MOP",
          "description": "Macanese pataca"
        },
        {
          "name": "MRO",
          "description": "Mauritanian ouguiya"
        },
        {
          "name": "MUR",
          "description": "Mauritian rupee"
        },
        {
          "name": "MVR",
          "description": "Maldivian rufiyaa"
        },
        {
          "name": "MWK",
          "description": "Malawian kwacha"
        },
        {
          "name": "MXN",
          "description": "Mexican peso"
        },
        {
          "name": "MXV",
          "description": "Mexican Unidad de Inversion"
        },
        {
          "name": "MYR",
          "description": "Malaysian ringgit"
        },
        {
          "name": "MZN",
          "description": "Mozambican metical"
        },
        {
          "name": "NAD",
          "description": "Namibian dollar"
        },
        {
          "name": "NGN",
          "description": "Nigerian naira"
        },
        {
          "name": "NIO",
          "description": "Nicaraguan córdoba"
        },
        {
          "name": "NOK",
          "description": "Norwegian krone"
        },
        {
          "name": "NPR",
          "description": "Nepalese rupee"
        },
        {
          "name": "NZD",
          "description": "New Zealand dollar"
        },
        {
          "name": "OMR",
          "description": "Omani rial"
        },
        {
          "name": "PAB",
          "description": "Panamanian balboa"
        },
        {
          "name": "PEN",
          "description": "Peruvian sol"
        },
        {
          "name": "PGK",
          "description": "Papua New Guinean kina"
        },
        {
          "name": "PHP",
          "description": "Philippine peso"
        },
        {
          "name": "PKR",
          "description": "Pakistani rupee"
        },
        {
          "name": "PLN",
          "description": "Polish zBoty"
        },
        {
          "name": "PYG",
          "description": "Paraguayan guaraní"
        },
        {
          "name": "QAR",
          "description": "Qatari riyal"
        },
        {
          "name": "RON",
          "description": "Romanian leu"
        },
        {
          "name": "RSD",
          "description": "Serbian dinar"
        },
        {
          "name": "RUB",
          "description": "Russian ruble"
        },
        {
          "name": "RWF",
          "description": "Rwandan franc"
        },
        {
          "name": "SAR",
          "description": "Saudi riyal"
        },
        {
          "name": "SBD",
          "description": "Solomon Islands dollar"
        },
        {
          "name": "SCR",
          "description": "Seychelles rupee"
        },
        {
          "name": "SDG",
          "description": "Sudanese pound"
        },
        {
          "name": "SEK",
          "description": "Swedish krona"
        },
        {
          "name": "SGD",
          "description": "Singapore dollar"
        },
        {
          "name": "SHP",
          "description": "Saint Helena pound"
        },
        {
          "name": "SLL",
          "description": "Sierra Leonean first leone"
        },
        {
          "name": "SLE",
          "description": "Sierra Leonean second leone"
        },
        {
          "name": "SOS",
          "description": "Somali shilling"
        },
        {
          "name": "SRD",
          "description": "Surinamese dollar"
        },
        {
          "name": "SSP",
          "description": "South Sudanese pound"
        },
        {
          "name": "STD",
          "description": "São Tomé and Príncipe dobra"
        },
        {
          "name": "SVC",
          "description": "Salvadoran colón"
        },
        {
          "name": "SYP",
          "description": "Syrian pound"
        },
        {
          "name": "SZL",
          "description": "Swazi lilangeni"
        },
        {
          "name": "THB",
          "description": "Thai baht"
        },
        {
          "name": "TJS",
          "description": "Tajikstani somoni"
        },
        {
          "name": "TMT",
          "description": "Turkmenistan manat"
        },
        {
          "name": "TND",
          "description": "Tunisian dinar"
        },
        {
          "name": "TOP",
          "description": "Tongan pa'anga"
        },
        {
          "name": "TRY",
          "description": "Turkish lira"
        },
        {
          "name": "TTD",
          "description": "Trinidad and Tobago dollar"
        },
        {
          "name": "TWD",
          "description": "New Taiwan dollar"
        },
        {
          "name": "TZS",
          "description": "Tanzanian shilling"
        },
        {
          "name": "UAH",
          "description": "Ukrainian hryvnia"
        },
        {
          "name": "UGX",
          "description": "Ugandan shilling"
        },
        {
          "name": "USD",
          "description": "United States dollar"
        },
        {
          "name": "USN",
          "description": "United States dollar (next day)"
        },
        {
          "name": "USS",
          "description": "United States dollar (same day)"
        },
        {
          "name": "UYI",
          "description": "Uruguay Peso en Unidedades Indexadas"
        },
        {
          "name": "UYU",
          "description": "Uruguyan peso"
        },
        {
          "name": "UZS",
          "description": "Uzbekistan som"
        },
        {
          "name": "VEF",
          "description": "Venezuelan bolívar soberano"
        },
        {
          "name": "VND",
          "description": "Vietnamese ’Óng"
        },
        {
          "name": "VUV",
          "description": "Vanuatu vatu"
        },
        {
          "name": "WST",
          "description": "Samoan tala"
        },
        {
          "name": "XAF",
          "description": "CFA franc BEAC"
        },
        {
          "name": "XAG",
          "description": "Silver"
        },
        {
          "name": "XAU",
          "description": "Gold"
        },
        {
          "name": "XBA",
          "description": "European Composite Unit"
        },
        {
          "name": "XBB",
          "description": "European Monetary Unit"
        },
        {
          "name": "XBC",
          "description": "European Unit of Account 9"
        },
        {
          "name": "XBD",
          "description": "European Unit of Account 17"
        },
        {
          "name": "XCD",
          "description": "East Caribbean dollar"
        },
        {
          "name": "XDR",
          "description": "Special drawing rights (International Monetary Fund)"
        },
        {
          "name": "XOF",
          "description": "CFA franc BCEAO"
        },
        {
          "name": "XPD",
          "description": "Palladium"
        },
        {
          "name": "XPF",
          "description": "CFP franc"
        },
        {
          "name": "XPT",
          "description": "Platinum"
        },
        {
          "name": "XTS",
          "description": "Code reserved for testing"
        },
        {
          "name": "XXX",
          "description": "No currency"
        },
        {
          "name": "YER",
          "description": "Yemeni rial"
        },
        {
          "name": "ZAR",
          "description": "South African rand"
        },
        {
          "name": "ZMK",
          "description": "Zambian kwacha"
        },
        {
          "name": "ZMW",
          "description": "Zambian kwacha"
        },
        {
          "name": "BTC",
          "description": "Bitcoin"
        },
        {
          "name": "XUS",
          "description": "USD Coin"
        }
      ],
      "description": "Indicates the associated currency for an amount of money. Values correspond\nto [ISO 4217](https://wikipedia.org/wiki/ISO_4217).",
      "x-release-status": "PUBLIC"
    },
    "Error": {
      "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.",
      "x-release-status": "PUBLIC",
      "required": [
        "category",
        "code"
      ],
      "properties": {
        "category": {
          "$ref": "#/$defs/ErrorCategory",
          "description": "The high-level category for the error.\nSee [ErrorCategory](#type-errorcategory) for possible values"
        },
        "code": {
          "$ref": "#/$defs/ErrorCode",
          "description": "The specific code of the error.\nSee [ErrorCode](#type-errorcode) for possible values"
        },
        "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."
        }
      }
    },
    "ErrorCategory": {
      "type": "string",
      "enum": [
        "API_ERROR",
        "AUTHENTICATION_ERROR",
        "INVALID_REQUEST_ERROR",
        "RATE_LIMIT_ERROR",
        "PAYMENT_METHOD_ERROR",
        "REFUND_ERROR",
        "MERCHANT_SUBSCRIPTION_ERROR",
        "EXTERNAL_VENDOR_ERROR"
      ],
      "x-enum-elements": [
        {
          "name": "API_ERROR",
          "description": "An error occurred with the Connect API itself."
        },
        {
          "name": "AUTHENTICATION_ERROR",
          "description": "An authentication error occurred. Most commonly, the request had\na missing, malformed, or otherwise invalid `Authorization` header."
        },
        {
          "name": "INVALID_REQUEST_ERROR",
          "description": "The request was invalid. Most commonly, a required parameter was\nmissing, or a provided parameter had an invalid value."
        },
        {
          "name": "RATE_LIMIT_ERROR",
          "description": "Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests\nto Square APIs in a short period of time.\n\nYour application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)\nschedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule."
        },
        {
          "name": "PAYMENT_METHOD_ERROR",
          "description": "An error occurred while processing a payment method. Most commonly,\nthe details of the payment method were invalid (such as a card's CVV\nor expiration date)."
        },
        {
          "name": "REFUND_ERROR",
          "description": "An error occurred while attempting to process a refund."
        },
        {
          "name": "MERCHANT_SUBSCRIPTION_ERROR",
          "description": "An error occurred when checking a merchant subscription status"
        },
        {
          "name": "EXTERNAL_VENDOR_ERROR",
          "description": "An error that is returned from an external vendor's API"
        }
      ],
      "description": "Indicates which high-level category of error has occurred during a\nrequest to the Connect API.",
      "x-release-status": "PUBLIC"
    },
    "ErrorCode": {
      "type": "string",
      "enum": [
        "INTERNAL_SERVER_ERROR",
        "UNAUTHORIZED",
        "ACCESS_TOKEN_EXPIRED",
        "ACCESS_TOKEN_REVOKED",
        "CLIENT_DISABLED",
        "FORBIDDEN",
        "INSUFFICIENT_SCOPES",
        "APPLICATION_DISABLED",
        "V1_APPLICATION",
        "V1_ACCESS_TOKEN",
        "CARD_PROCESSING_NOT_ENABLED",
        "MERCHANT_SUBSCRIPTION_NOT_FOUND",
        "BAD_REQUEST",
        "MISSING_REQUIRED_PARAMETER",
        "INCORRECT_TYPE",
        "INVALID_TIME",
        "INVALID_TIME_RANGE",
        "INVALID_VALUE",
        "INVALID_CURSOR",
        "UNKNOWN_QUERY_PARAMETER",
        "CONFLICTING_PARAMETERS",
        "EXPECTED_JSON_BODY",
        "INVALID_SORT_ORDER",
        "VALUE_REGEX_MISMATCH",
        "VALUE_TOO_SHORT",
        "VALUE_TOO_LONG",
        "VALUE_TOO_LOW",
        "VALUE_TOO_HIGH",
        "VALUE_EMPTY",
        "ARRAY_LENGTH_TOO_LONG",
        "ARRAY_LENGTH_TOO_SHORT",
        "ARRAY_EMPTY",
        "EXPECTED_BOOLEAN",
        "EXPECTED_INTEGER",
        "EXPECTED_FLOAT",
        "EXPECTED_STRING",
        "EXPECTED_OBJECT",
        "EXPECTED_ARRAY",
        "EXPECTED_MAP",
        "EXPECTED_BASE64_ENCODED_BYTE_ARRAY",
        "INVALID_ARRAY_VALUE",
        "INVALID_ENUM_VALUE",
        "INVALID_CONTENT_TYPE",
        "INVALID_FORM_VALUE",
        "CUSTOMER_NOT_FOUND",
        "ONE_INSTRUMENT_EXPECTED",
        "NO_FIELDS_SET",
        "TOO_MANY_MAP_ENTRIES",
        "MAP_KEY_LENGTH_TOO_SHORT",
        "MAP_KEY_LENGTH_TOO_LONG",
        "CUSTOMER_MISSING_NAME",
        "CUSTOMER_MISSING_EMAIL",
        "INVALID_PAUSE_LENGTH",
        "INVALID_DATE",
        "UNSUPPORTED_COUNTRY",
        "UNSUPPORTED_CURRENCY",
        "APPLE_TTP_PIN_TOKEN",
        "CARD_EXPIRED",
        "INVALID_EXPIRATION",
        "INVALID_EXPIRATION_YEAR",
        "INVALID_EXPIRATION_DATE",
        "UNSUPPORTED_CARD_BRAND",
        "UNSUPPORTED_ENTRY_METHOD",
        "INVALID_ENCRYPTED_CARD",
        "INVALID_CARD",
        "PAYMENT_AMOUNT_MISMATCH",
        "GENERIC_DECLINE",
        "CVV_FAILURE",
        "ADDRESS_VERIFICATION_FAILURE",
        "INVALID_ACCOUNT",
        "CURRENCY_MISMATCH",
        "INSUFFICIENT_FUNDS",
        "INSUFFICIENT_PERMISSIONS",
        "CARDHOLDER_INSUFFICIENT_PERMISSIONS",
        "INVALID_LOCATION",
        "TRANSACTION_LIMIT",
        "VOICE_FAILURE",
        "PAN_FAILURE",
        "EXPIRATION_FAILURE",
        "CARD_NOT_SUPPORTED",
        "INVALID_PIN",
        "MISSING_PIN",
        "MISSING_ACCOUNT_TYPE",
        "INVALID_POSTAL_CODE",
        "INVALID_FEES",
        "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED",
        "PAYMENT_LIMIT_EXCEEDED",
        "GIFT_CARD_AVAILABLE_AMOUNT",
        "ACCOUNT_UNUSABLE",
        "BUYER_REFUSED_PAYMENT",
        "DELAYED_TRANSACTION_EXPIRED",
        "DELAYED_TRANSACTION_CANCELED",
        "DELAYED_TRANSACTION_CAPTURED",
        "DELAYED_TRANSACTION_FAILED",
        "CARD_TOKEN_EXPIRED",
        "CARD_TOKEN_USED",
        "AMOUNT_TOO_HIGH",
        "UNSUPPORTED_INSTRUMENT_TYPE",
        "REFUND_AMOUNT_INVALID",
        "REFUND_ALREADY_PENDING",
        "PAYMENT_NOT_REFUNDABLE",
        "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE",
        "REFUND_DECLINED",
        "INSUFFICIENT_PERMISSIONS_FOR_REFUND",
        "INVALID_CARD_DATA",
        "SOURCE_USED",
        "SOURCE_EXPIRED",
        "UNSUPPORTED_LOYALTY_REWARD_TIER",
        "LOCATION_MISMATCH",
        "IDEMPOTENCY_KEY_REUSED",
        "UNEXPECTED_VALUE",
        "SANDBOX_NOT_SUPPORTED",
        "INVALID_EMAIL_ADDRESS",
        "INVALID_PHONE_NUMBER",
        "CHECKOUT_EXPIRED",
        "BAD_CERTIFICATE",
        "INVALID_SQUARE_VERSION_FORMAT",
        "API_VERSION_INCOMPATIBLE",
        "CARD_PRESENCE_REQUIRED",
        "UNSUPPORTED_SOURCE_TYPE",
        "CARD_MISMATCH",
        "PLAID_ERROR",
        "PLAID_ERROR_ITEM_LOGIN_REQUIRED",
        "PLAID_ERROR_RATE_LIMIT",
        "CARD_DECLINED",
        "VERIFY_CVV_FAILURE",
        "VERIFY_AVS_FAILURE",
        "CARD_DECLINED_CALL_ISSUER",
        "CARD_DECLINED_VERIFICATION_REQUIRED",
        "BAD_EXPIRATION",
        "CHIP_INSERTION_REQUIRED",
        "ALLOWABLE_PIN_TRIES_EXCEEDED",
        "RESERVATION_DECLINED",
        "UNKNOWN_BODY_PARAMETER",
        "NOT_FOUND",
        "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND",
        "METHOD_NOT_ALLOWED",
        "NOT_ACCEPTABLE",
        "REQUEST_TIMEOUT",
        "CONFLICT",
        "GONE",
        "REQUEST_ENTITY_TOO_LARGE",
        "UNSUPPORTED_MEDIA_TYPE",
        "UNPROCESSABLE_ENTITY",
        "RATE_LIMITED",
        "NOT_IMPLEMENTED",
        "BAD_GATEWAY",
        "SERVICE_UNAVAILABLE",
        "TEMPORARY_ERROR",
        "GATEWAY_TIMEOUT"
      ],
      "x-enum-elements": [
        {
          "name": "INTERNAL_SERVER_ERROR",
          "description": "A general server error occurred.",
          "error-category": "API_ERROR"
        },
        {
          "name": "UNAUTHORIZED",
          "description": "A general authorization error occurred.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "ACCESS_TOKEN_EXPIRED",
          "description": "The provided access token has expired.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "ACCESS_TOKEN_REVOKED",
          "description": "The provided access token has been revoked.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "CLIENT_DISABLED",
          "description": "The provided client has been disabled.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "FORBIDDEN",
          "description": "A general access error occurred.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "INSUFFICIENT_SCOPES",
          "description": "The provided access token does not have permission\nto execute the requested action.",
          "error-category": "AUTHENTICATION_ERROR"
        },
        {
          "name": "APPLICATION_DISABLED",
          "description": "The calling application was disabled.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "V1_APPLICATION",
          "description": "The calling application was created prior to\n2016-03-30 and is not compatible with v2 Square API calls.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "V1_ACCESS_TOKEN",
          "description": "The calling application is using an access token\ncreated prior to 2016-03-30 and is not compatible with v2 Square API\ncalls.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_PROCESSING_NOT_ENABLED",
          "description": "The location provided in the API call is not\nenabled for credit card processing.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MERCHANT_SUBSCRIPTION_NOT_FOUND",
          "description": "A required subscription was not found for the merchant",
          "error-category": "MERCHANT_SUBSCRIPTION_ERROR"
        },
        {
          "name": "BAD_REQUEST",
          "description": "A general error occurred with the request.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MISSING_REQUIRED_PARAMETER",
          "description": "The request is missing a required path, query, or\nbody parameter.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INCORRECT_TYPE",
          "description": "The value provided in the request is the wrong\ntype. For example, a string instead of an integer.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_TIME",
          "description": "Formatting for the provided time value is\nincorrect.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_TIME_RANGE",
          "description": "The time range provided in the request is invalid.\nFor example, the end time is before the start time.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_VALUE",
          "description": "The provided value is invalid. For example,\nincluding `%` in a phone number.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_CURSOR",
          "description": "The pagination cursor included in the request is\ninvalid.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNKNOWN_QUERY_PARAMETER",
          "description": "The query parameters provided is invalid for the\nrequested endpoint.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CONFLICTING_PARAMETERS",
          "description": "One or more of the request parameters conflict with\neach other.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_JSON_BODY",
          "description": "The request body is not a JSON object.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_SORT_ORDER",
          "description": "The provided sort order is not a valid key.\nCurrently, sort order must be `ASC` or `DESC`.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_REGEX_MISMATCH",
          "description": "The provided value does not match an expected\nregular expression.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_TOO_SHORT",
          "description": "The provided string value is shorter than the\nminimum length allowed.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_TOO_LONG",
          "description": "The provided string value is longer than the\nmaximum length allowed.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_TOO_LOW",
          "description": "The provided value is less than the supported\nminimum.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_TOO_HIGH",
          "description": "The provided value is greater than the supported\nmaximum.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "VALUE_EMPTY",
          "description": "The provided value has a default (empty) value\nsuch as a blank string.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "ARRAY_LENGTH_TOO_LONG",
          "description": "The provided array has too many elements.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "ARRAY_LENGTH_TOO_SHORT",
          "description": "The provided array has too few elements.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "ARRAY_EMPTY",
          "description": "The provided array is empty.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_BOOLEAN",
          "description": "The endpoint expected the provided value to be a\nboolean.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_INTEGER",
          "description": "The endpoint expected the provided value to be an\ninteger.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_FLOAT",
          "description": "The endpoint expected the provided value to be a\nfloat.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_STRING",
          "description": "The endpoint expected the provided value to be a\nstring.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_OBJECT",
          "description": "The endpoint expected the provided value to be a\nJSON object.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_ARRAY",
          "description": "The endpoint expected the provided value to be an\narray or list.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_MAP",
          "description": "The endpoint expected the provided value to be a\nmap or associative array.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY",
          "description": "The endpoint expected the provided value to be an\narray encoded in base64.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_ARRAY_VALUE",
          "description": "One or more objects in the array does not match the\narray type.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_ENUM_VALUE",
          "description": "The provided static string is not valid for the\nfield.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_CONTENT_TYPE",
          "description": "Invalid content type header.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_FORM_VALUE",
          "description": "Only relevant for applications created prior to\n2016-03-30. Indicates there was an error while parsing form values.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CUSTOMER_NOT_FOUND",
          "description": "The provided customer id can't be found in the merchant's customers list.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "ONE_INSTRUMENT_EXPECTED",
          "description": "A general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "NO_FIELDS_SET",
          "description": "A general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "TOO_MANY_MAP_ENTRIES",
          "description": "Too many entries in the map field.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MAP_KEY_LENGTH_TOO_SHORT",
          "description": "The length of one of the provided keys in the map is too short.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "MAP_KEY_LENGTH_TOO_LONG",
          "description": "The length of one of the provided keys in the map is too long.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CUSTOMER_MISSING_NAME",
          "description": "The provided customer does not have a recorded name.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CUSTOMER_MISSING_EMAIL",
          "description": "The provided customer does not have a recorded email.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_PAUSE_LENGTH",
          "description": "The subscription cannot be paused longer than the duration of the current phase.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_DATE",
          "description": "The subscription cannot be paused/resumed on the given date.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_COUNTRY",
          "description": "The API request references an unsupported country.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_CURRENCY",
          "description": "The API request references an unsupported currency.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "APPLE_TTP_PIN_TOKEN",
          "description": "The payment was declined by the card issuer during an Apple Tap to Pay (TTP)\ntransaction with a request for the card's PIN. This code will be returned alongside\n`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an\nissuer-provided token in the `details` field that is needed to initiate the PIN\ncollection flow on the iOS device.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CARD_EXPIRED",
          "description": "The card issuer declined the request because the card is expired.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_EXPIRATION",
          "description": "The expiration date for the payment card is invalid. For example,\nit indicates a date in the past.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_EXPIRATION_YEAR",
          "description": "The expiration year for the payment card is invalid. For example,\nit indicates a year in the past or contains invalid characters.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_EXPIRATION_DATE",
          "description": "The expiration date for the payment card is invalid. For example,\nit contains invalid characters.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_CARD_BRAND",
          "description": "The credit card provided is not from a supported issuer.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "UNSUPPORTED_ENTRY_METHOD",
          "description": "The entry method for the credit card (swipe, dip, tap) is not supported.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_ENCRYPTED_CARD",
          "description": "The encrypted card information is invalid.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_CARD",
          "description": "The credit card cannot be validated based on the provided details.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "PAYMENT_AMOUNT_MISMATCH",
          "description": "The payment was declined because there was a payment amount mismatch.\nThe money amount Square was expecting does not match the amount provided.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "GENERIC_DECLINE",
          "description": "Square received a decline without any additional information.\nIf the payment information seems correct, the buyer can contact their\nissuer to ask for more information.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CVV_FAILURE",
          "description": "The card issuer declined the request because the CVV value is invalid.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "ADDRESS_VERIFICATION_FAILURE",
          "description": "The card issuer declined the request because the postal code is invalid.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_ACCOUNT",
          "description": "The issuer was not able to locate the account on record.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CURRENCY_MISMATCH",
          "description": "The currency associated with the payment is not valid for the provided\nfunding source. For example, a gift card funded in USD cannot be used to process\npayments in GBP.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INSUFFICIENT_FUNDS",
          "description": "The funding source has insufficient funds to cover the payment.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INSUFFICIENT_PERMISSIONS",
          "description": "The Square account does not have the permissions to accept\nthis payment. For example, Square may limit which merchants are\nallowed to receive gift card payments.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CARDHOLDER_INSUFFICIENT_PERMISSIONS",
          "description": "The card issuer has declined the transaction due to restrictions on where the card can be used.\nFor example, a gift card is limited to a single merchant.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_LOCATION",
          "description": "The Square account cannot take payments in the specified region.\nA Square account can take payments only from the region where the account was created.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "TRANSACTION_LIMIT",
          "description": "The card issuer has determined the payment amount is either too high or too low.\nThe API returns the error code mostly for credit cards (for example, the card reached\nthe credit limit). However, sometimes the issuer bank can indicate the error for debit\nor prepaid cards (for example, card has insufficient funds).",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "VOICE_FAILURE",
          "description": "The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "PAN_FAILURE",
          "description": "The specified card number is invalid. For example, it is of\nincorrect length or is incorrectly formatted.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "EXPIRATION_FAILURE",
          "description": "The card expiration date is either invalid or indicates that the\ncard is expired.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CARD_NOT_SUPPORTED",
          "description": "The card is not supported either in the geographic region or by\nthe [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_PIN",
          "description": "The card issuer declined the request because the PIN is invalid.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "MISSING_PIN",
          "description": "The payment is missing a required PIN.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "MISSING_ACCOUNT_TYPE",
          "description": "The payment is missing a required ACCOUNT_TYPE parameter.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_POSTAL_CODE",
          "description": "The postal code is incorrectly formatted.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "INVALID_FEES",
          "description": "The app_fee_money on a payment is too high.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED",
          "description": "The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "PAYMENT_LIMIT_EXCEEDED",
          "description": "Square declined the request because the payment amount exceeded the processing limit for this merchant.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "GIFT_CARD_AVAILABLE_AMOUNT",
          "description": "When a Gift Card is a payment source, you can allow taking a partial payment\nby adding the `accept_partial_authorization` parameter in the request.\nHowever, taking such a partial payment does not work if your request also includes\n`tip_money`, `app_fee_money`, or both. Square declines such payments and returns\nthe `GIFT_CARD_AVAILABLE_AMOUNT` error.\nFor more information, see\n[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "ACCOUNT_UNUSABLE",
          "description": "The account provided cannot carry out transactions.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "BUYER_REFUSED_PAYMENT",
          "description": "Bank account rejected or was not authorized for the payment.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "DELAYED_TRANSACTION_EXPIRED",
          "description": "The application tried to update a delayed-capture payment that has expired.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "DELAYED_TRANSACTION_CANCELED",
          "description": "The application tried to cancel a delayed-capture payment that was already cancelled.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "DELAYED_TRANSACTION_CAPTURED",
          "description": "The application tried to capture a delayed-capture payment that was already captured.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "DELAYED_TRANSACTION_FAILED",
          "description": "The application tried to update a delayed-capture payment that failed.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_TOKEN_EXPIRED",
          "description": "The provided card token (nonce) has expired.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_TOKEN_USED",
          "description": "The provided card token (nonce) was already used to process the payment or refund.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "AMOUNT_TOO_HIGH",
          "description": "The requested payment amount is too high for the provided payment source.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_INSTRUMENT_TYPE",
          "description": "The API request references an unsupported instrument type.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "REFUND_AMOUNT_INVALID",
          "description": "The requested refund amount exceeds the amount available to refund.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "REFUND_ALREADY_PENDING",
          "description": "The payment already has a pending refund.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "PAYMENT_NOT_REFUNDABLE",
          "description": "The payment is not refundable. For example, the payment is too old to be refunded.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE",
          "description": "The payment is not refundable because it has been disputed.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "REFUND_DECLINED",
          "description": "Request failed - The card issuer declined the refund.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "INSUFFICIENT_PERMISSIONS_FOR_REFUND",
          "description": "The Square account does not have the permissions to process this refund.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "INVALID_CARD_DATA",
          "description": "Generic error - the provided card data is invalid.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "SOURCE_USED",
          "description": "The provided source id was already used to create a card.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "SOURCE_EXPIRED",
          "description": "The provided source id has expired.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_LOYALTY_REWARD_TIER",
          "description": "The referenced loyalty program reward tier is not supported.\nThis could happen if the reward tier created in a first party\napplication is incompatible with the Loyalty API.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "LOCATION_MISMATCH",
          "description": "Generic error - the given location does not matching what is expected.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "IDEMPOTENCY_KEY_REUSED",
          "description": "The provided idempotency key has already been used.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNEXPECTED_VALUE",
          "description": "General error - the value provided was unexpected.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "SANDBOX_NOT_SUPPORTED",
          "description": "The API request is not supported in sandbox.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_EMAIL_ADDRESS",
          "description": "The provided email address is invalid.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_PHONE_NUMBER",
          "description": "The provided phone number is invalid.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CHECKOUT_EXPIRED",
          "description": "The provided checkout URL has expired.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "BAD_CERTIFICATE",
          "description": "Bad certificate.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "INVALID_SQUARE_VERSION_FORMAT",
          "description": "The provided Square-Version is incorrectly formatted.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "API_VERSION_INCOMPATIBLE",
          "description": "The provided Square-Version is incompatible with the requested action.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_PRESENCE_REQUIRED",
          "description": "The transaction requires that a card be present.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_SOURCE_TYPE",
          "description": "The API request references an unsupported source type.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CARD_MISMATCH",
          "description": "The provided card does not match what is expected.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "PLAID_ERROR",
          "description": "Generic plaid error",
          "error-category": "EXTERNAL_VENDOR_ERROR"
        },
        {
          "name": "PLAID_ERROR_ITEM_LOGIN_REQUIRED",
          "description": "Plaid error - ITEM_LOGIN_REQUIRED",
          "error-category": "EXTERNAL_VENDOR_ERROR"
        },
        {
          "name": "PLAID_ERROR_RATE_LIMIT",
          "description": "Plaid error - RATE_LIMIT",
          "error-category": "EXTERNAL_VENDOR_ERROR"
        },
        {
          "name": "CARD_DECLINED",
          "description": "The card was declined.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "VERIFY_CVV_FAILURE",
          "description": "The CVV could not be verified.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "VERIFY_AVS_FAILURE",
          "description": "The AVS could not be verified.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CARD_DECLINED_CALL_ISSUER",
          "description": "The payment card was declined with a request\nfor the card holder to call the issuer.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CARD_DECLINED_VERIFICATION_REQUIRED",
          "description": "The payment card was declined with a request\nfor additional verification.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "BAD_EXPIRATION",
          "description": "The card expiration date is either missing or\nincorrectly formatted.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "CHIP_INSERTION_REQUIRED",
          "description": "The card issuer requires that the card be read\nusing a chip reader.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "ALLOWABLE_PIN_TRIES_EXCEEDED",
          "description": "The card has exhausted its available pin entry\nretries set by the card issuer. Resolving the error typically requires the\ncard holder to contact the card issuer.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "RESERVATION_DECLINED",
          "description": "The card issuer declined the refund.",
          "error-category": "REFUND_ERROR"
        },
        {
          "name": "UNKNOWN_BODY_PARAMETER",
          "description": "The body parameter is not recognized by the requested endpoint.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "NOT_FOUND",
          "description": "Not Found - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND",
          "description": "Square could not find the associated Apple Pay certificate.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "METHOD_NOT_ALLOWED",
          "description": "Method Not Allowed - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "NOT_ACCEPTABLE",
          "description": "Not Acceptable - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "REQUEST_TIMEOUT",
          "description": "Request Timeout - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "CONFLICT",
          "description": "Conflict - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "GONE",
          "description": "The target resource is no longer available and this\ncondition is likely to be permanent.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "REQUEST_ENTITY_TOO_LARGE",
          "description": "Request Entity Too Large - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNSUPPORTED_MEDIA_TYPE",
          "description": "Unsupported Media Type - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "UNPROCESSABLE_ENTITY",
          "description": "Unprocessable Entity - a general error occurred.",
          "error-category": "INVALID_REQUEST_ERROR"
        },
        {
          "name": "RATE_LIMITED",
          "description": "Rate Limited - a general error occurred.",
          "error-category": "RATE_LIMIT_ERROR"
        },
        {
          "name": "NOT_IMPLEMENTED",
          "description": "Not Implemented - a general error occurred.",
          "error-category": "API_ERROR"
        },
        {
          "name": "BAD_GATEWAY",
          "description": "Bad Gateway - a general error occurred.",
          "error-category": "API_ERROR"
        },
        {
          "name": "SERVICE_UNAVAILABLE",
          "description": "Service Unavailable - a general error occurred.",
          "error-category": "API_ERROR"
        },
        {
          "name": "TEMPORARY_ERROR",
          "description": "A temporary internal error occurred. You can safely retry your call\nusing the same idempotency key.",
          "error-category": "PAYMENT_METHOD_ERROR"
        },
        {
          "name": "GATEWAY_TIMEOUT",
          "description": "Gateway Timeout - a general error occurred.",
          "error-category": "API_ERROR"
        }
      ],
      "description": "Indicates the specific error that occurred during a request to a\nSquare API.",
      "x-release-status": "PUBLIC"
    },
    "LoyaltyPromotion": {
      "type": "object",
      "description": "Represents a promotion for a [loyalty program](entity:LoyaltyProgram). Loyalty promotions enable buyers\nto earn extra points on top of those earned from the base program.\n\nA loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.",
      "x-release-status": "PUBLIC",
      "required": [
        "name",
        "incentive",
        "available_time"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The Square-assigned ID of the promotion.",
          "minLength": 1,
          "maxLength": 255,
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "The name of the promotion.",
          "minLength": 1,
          "maxLength": 70
        },
        "incentive": {
          "$ref": "#/$defs/LoyaltyPromotionIncentive",
          "description": "The points incentive for the promotion. This field defines whether promotion points\nare earned by multiplying base program points or by adding a specified number of points."
        },
        "available_time": {
          "$ref": "#/$defs/LoyaltyPromotionAvailableTimeData",
          "description": "The scheduling information that defines when purchases can qualify to earn points from an `ACTIVE` promotion."
        },
        "trigger_limit": {
          "$ref": "#/$defs/LoyaltyPromotionTriggerLimit",
          "description": "The number of times a buyer can earn promotion points during a specified interval.\nIf not specified, buyers can trigger the promotion an unlimited number of times."
        },
        "status": {
          "$ref": "#/$defs/LoyaltyPromotionStatus",
          "description": "The current status of the promotion.\nSee [LoyaltyPromotionStatus](#type-loyaltypromotionstatus) for possible values",
          "readOnly": true
        },
        "created_at": {
          "type": "string",
          "description": "The timestamp of when the promotion was created, in RFC 3339 format.",
          "readOnly": true
        },
        "canceled_at": {
          "type": "string",
          "description": "The timestamp of when the promotion was canceled, in RFC 3339 format.",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "description": "The timestamp when the promotion was last updated, in RFC 3339 format.",
          "readOnly": true
        },
        "loyalty_program_id": {
          "type": "string",
          "description": "The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion.",
          "readOnly": true
        },
        "minimum_spend_amount_money": {
          "$ref": "#/$defs/Money",
          "description": "The minimum purchase amount required to earn promotion points. If specified, this amount is positive."
        },
        "qualifying_item_variation_ids": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one of these items to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both."
        },
        "qualifying_category_ids": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified,\nthe purchase must include at least one item from one of these categories to qualify for the promotion.\n\nThis option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.\nWith `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.\n\nYou can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both."
        }
      }
    },
    "LoyaltyPromotionAvailableTimeData": {
      "type": "object",
      "description": "Represents scheduling information that determines when purchases can qualify to earn points\nfrom a [loyalty promotion](entity:LoyaltyPromotion).",
      "x-release-status": "PUBLIC",
      "required": [
        "time_periods"
      ],
      "properties": {
        "start_date": {
          "type": "string",
          "description": "The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`.",
          "readOnly": true
        },
        "end_date": {
          "type": "string",
          "description": "The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field\nbased on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion\nremains available until it is canceled.",
          "readOnly": true
        },
        "time_periods": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)\n(`VEVENT`). Each event represents an available time period per day or days of the week. \nA day can have a maximum of one available time period.\n\nOnly `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and\ntimestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,\nan end date (using the `UNTIL` keyword), or both. For more information, see\n[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).\n\nNote that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request\nbut are always included in the response."
        }
      }
    },
    "LoyaltyPromotionIncentive": {
      "type": "object",
      "description": "Represents how points for a [loyalty promotion](entity:LoyaltyPromotion) are calculated,\neither by multiplying the points earned from the base program or by adding a specified number\nof points to the points earned from the base program.",
      "x-release-status": "PUBLIC",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/$defs/LoyaltyPromotionIncentiveType",
          "description": "The type of points incentive.\nSee [LoyaltyPromotionIncentiveType](#type-loyaltypromotionincentivetype) for possible values"
        },
        "points_multiplier_data": {
          "$ref": "#/$defs/LoyaltyPromotionIncentivePointsMultiplierData",
          "description": "Additional data for a `POINTS_MULTIPLIER` incentive type."
        },
        "points_addition_data": {
          "$ref": "#/$defs/LoyaltyPromotionIncentivePointsAdditionData",
          "description": "Additional data for a `POINTS_ADDITION` incentive type."
        }
      }
    },
    "LoyaltyPromotionIncentivePointsAdditionData": {
      "type": "object",
      "description": "Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).",
      "x-release-status": "PUBLIC",
      "required": [
        "points_addition"
      ],
      "properties": {
        "points_addition": {
          "type": "integer",
          "description": "The number of additional points to earn each time the promotion is triggered. For example,\nsuppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also\nqualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer\nearns a total of 8 points (5 program points + 3 promotion points = 8 points).",
          "minimum": 1
        }
      }
    },
    "LoyaltyPromotionIncentivePointsMultiplierData": {
      "type": "object",
      "description": "Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](entity:LoyaltyPromotionIncentive).",
      "x-release-status": "PUBLIC",
      "properties": {
        "points_multiplier": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The multiplier used to calculate the number of points earned each time the promotion\nis triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program.\nIf the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier`\nof 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points).\n\nDEPRECATED at version 2023-08-16. Replaced by the `multiplier` field.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) The `multiplier` field.\n- This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.",
          "minimum": 2,
          "maximum": 10,
          "x-release-status": "DEPRECATED"
        },
        "multiplier": {
          "type": [
            "string",
            "null"
          ],
          "description": "The multiplier used to calculate the number of points earned each time the promotion is triggered,\nspecified as a string representation of a decimal. Square supports multipliers up to 10x, with three\npoint precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the\nbase loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a\n`multiplier` of \"1.5\", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points).\nFractional points are dropped.\n\nOne of the following is required when specifying a points multiplier:\n- (Recommended) This `multiplier` field.\n- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`\nwith the equivalent value.",
          "maxLength": 5
        }
      }
    },
    "LoyaltyPromotionIncentiveType": {
      "type": "string",
      "enum": [
        "POINTS_MULTIPLIER",
        "POINTS_ADDITION"
      ],
      "x-enum-elements": [
        {
          "name": "POINTS_MULTIPLIER",
          "description": "Multiply the number of points earned from the base loyalty program.\nFor example, \"Earn double points.\""
        },
        {
          "name": "POINTS_ADDITION",
          "description": "Add a specified number of points to those earned from the base loyalty program.\nFor example, \"Earn 10 additional points.\""
        }
      ],
      "description": "Indicates the type of points incentive for a [loyalty promotion](entity:LoyaltyPromotion),\nwhich is used to determine how buyers can earn points from the promotion.",
      "x-release-status": "PUBLIC"
    },
    "LoyaltyPromotionStatus": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "ENDED",
        "CANCELED",
        "SCHEDULED"
      ],
      "x-enum-elements": [
        {
          "name": "ACTIVE",
          "description": "The loyalty promotion is currently active. Buyers can earn points for purchases\nthat meet the promotion conditions, such as the promotion's `available_time`."
        },
        {
          "name": "ENDED",
          "description": "The loyalty promotion has ended because the specified `end_date` was reached.\n`ENDED` is a terminal status."
        },
        {
          "name": "CANCELED",
          "description": "The loyalty promotion was canceled. `CANCELED` is a terminal status."
        },
        {
          "name": "SCHEDULED",
          "description": "The loyalty promotion is scheduled to start in the future. Square changes the\npromotion status to `ACTIVE` when the `start_date` is reached."
        }
      ],
      "description": "Indicates the status of a [loyalty promotion](entity:LoyaltyPromotion).",
      "x-release-status": "PUBLIC"
    },
    "LoyaltyPromotionTriggerLimit": {
      "type": "object",
      "description": "Represents the number of times a buyer can earn points during a [loyalty promotion](entity:LoyaltyPromotion).\nIf this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during\nthe time that the promotion is available.\n\nA purchase that is disqualified from earning points because of this limit might qualify for another active promotion.",
      "x-release-status": "PUBLIC",
      "required": [
        "times"
      ],
      "properties": {
        "times": {
          "type": "integer",
          "description": "The maximum number of times a buyer can trigger the promotion during the specified `interval`.",
          "minimum": 1,
          "maximum": 30
        },
        "interval": {
          "$ref": "#/$defs/LoyaltyPromotionTriggerLimitInterval",
          "description": "The time period the limit applies to.\nSee [LoyaltyPromotionTriggerLimitInterval](#type-loyaltypromotiontriggerlimitinterval) for possible values"
        }
      }
    },
    "LoyaltyPromotionTriggerLimitInterval": {
      "type": "string",
      "enum": [
        "ALL_TIME",
        "DAY"
      ],
      "x-enum-elements": [
        {
          "name": "ALL_TIME",
          "description": "The limit applies to the entire time that the promotion is active. For example, if `times`\nis set to 1 and `time_period` is set to `ALL_TIME`, a buyer can earn promotion points a maximum\nof one time during the promotion."
        },
        {
          "name": "DAY",
          "description": "The limit applies per day, according to the `available_time` schedule specified for the promotion.\nFor example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion\na maximum of once per day."
        }
      ],
      "description": "Indicates the time period that the [trigger limit](entity:LoyaltyPromotionTriggerLimit) applies to,\nwhich is used to determine the number of times a buyer can earn points for a [loyalty promotion](entity:LoyaltyPromotion).",
      "x-release-status": "PUBLIC"
    },
    "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.",
      "x-release-status": "PUBLIC",
      "properties": {
        "amount": {
          "type": [
            "integer",
            "null"
          ],
          "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.",
          "format": "int64"
        },
        "currency": {
          "$ref": "#/$defs/Currency",
          "description": "The type of currency, in __ISO 4217 format__. For example, the currency\ncode for US dollars is `USD`.\n\nSee [Currency](entity:Currency) for possible values.\nSee [Currency](#type-currency) for possible values"
        }
      }
    }
  }
}