AddressRequirements.php
8 months ago
Buttons.php
5 months ago
Constants.php
3 months ago
Helper.php
3 months ago
Notices.php
5 months ago
Request.php
2 months ago
TransactAccountManager.php
5 months ago
WebhookHandler.php
3 months ago
Constants.php
436 lines
| 1 | <?php |
| 2 | |
| 3 | declare( strict_types=1 ); |
| 4 | |
| 5 | namespace Automattic\WooCommerce\Gateways\PayPal; |
| 6 | |
| 7 | /** |
| 8 | * PayPal Gateway Constants. |
| 9 | * |
| 10 | * Provides constants for PayPal payment statuses, intents, and other PayPal-related values. |
| 11 | * |
| 12 | * @since 10.5.0 |
| 13 | */ |
| 14 | class Constants { |
| 15 | /** |
| 16 | * PayPal proxy request timeout. |
| 17 | */ |
| 18 | const WPCOM_PROXY_REQUEST_TIMEOUT = 60; |
| 19 | |
| 20 | /** |
| 21 | * PayPal payment statuses. |
| 22 | */ |
| 23 | const STATUS_COMPLETED = 'COMPLETED'; |
| 24 | const STATUS_APPROVED = 'APPROVED'; |
| 25 | const STATUS_CAPTURED = 'CAPTURED'; |
| 26 | const STATUS_AUTHORIZED = 'AUTHORIZED'; |
| 27 | const STATUS_PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'; |
| 28 | const VOIDED = 'VOIDED'; |
| 29 | |
| 30 | /** |
| 31 | * PayPal payment intents. |
| 32 | */ |
| 33 | const INTENT_CAPTURE = 'CAPTURE'; |
| 34 | const INTENT_AUTHORIZE = 'AUTHORIZE'; |
| 35 | |
| 36 | /** |
| 37 | * PayPal payment actions. |
| 38 | */ |
| 39 | const PAYMENT_ACTION_CAPTURE = 'capture'; |
| 40 | const PAYMENT_ACTION_AUTHORIZE = 'authorize'; |
| 41 | |
| 42 | /** |
| 43 | * PayPal shipping preferences. |
| 44 | */ |
| 45 | const SHIPPING_NO_SHIPPING = 'NO_SHIPPING'; |
| 46 | const SHIPPING_GET_FROM_FILE = 'GET_FROM_FILE'; |
| 47 | const SHIPPING_SET_PROVIDED_ADDRESS = 'SET_PROVIDED_ADDRESS'; |
| 48 | |
| 49 | /** |
| 50 | * PayPal user actions. |
| 51 | */ |
| 52 | const USER_ACTION_PAY_NOW = 'PAY_NOW'; |
| 53 | |
| 54 | /** |
| 55 | * Maximum lengths for PayPal fields. |
| 56 | */ |
| 57 | const PAYPAL_ORDER_ITEM_NAME_MAX_LENGTH = 127; |
| 58 | const PAYPAL_INVOICE_ID_MAX_LENGTH = 127; |
| 59 | const PAYPAL_ADDRESS_LINE_MAX_LENGTH = 300; |
| 60 | const PAYPAL_COUNTRY_CODE_LENGTH = 2; |
| 61 | const PAYPAL_STATE_MAX_LENGTH = 300; |
| 62 | const PAYPAL_CITY_MAX_LENGTH = 120; |
| 63 | const PAYPAL_POSTAL_CODE_MAX_LENGTH = 60; |
| 64 | const PAYPAL_LOCALE_MAX_LENGTH = 10; |
| 65 | |
| 66 | /** |
| 67 | * Supported payment sources. |
| 68 | */ |
| 69 | const PAYMENT_SOURCE_PAYPAL = 'paypal'; |
| 70 | const PAYMENT_SOURCE_VENMO = 'venmo'; |
| 71 | const PAYMENT_SOURCE_PAYLATER = 'paylater'; |
| 72 | const SUPPORTED_PAYMENT_SOURCES = array( self::PAYMENT_SOURCE_PAYPAL, self::PAYMENT_SOURCE_VENMO, self::PAYMENT_SOURCE_PAYLATER ); |
| 73 | |
| 74 | /** |
| 75 | * Fields to redact from logs. |
| 76 | * |
| 77 | * @var array |
| 78 | */ |
| 79 | const FIELDS_TO_REDACT = array( |
| 80 | 'given_name', |
| 81 | 'surname', |
| 82 | 'full_name', |
| 83 | 'address_line_1', |
| 84 | 'address_line_2', |
| 85 | 'admin_area_1', |
| 86 | 'admin_area_2', |
| 87 | 'postal_code', |
| 88 | 'phone', |
| 89 | 'phone_number', |
| 90 | 'national_number', |
| 91 | ); |
| 92 | |
| 93 | /** |
| 94 | * List of currencies supported by PayPal (Orders API V2). |
| 95 | * |
| 96 | * @var array<string> |
| 97 | */ |
| 98 | const SUPPORTED_CURRENCIES = array( |
| 99 | 'AUD', // Australian Dollar. |
| 100 | 'BRL', // Brazilian Real. |
| 101 | 'CAD', // Canadian Dollar. |
| 102 | 'CNY', // Chinese Renminbi. |
| 103 | 'CZK', // Czech Koruna. |
| 104 | 'DKK', // Danish Krone. |
| 105 | 'EUR', // Euro. |
| 106 | 'HKD', // Hong Kong Dollar. |
| 107 | 'HUF', // Hungarian Forint. |
| 108 | 'ILS', // Israeli New Shekel. |
| 109 | 'JPY', // Japanese Yen. |
| 110 | 'MYR', // Malaysian Ringgit. |
| 111 | 'MXN', // Mexican Peso. |
| 112 | 'TWD', // New Taiwan Dollar. |
| 113 | 'NZD', // New Zealand Dollar. |
| 114 | 'NOK', // Norwegian Krone. |
| 115 | 'PHP', // Philippine Peso. |
| 116 | 'PLN', // Polish Złoty. |
| 117 | 'GBP', // Pound Sterling. |
| 118 | 'SGD', // Singapore Dollar. |
| 119 | 'SEK', // Swedish Krona. |
| 120 | 'CHF', // Swiss Franc. |
| 121 | 'THB', // Thai Baht. |
| 122 | 'USD', // United States Dollar. |
| 123 | 'RUB', // Russian Ruble. |
| 124 | ); |
| 125 | |
| 126 | /** |
| 127 | * Countries supported by PayPal. |
| 128 | * https://developer.paypal.com/reference/country-codes/ |
| 129 | * |
| 130 | * @var array<string, string> |
| 131 | */ |
| 132 | const SUPPORTED_COUNTRIES = array( |
| 133 | 'AL' => 'Albania', |
| 134 | 'DZ' => 'Algeria', |
| 135 | 'AD' => 'Andorra', |
| 136 | 'AO' => 'Angola', |
| 137 | 'AI' => 'Anguilla', |
| 138 | 'AG' => 'Antigua & Barbuda', |
| 139 | 'AR' => 'Argentina', |
| 140 | 'AM' => 'Armenia', |
| 141 | 'AW' => 'Aruba', |
| 142 | 'AU' => 'Australia', |
| 143 | 'AT' => 'Austria', |
| 144 | 'AZ' => 'Azerbaijan', |
| 145 | 'BS' => 'Bahamas', |
| 146 | 'BH' => 'Bahrain', |
| 147 | 'BB' => 'Barbados', |
| 148 | 'BY' => 'Belarus', |
| 149 | 'BE' => 'Belgium', |
| 150 | 'BZ' => 'Belize', |
| 151 | 'BJ' => 'Benin', |
| 152 | 'BM' => 'Bermuda', |
| 153 | 'BT' => 'Bhutan', |
| 154 | 'BO' => 'Bolivia', |
| 155 | 'BA' => 'Bosnia & Herzegovina', |
| 156 | 'BW' => 'Botswana', |
| 157 | 'BR' => 'Brazil', |
| 158 | 'VG' => 'British Virgin Islands', |
| 159 | 'BN' => 'Brunei', |
| 160 | 'BG' => 'Bulgaria', |
| 161 | 'BF' => 'Burkina Faso', |
| 162 | 'BI' => 'Burundi', |
| 163 | 'KH' => 'Cambodia', |
| 164 | 'CM' => 'Cameroon', |
| 165 | 'CA' => 'Canada', |
| 166 | 'CV' => 'Cape Verde', |
| 167 | 'KY' => 'Cayman Islands', |
| 168 | 'TD' => 'Chad', |
| 169 | 'CL' => 'Chile', |
| 170 | 'CN' => 'China', |
| 171 | 'CO' => 'Colombia', |
| 172 | 'KM' => 'Comoros', |
| 173 | 'CG' => 'Congo - Brazzaville', |
| 174 | 'CD' => 'Congo - Kinshasa', |
| 175 | 'CK' => 'Cook Islands', |
| 176 | 'CR' => 'Costa Rica', |
| 177 | 'CI' => 'Côte d\'Ivoire', |
| 178 | 'HR' => 'Croatia', |
| 179 | 'CY' => 'Cyprus', |
| 180 | 'CZ' => 'Czech Republic', |
| 181 | 'DK' => 'Denmark', |
| 182 | 'DJ' => 'Djibouti', |
| 183 | 'DM' => 'Dominica', |
| 184 | 'DO' => 'Dominican Republic', |
| 185 | 'EC' => 'Ecuador', |
| 186 | 'EG' => 'Egypt', |
| 187 | 'SV' => 'El Salvador', |
| 188 | 'ER' => 'Eritrea', |
| 189 | 'EE' => 'Estonia', |
| 190 | 'ET' => 'Ethiopia', |
| 191 | 'FK' => 'Falkland Islands', |
| 192 | 'FO' => 'Faroe Islands', |
| 193 | 'FJ' => 'Fiji', |
| 194 | 'FI' => 'Finland', |
| 195 | 'FR' => 'France', |
| 196 | 'GF' => 'French Guiana', |
| 197 | 'PF' => 'French Polynesia', |
| 198 | 'GA' => 'Gabon', |
| 199 | 'GM' => 'Gambia', |
| 200 | 'GE' => 'Georgia', |
| 201 | 'DE' => 'Germany', |
| 202 | 'GI' => 'Gibraltar', |
| 203 | 'GR' => 'Greece', |
| 204 | 'GL' => 'Greenland', |
| 205 | 'GD' => 'Grenada', |
| 206 | 'GP' => 'Guadeloupe', |
| 207 | 'GT' => 'Guatemala', |
| 208 | 'GN' => 'Guinea', |
| 209 | 'GW' => 'Guinea-Bissau', |
| 210 | 'GY' => 'Guyana', |
| 211 | 'HN' => 'Honduras', |
| 212 | 'HK' => 'Hong Kong SAR China', |
| 213 | 'HU' => 'Hungary', |
| 214 | 'IS' => 'Iceland', |
| 215 | 'IN' => 'India', |
| 216 | 'ID' => 'Indonesia', |
| 217 | 'IE' => 'Ireland', |
| 218 | 'IL' => 'Israel', |
| 219 | 'IT' => 'Italy', |
| 220 | 'JM' => 'Jamaica', |
| 221 | 'JP' => 'Japan', |
| 222 | 'JO' => 'Jordan', |
| 223 | 'KZ' => 'Kazakhstan', |
| 224 | 'KE' => 'Kenya', |
| 225 | 'KI' => 'Kiribati', |
| 226 | 'KW' => 'Kuwait', |
| 227 | 'KG' => 'Kyrgyzstan', |
| 228 | 'LA' => 'Laos', |
| 229 | 'LV' => 'Latvia', |
| 230 | 'LS' => 'Lesotho', |
| 231 | 'LI' => 'Liechtenstein', |
| 232 | 'LT' => 'Lithuania', |
| 233 | 'LU' => 'Luxembourg', |
| 234 | 'MK' => 'Macedonia', |
| 235 | 'MG' => 'Madagascar', |
| 236 | 'MW' => 'Malawi', |
| 237 | 'MY' => 'Malaysia', |
| 238 | 'MV' => 'Maldives', |
| 239 | 'ML' => 'Mali', |
| 240 | 'MT' => 'Malta', |
| 241 | 'MH' => 'Marshall Islands', |
| 242 | 'MQ' => 'Martinique', |
| 243 | 'MR' => 'Mauritania', |
| 244 | 'MU' => 'Mauritius', |
| 245 | 'YT' => 'Mayotte', |
| 246 | 'MX' => 'Mexico', |
| 247 | 'FM' => 'Micronesia', |
| 248 | 'MD' => 'Moldova', |
| 249 | 'MC' => 'Monaco', |
| 250 | 'MN' => 'Mongolia', |
| 251 | 'ME' => 'Montenegro', |
| 252 | 'MS' => 'Montserrat', |
| 253 | 'MA' => 'Morocco', |
| 254 | 'MZ' => 'Mozambique', |
| 255 | 'NA' => 'Namibia', |
| 256 | 'NR' => 'Nauru', |
| 257 | 'NP' => 'Nepal', |
| 258 | 'NL' => 'Netherlands', |
| 259 | 'NC' => 'New Caledonia', |
| 260 | 'NZ' => 'New Zealand', |
| 261 | 'NI' => 'Nicaragua', |
| 262 | 'NE' => 'Niger', |
| 263 | 'NG' => 'Nigeria', |
| 264 | 'NU' => 'Niue', |
| 265 | 'NF' => 'Norfolk Island', |
| 266 | 'NO' => 'Norway', |
| 267 | 'OM' => 'Oman', |
| 268 | 'PW' => 'Palau', |
| 269 | 'PA' => 'Panama', |
| 270 | 'PG' => 'Papua New Guinea', |
| 271 | 'PY' => 'Paraguay', |
| 272 | 'PE' => 'Peru', |
| 273 | 'PH' => 'Philippines', |
| 274 | 'PN' => 'Pitcairn Islands', |
| 275 | 'PL' => 'Poland', |
| 276 | 'PT' => 'Portugal', |
| 277 | 'QA' => 'Qatar', |
| 278 | 'RE' => 'Réunion', |
| 279 | 'RO' => 'Romania', |
| 280 | 'RU' => 'Russia', |
| 281 | 'RW' => 'Rwanda', |
| 282 | 'WS' => 'Samoa', |
| 283 | 'SM' => 'San Marino', |
| 284 | 'ST' => 'São Tomé & Príncipe', |
| 285 | 'SA' => 'Saudi Arabia', |
| 286 | 'SN' => 'Senegal', |
| 287 | 'RS' => 'Serbia', |
| 288 | 'SC' => 'Seychelles', |
| 289 | 'SL' => 'Sierra Leone', |
| 290 | 'SG' => 'Singapore', |
| 291 | 'SK' => 'Slovakia', |
| 292 | 'SI' => 'Slovenia', |
| 293 | 'SB' => 'Solomon Islands', |
| 294 | 'SO' => 'Somalia', |
| 295 | 'ZA' => 'South Africa', |
| 296 | 'KR' => 'South Korea', |
| 297 | 'ES' => 'Spain', |
| 298 | 'LK' => 'Sri Lanka', |
| 299 | 'SH' => 'St. Helena', |
| 300 | 'KN' => 'St. Kitts & Nevis', |
| 301 | 'LC' => 'St. Lucia', |
| 302 | 'PM' => 'St. Pierre & Miquelon', |
| 303 | 'VC' => 'St. Vincent & Grenadines', |
| 304 | 'SR' => 'Suriname', |
| 305 | 'SJ' => 'Svalbard & Jan Mayen', |
| 306 | 'SZ' => 'Swaziland', |
| 307 | 'SE' => 'Sweden', |
| 308 | 'CH' => 'Switzerland', |
| 309 | 'TW' => 'Taiwan', |
| 310 | 'TJ' => 'Tajikistan', |
| 311 | 'TZ' => 'Tanzania', |
| 312 | 'TH' => 'Thailand', |
| 313 | 'TG' => 'Togo', |
| 314 | 'TO' => 'Tonga', |
| 315 | 'TT' => 'Trinidad & Tobago', |
| 316 | 'TN' => 'Tunisia', |
| 317 | 'TM' => 'Turkmenistan', |
| 318 | 'TC' => 'Turks & Caicos Islands', |
| 319 | 'TV' => 'Tuvalu', |
| 320 | 'UG' => 'Uganda', |
| 321 | 'UA' => 'Ukraine', |
| 322 | 'AE' => 'United Arab Emirates', |
| 323 | 'GB' => 'United Kingdom', |
| 324 | 'US' => 'United States', |
| 325 | 'UY' => 'Uruguay', |
| 326 | 'VU' => 'Vanuatu', |
| 327 | 'VA' => 'Vatican City', |
| 328 | 'VE' => 'Venezuela', |
| 329 | 'VN' => 'Vietnam', |
| 330 | 'WF' => 'Wallis & Futuna', |
| 331 | 'YE' => 'Yemen', |
| 332 | 'ZM' => 'Zambia', |
| 333 | 'ZW' => 'Zimbabwe', |
| 334 | ); |
| 335 | |
| 336 | /** |
| 337 | * PayPal authorization already captured issue code. |
| 338 | * |
| 339 | * @var string |
| 340 | */ |
| 341 | const PAYPAL_ISSUE_AUTHORIZATION_ALREADY_CAPTURED = 'AUTHORIZATION_ALREADY_CAPTURED'; |
| 342 | |
| 343 | /** |
| 344 | * PayPal account locked or closed issue code. |
| 345 | * |
| 346 | * @var string |
| 347 | */ |
| 348 | const PAYPAL_ISSUE_PAYEE_ACCOUNT_LOCKED_OR_CLOSED = 'PAYEE_ACCOUNT_LOCKED_OR_CLOSED'; |
| 349 | |
| 350 | /** |
| 351 | * PayPal account restricted issue code. |
| 352 | * |
| 353 | * @var string |
| 354 | */ |
| 355 | const PAYPAL_ISSUE_PAYEE_ACCOUNT_RESTRICTED = 'PAYEE_ACCOUNT_RESTRICTED'; |
| 356 | |
| 357 | /** |
| 358 | * PayPal duplicate invoice ID issue code. |
| 359 | * |
| 360 | * @var string |
| 361 | */ |
| 362 | const PAYPAL_ISSUE_DUPLICATE_INVOICE_ID = 'DUPLICATE_INVOICE_ID'; |
| 363 | |
| 364 | /** |
| 365 | * Meta key for storing PayPal payment status in order meta. |
| 366 | * |
| 367 | * @var string |
| 368 | * |
| 369 | * @since 10.5.0 |
| 370 | */ |
| 371 | public const PAYPAL_ORDER_META_STATUS = '_paypal_status'; |
| 372 | |
| 373 | /** |
| 374 | * Meta key for storing PayPal capture ID in order meta. |
| 375 | * |
| 376 | * @var string |
| 377 | * |
| 378 | * @since 10.5.0 |
| 379 | */ |
| 380 | public const PAYPAL_ORDER_META_CAPTURE_ID = '_paypal_capture_id'; |
| 381 | |
| 382 | /** |
| 383 | * Meta key for storing PayPal authorization ID in order meta. |
| 384 | * |
| 385 | * @var string |
| 386 | * |
| 387 | * @since 10.5.0 |
| 388 | */ |
| 389 | public const PAYPAL_ORDER_META_AUTHORIZATION_ID = '_paypal_authorization_id'; |
| 390 | |
| 391 | /** |
| 392 | * Meta key for storing PayPal authorization checked flag in order meta. |
| 393 | * |
| 394 | * @var string |
| 395 | * |
| 396 | * @since 10.5.0 |
| 397 | */ |
| 398 | public const PAYPAL_ORDER_META_AUTHORIZATION_CHECKED = '_paypal_authorization_checked'; |
| 399 | |
| 400 | /** |
| 401 | * Meta key for storing PayPal order ID in order meta. |
| 402 | * |
| 403 | * @var string |
| 404 | * |
| 405 | * @since 10.5.0 |
| 406 | */ |
| 407 | public const PAYPAL_ORDER_META_ORDER_ID = '_paypal_order_id'; |
| 408 | |
| 409 | /** |
| 410 | * Meta key for storing PayPal addresses updated flag in order meta. |
| 411 | * |
| 412 | * @var string |
| 413 | * |
| 414 | * @since 10.5.0 |
| 415 | */ |
| 416 | public const PAYPAL_ORDER_META_ADDRESSES_UPDATED = '_paypal_addresses_updated'; |
| 417 | |
| 418 | /** |
| 419 | * Meta key for storing PayPal payment source in order meta. |
| 420 | * |
| 421 | * @var string |
| 422 | * |
| 423 | * @since 10.5.0 |
| 424 | */ |
| 425 | public const PAYPAL_ORDER_META_PAYMENT_SOURCE = '_paypal_payment_source'; |
| 426 | |
| 427 | /** |
| 428 | * Meta key for storing PayPal shipping callback token in order meta. |
| 429 | * |
| 430 | * @var string |
| 431 | * |
| 432 | * @since 10.5.0 |
| 433 | */ |
| 434 | public const PAYPAL_ORDER_META_SHIPPING_CALLBACK_TOKEN = '_paypal_shipping_callback_token'; |
| 435 | } |
| 436 |