| 1 |
<?php |
| 2 |
|
| 3 |
declare(strict_types=1); |
| 4 |
|
| 5 |
namespace Square\Legacy\Models; |
| 6 |
|
| 7 |
/** |
| 8 |
* Indicates the specific error that occurred during a request to a |
| 9 |
* Square API. |
| 10 |
*/ |
| 11 |
class ErrorCode |
| 12 |
{ |
| 13 |
/** |
| 14 |
* A general server error occurred. |
| 15 |
*/ |
| 16 |
public const INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR'; |
| 17 |
|
| 18 |
/** |
| 19 |
* A general authorization error occurred. |
| 20 |
*/ |
| 21 |
public const UNAUTHORIZED = 'UNAUTHORIZED'; |
| 22 |
|
| 23 |
/** |
| 24 |
* The provided access token has expired. |
| 25 |
*/ |
| 26 |
public const ACCESS_TOKEN_EXPIRED = 'ACCESS_TOKEN_EXPIRED'; |
| 27 |
|
| 28 |
/** |
| 29 |
* The provided access token has been revoked. |
| 30 |
*/ |
| 31 |
public const ACCESS_TOKEN_REVOKED = 'ACCESS_TOKEN_REVOKED'; |
| 32 |
|
| 33 |
/** |
| 34 |
* The provided client has been disabled. |
| 35 |
*/ |
| 36 |
public const CLIENT_DISABLED = 'CLIENT_DISABLED'; |
| 37 |
|
| 38 |
/** |
| 39 |
* A general access error occurred. |
| 40 |
*/ |
| 41 |
public const FORBIDDEN = 'FORBIDDEN'; |
| 42 |
|
| 43 |
/** |
| 44 |
* The provided access token does not have permission |
| 45 |
* to execute the requested action. |
| 46 |
*/ |
| 47 |
public const INSUFFICIENT_SCOPES = 'INSUFFICIENT_SCOPES'; |
| 48 |
|
| 49 |
/** |
| 50 |
* The calling application was disabled. |
| 51 |
*/ |
| 52 |
public const APPLICATION_DISABLED = 'APPLICATION_DISABLED'; |
| 53 |
|
| 54 |
/** |
| 55 |
* The calling application was created prior to |
| 56 |
* 2016-03-30 and is not compatible with v2 Square API calls. |
| 57 |
*/ |
| 58 |
public const V1_APPLICATION = 'V1_APPLICATION'; |
| 59 |
|
| 60 |
/** |
| 61 |
* The calling application is using an access token |
| 62 |
* created prior to 2016-03-30 and is not compatible with v2 Square API |
| 63 |
* calls. |
| 64 |
*/ |
| 65 |
public const V1_ACCESSTOKEN = 'V1_ACCESS_TOKEN'; |
| 66 |
|
| 67 |
/** |
| 68 |
* The location provided in the API call is not |
| 69 |
* enabled for credit card processing. |
| 70 |
*/ |
| 71 |
public const CARD_PROCESSING_NOT_ENABLED = 'CARD_PROCESSING_NOT_ENABLED'; |
| 72 |
|
| 73 |
/** |
| 74 |
* A required subscription was not found for the merchant |
| 75 |
*/ |
| 76 |
public const MERCHANT_SUBSCRIPTION_NOT_FOUND = 'MERCHANT_SUBSCRIPTION_NOT_FOUND'; |
| 77 |
|
| 78 |
/** |
| 79 |
* A general error occurred with the request. |
| 80 |
*/ |
| 81 |
public const BAD_REQUEST = 'BAD_REQUEST'; |
| 82 |
|
| 83 |
/** |
| 84 |
* The request is missing a required path, query, or |
| 85 |
* body parameter. |
| 86 |
*/ |
| 87 |
public const MISSING_REQUIRED_PARAMETER = 'MISSING_REQUIRED_PARAMETER'; |
| 88 |
|
| 89 |
/** |
| 90 |
* The value provided in the request is the wrong |
| 91 |
* type. For example, a string instead of an integer. |
| 92 |
*/ |
| 93 |
public const INCORRECT_TYPE = 'INCORRECT_TYPE'; |
| 94 |
|
| 95 |
/** |
| 96 |
* Formatting for the provided time value is |
| 97 |
* incorrect. |
| 98 |
*/ |
| 99 |
public const INVALID_TIME = 'INVALID_TIME'; |
| 100 |
|
| 101 |
/** |
| 102 |
* The time range provided in the request is invalid. |
| 103 |
* For example, the end time is before the start time. |
| 104 |
*/ |
| 105 |
public const INVALID_TIME_RANGE = 'INVALID_TIME_RANGE'; |
| 106 |
|
| 107 |
/** |
| 108 |
* The provided value is invalid. For example, |
| 109 |
* including `%` in a phone number. |
| 110 |
*/ |
| 111 |
public const INVALID_VALUE = 'INVALID_VALUE'; |
| 112 |
|
| 113 |
/** |
| 114 |
* The pagination cursor included in the request is |
| 115 |
* invalid. |
| 116 |
*/ |
| 117 |
public const INVALID_CURSOR = 'INVALID_CURSOR'; |
| 118 |
|
| 119 |
/** |
| 120 |
* The query parameters provided is invalid for the |
| 121 |
* requested endpoint. |
| 122 |
*/ |
| 123 |
public const UNKNOWN_QUERY_PARAMETER = 'UNKNOWN_QUERY_PARAMETER'; |
| 124 |
|
| 125 |
/** |
| 126 |
* One or more of the request parameters conflict with |
| 127 |
* each other. |
| 128 |
*/ |
| 129 |
public const CONFLICTING_PARAMETERS = 'CONFLICTING_PARAMETERS'; |
| 130 |
|
| 131 |
/** |
| 132 |
* The request body is not a JSON object. |
| 133 |
*/ |
| 134 |
public const EXPECTED_JSON_BODY = 'EXPECTED_JSON_BODY'; |
| 135 |
|
| 136 |
/** |
| 137 |
* The provided sort order is not a valid key. |
| 138 |
* Currently, sort order must be `ASC` or `DESC`. |
| 139 |
*/ |
| 140 |
public const INVALID_SORT_ORDER = 'INVALID_SORT_ORDER'; |
| 141 |
|
| 142 |
/** |
| 143 |
* The provided value does not match an expected |
| 144 |
* regular expression. |
| 145 |
*/ |
| 146 |
public const VALUE_REGEX_MISMATCH = 'VALUE_REGEX_MISMATCH'; |
| 147 |
|
| 148 |
/** |
| 149 |
* The provided string value is shorter than the |
| 150 |
* minimum length allowed. |
| 151 |
*/ |
| 152 |
public const VALUE_TOO_SHORT = 'VALUE_TOO_SHORT'; |
| 153 |
|
| 154 |
/** |
| 155 |
* The provided string value is longer than the |
| 156 |
* maximum length allowed. |
| 157 |
*/ |
| 158 |
public const VALUE_TOO_LONG = 'VALUE_TOO_LONG'; |
| 159 |
|
| 160 |
/** |
| 161 |
* The provided value is less than the supported |
| 162 |
* minimum. |
| 163 |
*/ |
| 164 |
public const VALUE_TOO_LOW = 'VALUE_TOO_LOW'; |
| 165 |
|
| 166 |
/** |
| 167 |
* The provided value is greater than the supported |
| 168 |
* maximum. |
| 169 |
*/ |
| 170 |
public const VALUE_TOO_HIGH = 'VALUE_TOO_HIGH'; |
| 171 |
|
| 172 |
/** |
| 173 |
* The provided value has a default (empty) value |
| 174 |
* such as a blank string. |
| 175 |
*/ |
| 176 |
public const VALUE_EMPTY = 'VALUE_EMPTY'; |
| 177 |
|
| 178 |
/** |
| 179 |
* The provided array has too many elements. |
| 180 |
*/ |
| 181 |
public const ARRAY_LENGTH_TOO_LONG = 'ARRAY_LENGTH_TOO_LONG'; |
| 182 |
|
| 183 |
/** |
| 184 |
* The provided array has too few elements. |
| 185 |
*/ |
| 186 |
public const ARRAY_LENGTH_TOO_SHORT = 'ARRAY_LENGTH_TOO_SHORT'; |
| 187 |
|
| 188 |
/** |
| 189 |
* The provided array is empty. |
| 190 |
*/ |
| 191 |
public const ARRAY_EMPTY = 'ARRAY_EMPTY'; |
| 192 |
|
| 193 |
/** |
| 194 |
* The endpoint expected the provided value to be a |
| 195 |
* boolean. |
| 196 |
*/ |
| 197 |
public const EXPECTED_BOOLEAN = 'EXPECTED_BOOLEAN'; |
| 198 |
|
| 199 |
/** |
| 200 |
* The endpoint expected the provided value to be an |
| 201 |
* integer. |
| 202 |
*/ |
| 203 |
public const EXPECTED_INTEGER = 'EXPECTED_INTEGER'; |
| 204 |
|
| 205 |
/** |
| 206 |
* The endpoint expected the provided value to be a |
| 207 |
* float. |
| 208 |
*/ |
| 209 |
public const EXPECTED_FLOAT = 'EXPECTED_FLOAT'; |
| 210 |
|
| 211 |
/** |
| 212 |
* The endpoint expected the provided value to be a |
| 213 |
* string. |
| 214 |
*/ |
| 215 |
public const EXPECTED_STRING = 'EXPECTED_STRING'; |
| 216 |
|
| 217 |
/** |
| 218 |
* The endpoint expected the provided value to be a |
| 219 |
* JSON object. |
| 220 |
*/ |
| 221 |
public const EXPECTED_OBJECT = 'EXPECTED_OBJECT'; |
| 222 |
|
| 223 |
/** |
| 224 |
* The endpoint expected the provided value to be an |
| 225 |
* array or list. |
| 226 |
*/ |
| 227 |
public const EXPECTED_ARRAY = 'EXPECTED_ARRAY'; |
| 228 |
|
| 229 |
/** |
| 230 |
* The endpoint expected the provided value to be a |
| 231 |
* map or associative array. |
| 232 |
*/ |
| 233 |
public const EXPECTED_MAP = 'EXPECTED_MAP'; |
| 234 |
|
| 235 |
/** |
| 236 |
* The endpoint expected the provided value to be an |
| 237 |
* array encoded in base64. |
| 238 |
*/ |
| 239 |
public const EXPECTED_BASE64_ENCODED_BYTE_ARRAY = 'EXPECTED_BASE64_ENCODED_BYTE_ARRAY'; |
| 240 |
|
| 241 |
/** |
| 242 |
* One or more objects in the array does not match the |
| 243 |
* array type. |
| 244 |
*/ |
| 245 |
public const INVALID_ARRAY_VALUE = 'INVALID_ARRAY_VALUE'; |
| 246 |
|
| 247 |
/** |
| 248 |
* The provided static string is not valid for the |
| 249 |
* field. |
| 250 |
*/ |
| 251 |
public const INVALID_ENUM_VALUE = 'INVALID_ENUM_VALUE'; |
| 252 |
|
| 253 |
/** |
| 254 |
* Invalid content type header. |
| 255 |
*/ |
| 256 |
public const INVALID_CONTENT_TYPE = 'INVALID_CONTENT_TYPE'; |
| 257 |
|
| 258 |
/** |
| 259 |
* Only relevant for applications created prior to |
| 260 |
* 2016-03-30. Indicates there was an error while parsing form values. |
| 261 |
*/ |
| 262 |
public const INVALID_FORM_VALUE = 'INVALID_FORM_VALUE'; |
| 263 |
|
| 264 |
/** |
| 265 |
* The provided customer id can't be found in the merchant's customers list. |
| 266 |
*/ |
| 267 |
public const CUSTOMER_NOT_FOUND = 'CUSTOMER_NOT_FOUND'; |
| 268 |
|
| 269 |
/** |
| 270 |
* A general error occurred. |
| 271 |
*/ |
| 272 |
public const ONE_INSTRUMENT_EXPECTED = 'ONE_INSTRUMENT_EXPECTED'; |
| 273 |
|
| 274 |
/** |
| 275 |
* A general error occurred. |
| 276 |
*/ |
| 277 |
public const NO_FIELDS_SET = 'NO_FIELDS_SET'; |
| 278 |
|
| 279 |
/** |
| 280 |
* Too many entries in the map field. |
| 281 |
*/ |
| 282 |
public const TOO_MANY_MAP_ENTRIES = 'TOO_MANY_MAP_ENTRIES'; |
| 283 |
|
| 284 |
/** |
| 285 |
* The length of one of the provided keys in the map is too short. |
| 286 |
*/ |
| 287 |
public const MAP_KEY_LENGTH_TOO_SHORT = 'MAP_KEY_LENGTH_TOO_SHORT'; |
| 288 |
|
| 289 |
/** |
| 290 |
* The length of one of the provided keys in the map is too long. |
| 291 |
*/ |
| 292 |
public const MAP_KEY_LENGTH_TOO_LONG = 'MAP_KEY_LENGTH_TOO_LONG'; |
| 293 |
|
| 294 |
/** |
| 295 |
* The provided customer does not have a recorded name. |
| 296 |
*/ |
| 297 |
public const CUSTOMER_MISSING_NAME = 'CUSTOMER_MISSING_NAME'; |
| 298 |
|
| 299 |
/** |
| 300 |
* The provided customer does not have a recorded email. |
| 301 |
*/ |
| 302 |
public const CUSTOMER_MISSING_EMAIL = 'CUSTOMER_MISSING_EMAIL'; |
| 303 |
|
| 304 |
/** |
| 305 |
* The subscription cannot be paused longer than the duration of the current phase. |
| 306 |
*/ |
| 307 |
public const INVALID_PAUSE_LENGTH = 'INVALID_PAUSE_LENGTH'; |
| 308 |
|
| 309 |
/** |
| 310 |
* The subscription cannot be paused/resumed on the given date. |
| 311 |
*/ |
| 312 |
public const INVALID_DATE = 'INVALID_DATE'; |
| 313 |
|
| 314 |
/** |
| 315 |
* The API request references an unsupported country. |
| 316 |
*/ |
| 317 |
public const UNSUPPORTED_COUNTRY = 'UNSUPPORTED_COUNTRY'; |
| 318 |
|
| 319 |
/** |
| 320 |
* The API request references an unsupported currency. |
| 321 |
*/ |
| 322 |
public const UNSUPPORTED_CURRENCY = 'UNSUPPORTED_CURRENCY'; |
| 323 |
|
| 324 |
/** |
| 325 |
* The payment was declined by the card issuer during an Apple Tap to Pay (TTP) |
| 326 |
* transaction with a request for the card's PIN. This code will be returned alongside |
| 327 |
* `CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an |
| 328 |
* issuer-provided token in the `details` field that is needed to initiate the PIN |
| 329 |
* collection flow on the iOS device. |
| 330 |
*/ |
| 331 |
public const APPLE_TTP_PIN_TOKEN = 'APPLE_TTP_PIN_TOKEN'; |
| 332 |
|
| 333 |
/** |
| 334 |
* The card issuer declined the request because the card is expired. |
| 335 |
*/ |
| 336 |
public const CARD_EXPIRED = 'CARD_EXPIRED'; |
| 337 |
|
| 338 |
/** |
| 339 |
* The expiration date for the payment card is invalid. For example, |
| 340 |
* it indicates a date in the past. |
| 341 |
*/ |
| 342 |
public const INVALID_EXPIRATION = 'INVALID_EXPIRATION'; |
| 343 |
|
| 344 |
/** |
| 345 |
* The expiration year for the payment card is invalid. For example, |
| 346 |
* it indicates a year in the past or contains invalid characters. |
| 347 |
*/ |
| 348 |
public const INVALID_EXPIRATION_YEAR = 'INVALID_EXPIRATION_YEAR'; |
| 349 |
|
| 350 |
/** |
| 351 |
* The expiration date for the payment card is invalid. For example, |
| 352 |
* it contains invalid characters. |
| 353 |
*/ |
| 354 |
public const INVALID_EXPIRATION_DATE = 'INVALID_EXPIRATION_DATE'; |
| 355 |
|
| 356 |
/** |
| 357 |
* The credit card provided is not from a supported issuer. |
| 358 |
*/ |
| 359 |
public const UNSUPPORTED_CARD_BRAND = 'UNSUPPORTED_CARD_BRAND'; |
| 360 |
|
| 361 |
/** |
| 362 |
* The entry method for the credit card (swipe, dip, tap) is not supported. |
| 363 |
*/ |
| 364 |
public const UNSUPPORTED_ENTRY_METHOD = 'UNSUPPORTED_ENTRY_METHOD'; |
| 365 |
|
| 366 |
/** |
| 367 |
* The encrypted card information is invalid. |
| 368 |
*/ |
| 369 |
public const INVALID_ENCRYPTED_CARD = 'INVALID_ENCRYPTED_CARD'; |
| 370 |
|
| 371 |
/** |
| 372 |
* The credit card cannot be validated based on the provided details. |
| 373 |
*/ |
| 374 |
public const INVALID_CARD = 'INVALID_CARD'; |
| 375 |
|
| 376 |
/** |
| 377 |
* The payment was declined because there was a payment amount mismatch. |
| 378 |
* The money amount Square was expecting does not match the amount provided. |
| 379 |
*/ |
| 380 |
public const PAYMENT_AMOUNT_MISMATCH = 'PAYMENT_AMOUNT_MISMATCH'; |
| 381 |
|
| 382 |
/** |
| 383 |
* Square received a decline without any additional information. |
| 384 |
* If the payment information seems correct, the buyer can contact their |
| 385 |
* issuer to ask for more information. |
| 386 |
*/ |
| 387 |
public const GENERIC_DECLINE = 'GENERIC_DECLINE'; |
| 388 |
|
| 389 |
/** |
| 390 |
* The card issuer declined the request because the CVV value is invalid. |
| 391 |
*/ |
| 392 |
public const CVV_FAILURE = 'CVV_FAILURE'; |
| 393 |
|
| 394 |
/** |
| 395 |
* The card issuer declined the request because the postal code is invalid. |
| 396 |
*/ |
| 397 |
public const ADDRESS_VERIFICATION_FAILURE = 'ADDRESS_VERIFICATION_FAILURE'; |
| 398 |
|
| 399 |
/** |
| 400 |
* The issuer was not able to locate the account on record. |
| 401 |
*/ |
| 402 |
public const INVALID_ACCOUNT = 'INVALID_ACCOUNT'; |
| 403 |
|
| 404 |
/** |
| 405 |
* The currency associated with the payment is not valid for the provided |
| 406 |
* funding source. For example, a gift card funded in USD cannot be used to process |
| 407 |
* payments in GBP. |
| 408 |
*/ |
| 409 |
public const CURRENCY_MISMATCH = 'CURRENCY_MISMATCH'; |
| 410 |
|
| 411 |
/** |
| 412 |
* The funding source has insufficient funds to cover the payment. |
| 413 |
*/ |
| 414 |
public const INSUFFICIENT_FUNDS = 'INSUFFICIENT_FUNDS'; |
| 415 |
|
| 416 |
/** |
| 417 |
* The Square account does not have the permissions to accept |
| 418 |
* this payment. For example, Square may limit which merchants are |
| 419 |
* allowed to receive gift card payments. |
| 420 |
*/ |
| 421 |
public const INSUFFICIENT_PERMISSIONS = 'INSUFFICIENT_PERMISSIONS'; |
| 422 |
|
| 423 |
/** |
| 424 |
* The card issuer has declined the transaction due to restrictions on where the card can be used. |
| 425 |
* For example, a gift card is limited to a single merchant. |
| 426 |
*/ |
| 427 |
public const CARDHOLDER_INSUFFICIENT_PERMISSIONS = 'CARDHOLDER_INSUFFICIENT_PERMISSIONS'; |
| 428 |
|
| 429 |
/** |
| 430 |
* The Square account cannot take payments in the specified region. |
| 431 |
* A Square account can take payments only from the region where the account was created. |
| 432 |
*/ |
| 433 |
public const INVALID_LOCATION = 'INVALID_LOCATION'; |
| 434 |
|
| 435 |
/** |
| 436 |
* The card issuer has determined the payment amount is either too high or too low. |
| 437 |
* The API returns the error code mostly for credit cards (for example, the card reached |
| 438 |
* the credit limit). However, sometimes the issuer bank can indicate the error for debit |
| 439 |
* or prepaid cards (for example, card has insufficient funds). |
| 440 |
*/ |
| 441 |
public const TRANSACTION_LIMIT = 'TRANSACTION_LIMIT'; |
| 442 |
|
| 443 |
/** |
| 444 |
* The card issuer declined the request because the issuer requires voice authorization from the |
| 445 |
* cardholder. The seller should ask the customer to contact the card issuing bank to authorize the |
| 446 |
* payment. |
| 447 |
*/ |
| 448 |
public const VOICE_FAILURE = 'VOICE_FAILURE'; |
| 449 |
|
| 450 |
/** |
| 451 |
* The specified card number is invalid. For example, it is of |
| 452 |
* incorrect length or is incorrectly formatted. |
| 453 |
*/ |
| 454 |
public const PAN_FAILURE = 'PAN_FAILURE'; |
| 455 |
|
| 456 |
/** |
| 457 |
* The card expiration date is either invalid or indicates that the |
| 458 |
* card is expired. |
| 459 |
*/ |
| 460 |
public const EXPIRATION_FAILURE = 'EXPIRATION_FAILURE'; |
| 461 |
|
| 462 |
/** |
| 463 |
* The card is not supported either in the geographic region or by |
| 464 |
* the [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant- |
| 465 |
* category-code) (MCC). |
| 466 |
*/ |
| 467 |
public const CARD_NOT_SUPPORTED = 'CARD_NOT_SUPPORTED'; |
| 468 |
|
| 469 |
/** |
| 470 |
* The card issuer declined the request because the PIN is invalid. |
| 471 |
*/ |
| 472 |
public const INVALID_PIN = 'INVALID_PIN'; |
| 473 |
|
| 474 |
/** |
| 475 |
* The payment is missing a required PIN. |
| 476 |
*/ |
| 477 |
public const MISSING_PIN = 'MISSING_PIN'; |
| 478 |
|
| 479 |
/** |
| 480 |
* The payment is missing a required ACCOUNT_TYPE parameter. |
| 481 |
*/ |
| 482 |
public const MISSING_ACCOUNT_TYPE = 'MISSING_ACCOUNT_TYPE'; |
| 483 |
|
| 484 |
/** |
| 485 |
* The postal code is incorrectly formatted. |
| 486 |
*/ |
| 487 |
public const INVALID_POSTAL_CODE = 'INVALID_POSTAL_CODE'; |
| 488 |
|
| 489 |
/** |
| 490 |
* The app_fee_money on a payment is too high. |
| 491 |
*/ |
| 492 |
public const INVALID_FEES = 'INVALID_FEES'; |
| 493 |
|
| 494 |
/** |
| 495 |
* The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number |
| 496 |
* are declined. |
| 497 |
*/ |
| 498 |
public const MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED = 'MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED'; |
| 499 |
|
| 500 |
/** |
| 501 |
* Square declined the request because the payment amount exceeded the processing limit for this |
| 502 |
* merchant. |
| 503 |
*/ |
| 504 |
public const PAYMENT_LIMIT_EXCEEDED = 'PAYMENT_LIMIT_EXCEEDED'; |
| 505 |
|
| 506 |
/** |
| 507 |
* When a Gift Card is a payment source, you can allow taking a partial payment |
| 508 |
* by adding the `accept_partial_authorization` parameter in the request. |
| 509 |
* However, taking such a partial payment does not work if your request also includes |
| 510 |
* `tip_money`, `app_fee_money`, or both. Square declines such payments and returns |
| 511 |
* the `GIFT_CARD_AVAILABLE_AMOUNT` error. |
| 512 |
* For more information, see |
| 513 |
* [CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments- |
| 514 |
* api/error-codes#createpayment-errors-additional-information). |
| 515 |
*/ |
| 516 |
public const GIFT_CARD_AVAILABLE_AMOUNT = 'GIFT_CARD_AVAILABLE_AMOUNT'; |
| 517 |
|
| 518 |
/** |
| 519 |
* The account provided cannot carry out transactions. |
| 520 |
*/ |
| 521 |
public const ACCOUNT_UNUSABLE = 'ACCOUNT_UNUSABLE'; |
| 522 |
|
| 523 |
/** |
| 524 |
* Bank account rejected or was not authorized for the payment. |
| 525 |
*/ |
| 526 |
public const BUYER_REFUSED_PAYMENT = 'BUYER_REFUSED_PAYMENT'; |
| 527 |
|
| 528 |
/** |
| 529 |
* The application tried to update a delayed-capture payment that has expired. |
| 530 |
*/ |
| 531 |
public const DELAYED_TRANSACTION_EXPIRED = 'DELAYED_TRANSACTION_EXPIRED'; |
| 532 |
|
| 533 |
/** |
| 534 |
* The application tried to cancel a delayed-capture payment that was already cancelled. |
| 535 |
*/ |
| 536 |
public const DELAYED_TRANSACTION_CANCELED = 'DELAYED_TRANSACTION_CANCELED'; |
| 537 |
|
| 538 |
/** |
| 539 |
* The application tried to capture a delayed-capture payment that was already captured. |
| 540 |
*/ |
| 541 |
public const DELAYED_TRANSACTION_CAPTURED = 'DELAYED_TRANSACTION_CAPTURED'; |
| 542 |
|
| 543 |
/** |
| 544 |
* The application tried to update a delayed-capture payment that failed. |
| 545 |
*/ |
| 546 |
public const DELAYED_TRANSACTION_FAILED = 'DELAYED_TRANSACTION_FAILED'; |
| 547 |
|
| 548 |
/** |
| 549 |
* The provided card token (nonce) has expired. |
| 550 |
*/ |
| 551 |
public const CARD_TOKEN_EXPIRED = 'CARD_TOKEN_EXPIRED'; |
| 552 |
|
| 553 |
/** |
| 554 |
* The provided card token (nonce) was already used to process the payment or refund. |
| 555 |
*/ |
| 556 |
public const CARD_TOKEN_USED = 'CARD_TOKEN_USED'; |
| 557 |
|
| 558 |
/** |
| 559 |
* The requested payment amount is too high for the provided payment source. |
| 560 |
*/ |
| 561 |
public const AMOUNT_TOO_HIGH = 'AMOUNT_TOO_HIGH'; |
| 562 |
|
| 563 |
/** |
| 564 |
* The API request references an unsupported instrument type. |
| 565 |
*/ |
| 566 |
public const UNSUPPORTED_INSTRUMENT_TYPE = 'UNSUPPORTED_INSTRUMENT_TYPE'; |
| 567 |
|
| 568 |
/** |
| 569 |
* The requested refund amount exceeds the amount available to refund. |
| 570 |
*/ |
| 571 |
public const REFUND_AMOUNT_INVALID = 'REFUND_AMOUNT_INVALID'; |
| 572 |
|
| 573 |
/** |
| 574 |
* The payment already has a pending refund. |
| 575 |
*/ |
| 576 |
public const REFUND_ALREADY_PENDING = 'REFUND_ALREADY_PENDING'; |
| 577 |
|
| 578 |
/** |
| 579 |
* The payment is not refundable. For example, the payment is too old to be refunded. |
| 580 |
*/ |
| 581 |
public const PAYMENT_NOT_REFUNDABLE = 'PAYMENT_NOT_REFUNDABLE'; |
| 582 |
|
| 583 |
/** |
| 584 |
* The payment is not refundable because it has been disputed. |
| 585 |
*/ |
| 586 |
public const PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE = 'PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE'; |
| 587 |
|
| 588 |
/** |
| 589 |
* Request failed - The card issuer declined the refund. |
| 590 |
*/ |
| 591 |
public const REFUND_DECLINED = 'REFUND_DECLINED'; |
| 592 |
|
| 593 |
/** |
| 594 |
* The Square account does not have the permissions to process this refund. |
| 595 |
*/ |
| 596 |
public const INSUFFICIENT_PERMISSIONS_FOR_REFUND = 'INSUFFICIENT_PERMISSIONS_FOR_REFUND'; |
| 597 |
|
| 598 |
/** |
| 599 |
* Generic error - the provided card data is invalid. |
| 600 |
*/ |
| 601 |
public const INVALID_CARD_DATA = 'INVALID_CARD_DATA'; |
| 602 |
|
| 603 |
/** |
| 604 |
* The provided source id was already used to create a card. |
| 605 |
*/ |
| 606 |
public const SOURCE_USED = 'SOURCE_USED'; |
| 607 |
|
| 608 |
/** |
| 609 |
* The provided source id has expired. |
| 610 |
*/ |
| 611 |
public const SOURCE_EXPIRED = 'SOURCE_EXPIRED'; |
| 612 |
|
| 613 |
/** |
| 614 |
* The referenced loyalty program reward tier is not supported. |
| 615 |
* This could happen if the reward tier created in a first party |
| 616 |
* application is incompatible with the Loyalty API. |
| 617 |
*/ |
| 618 |
public const UNSUPPORTED_LOYALTY_REWARD_TIER = 'UNSUPPORTED_LOYALTY_REWARD_TIER'; |
| 619 |
|
| 620 |
/** |
| 621 |
* Generic error - the given location does not matching what is expected. |
| 622 |
*/ |
| 623 |
public const LOCATION_MISMATCH = 'LOCATION_MISMATCH'; |
| 624 |
|
| 625 |
/** |
| 626 |
* The provided idempotency key has already been used. |
| 627 |
*/ |
| 628 |
public const IDEMPOTENCY_KEY_REUSED = 'IDEMPOTENCY_KEY_REUSED'; |
| 629 |
|
| 630 |
/** |
| 631 |
* General error - the value provided was unexpected. |
| 632 |
*/ |
| 633 |
public const UNEXPECTED_VALUE = 'UNEXPECTED_VALUE'; |
| 634 |
|
| 635 |
/** |
| 636 |
* The API request is not supported in sandbox. |
| 637 |
*/ |
| 638 |
public const SANDBOX_NOT_SUPPORTED = 'SANDBOX_NOT_SUPPORTED'; |
| 639 |
|
| 640 |
/** |
| 641 |
* The provided email address is invalid. |
| 642 |
*/ |
| 643 |
public const INVALID_EMAIL_ADDRESS = 'INVALID_EMAIL_ADDRESS'; |
| 644 |
|
| 645 |
/** |
| 646 |
* The provided phone number is invalid. |
| 647 |
*/ |
| 648 |
public const INVALID_PHONE_NUMBER = 'INVALID_PHONE_NUMBER'; |
| 649 |
|
| 650 |
/** |
| 651 |
* The provided checkout URL has expired. |
| 652 |
*/ |
| 653 |
public const CHECKOUT_EXPIRED = 'CHECKOUT_EXPIRED'; |
| 654 |
|
| 655 |
/** |
| 656 |
* Bad certificate. |
| 657 |
*/ |
| 658 |
public const BAD_CERTIFICATE = 'BAD_CERTIFICATE'; |
| 659 |
|
| 660 |
/** |
| 661 |
* The provided Square-Version is incorrectly formatted. |
| 662 |
*/ |
| 663 |
public const INVALID_SQUARE_VERSION_FORMAT = 'INVALID_SQUARE_VERSION_FORMAT'; |
| 664 |
|
| 665 |
/** |
| 666 |
* The provided Square-Version is incompatible with the requested action. |
| 667 |
*/ |
| 668 |
public const API_VERSION_INCOMPATIBLE = 'API_VERSION_INCOMPATIBLE'; |
| 669 |
|
| 670 |
/** |
| 671 |
* The transaction requires that a card be present. |
| 672 |
*/ |
| 673 |
public const CARD_PRESENCE_REQUIRED = 'CARD_PRESENCE_REQUIRED'; |
| 674 |
|
| 675 |
/** |
| 676 |
* The API request references an unsupported source type. |
| 677 |
*/ |
| 678 |
public const UNSUPPORTED_SOURCE_TYPE = 'UNSUPPORTED_SOURCE_TYPE'; |
| 679 |
|
| 680 |
/** |
| 681 |
* The provided card does not match what is expected. |
| 682 |
*/ |
| 683 |
public const CARD_MISMATCH = 'CARD_MISMATCH'; |
| 684 |
|
| 685 |
/** |
| 686 |
* Generic plaid error |
| 687 |
*/ |
| 688 |
public const PLAID_ERROR = 'PLAID_ERROR'; |
| 689 |
|
| 690 |
/** |
| 691 |
* Plaid error - ITEM_LOGIN_REQUIRED |
| 692 |
*/ |
| 693 |
public const PLAID_ERROR_ITEM_LOGIN_REQUIRED = 'PLAID_ERROR_ITEM_LOGIN_REQUIRED'; |
| 694 |
|
| 695 |
/** |
| 696 |
* Plaid error - RATE_LIMIT |
| 697 |
*/ |
| 698 |
public const PLAID_ERROR_RATE_LIMIT = 'PLAID_ERROR_RATE_LIMIT'; |
| 699 |
|
| 700 |
/** |
| 701 |
* The card was declined. |
| 702 |
*/ |
| 703 |
public const CARD_DECLINED = 'CARD_DECLINED'; |
| 704 |
|
| 705 |
/** |
| 706 |
* The CVV could not be verified. |
| 707 |
*/ |
| 708 |
public const VERIFY_CVV_FAILURE = 'VERIFY_CVV_FAILURE'; |
| 709 |
|
| 710 |
/** |
| 711 |
* The AVS could not be verified. |
| 712 |
*/ |
| 713 |
public const VERIFY_AVS_FAILURE = 'VERIFY_AVS_FAILURE'; |
| 714 |
|
| 715 |
/** |
| 716 |
* The payment card was declined with a request |
| 717 |
* for the card holder to call the issuer. |
| 718 |
*/ |
| 719 |
public const CARD_DECLINED_CALL_ISSUER = 'CARD_DECLINED_CALL_ISSUER'; |
| 720 |
|
| 721 |
/** |
| 722 |
* The payment card was declined with a request |
| 723 |
* for additional verification. |
| 724 |
*/ |
| 725 |
public const CARD_DECLINED_VERIFICATION_REQUIRED = 'CARD_DECLINED_VERIFICATION_REQUIRED'; |
| 726 |
|
| 727 |
/** |
| 728 |
* The card expiration date is either missing or |
| 729 |
* incorrectly formatted. |
| 730 |
*/ |
| 731 |
public const BAD_EXPIRATION = 'BAD_EXPIRATION'; |
| 732 |
|
| 733 |
/** |
| 734 |
* The card issuer requires that the card be read |
| 735 |
* using a chip reader. |
| 736 |
*/ |
| 737 |
public const CHIP_INSERTION_REQUIRED = 'CHIP_INSERTION_REQUIRED'; |
| 738 |
|
| 739 |
/** |
| 740 |
* The card has exhausted its available pin entry |
| 741 |
* retries set by the card issuer. Resolving the error typically requires the |
| 742 |
* card holder to contact the card issuer. |
| 743 |
*/ |
| 744 |
public const ALLOWABLE_PIN_TRIES_EXCEEDED = 'ALLOWABLE_PIN_TRIES_EXCEEDED'; |
| 745 |
|
| 746 |
/** |
| 747 |
* The card issuer declined the refund. |
| 748 |
*/ |
| 749 |
public const RESERVATION_DECLINED = 'RESERVATION_DECLINED'; |
| 750 |
|
| 751 |
/** |
| 752 |
* The body parameter is not recognized by the requested endpoint. |
| 753 |
*/ |
| 754 |
public const UNKNOWN_BODY_PARAMETER = 'UNKNOWN_BODY_PARAMETER'; |
| 755 |
|
| 756 |
/** |
| 757 |
* Not Found - a general error occurred. |
| 758 |
*/ |
| 759 |
public const NOT_FOUND = 'NOT_FOUND'; |
| 760 |
|
| 761 |
/** |
| 762 |
* Square could not find the associated Apple Pay certificate. |
| 763 |
*/ |
| 764 |
public const APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND = |
| 765 |
'APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND'; |
| 766 |
|
| 767 |
/** |
| 768 |
* Method Not Allowed - a general error occurred. |
| 769 |
*/ |
| 770 |
public const METHOD_NOT_ALLOWED = 'METHOD_NOT_ALLOWED'; |
| 771 |
|
| 772 |
/** |
| 773 |
* Not Acceptable - a general error occurred. |
| 774 |
*/ |
| 775 |
public const NOT_ACCEPTABLE = 'NOT_ACCEPTABLE'; |
| 776 |
|
| 777 |
/** |
| 778 |
* Request Timeout - a general error occurred. |
| 779 |
*/ |
| 780 |
public const REQUEST_TIMEOUT = 'REQUEST_TIMEOUT'; |
| 781 |
|
| 782 |
/** |
| 783 |
* Conflict - a general error occurred. |
| 784 |
*/ |
| 785 |
public const CONFLICT = 'CONFLICT'; |
| 786 |
|
| 787 |
/** |
| 788 |
* The target resource is no longer available and this |
| 789 |
* condition is likely to be permanent. |
| 790 |
*/ |
| 791 |
public const GONE = 'GONE'; |
| 792 |
|
| 793 |
/** |
| 794 |
* Request Entity Too Large - a general error occurred. |
| 795 |
*/ |
| 796 |
public const REQUEST_ENTITY_TOO_LARGE = 'REQUEST_ENTITY_TOO_LARGE'; |
| 797 |
|
| 798 |
/** |
| 799 |
* Unsupported Media Type - a general error occurred. |
| 800 |
*/ |
| 801 |
public const UNSUPPORTED_MEDIA_TYPE = 'UNSUPPORTED_MEDIA_TYPE'; |
| 802 |
|
| 803 |
/** |
| 804 |
* Unprocessable Entity - a general error occurred. |
| 805 |
*/ |
| 806 |
public const UNPROCESSABLE_ENTITY = 'UNPROCESSABLE_ENTITY'; |
| 807 |
|
| 808 |
/** |
| 809 |
* Rate Limited - a general error occurred. |
| 810 |
*/ |
| 811 |
public const RATE_LIMITED = 'RATE_LIMITED'; |
| 812 |
|
| 813 |
/** |
| 814 |
* Not Implemented - a general error occurred. |
| 815 |
*/ |
| 816 |
public const NOT_IMPLEMENTED = 'NOT_IMPLEMENTED'; |
| 817 |
|
| 818 |
/** |
| 819 |
* Bad Gateway - a general error occurred. |
| 820 |
*/ |
| 821 |
public const BAD_GATEWAY = 'BAD_GATEWAY'; |
| 822 |
|
| 823 |
/** |
| 824 |
* Service Unavailable - a general error occurred. |
| 825 |
*/ |
| 826 |
public const SERVICE_UNAVAILABLE = 'SERVICE_UNAVAILABLE'; |
| 827 |
|
| 828 |
/** |
| 829 |
* A temporary internal error occurred. You can safely retry your call |
| 830 |
* using the same idempotency key. |
| 831 |
*/ |
| 832 |
public const TEMPORARY_ERROR = 'TEMPORARY_ERROR'; |
| 833 |
|
| 834 |
/** |
| 835 |
* Gateway Timeout - a general error occurred. |
| 836 |
*/ |
| 837 |
public const GATEWAY_TIMEOUT = 'GATEWAY_TIMEOUT'; |
| 838 |
} |
| 839 |
|