ApiOperations
1 year ago
Apps
1 year ago
Billing
1 year ago
BillingPortal
1 year ago
Checkout
1 year ago
Climate
1 year ago
Entitlements
1 year ago
EventData
1 year ago
Events
1 year ago
Exception
1 year ago
FinancialConnections
1 year ago
Forwarding
1 year ago
HttpClient
1 year ago
Identity
1 year ago
Issuing
1 year ago
Radar
1 year ago
Reporting
1 year ago
Service
1 year ago
Sigma
1 year ago
Tax
1 year ago
Terminal
1 year ago
TestHelpers
1 year ago
Treasury
1 year ago
Util
1 year ago
V2
1 year ago
Account.php
1 year ago
AccountLink.php
1 year ago
AccountSession.php
1 year ago
ApiRequestor.php
1 year ago
ApiResource.php
2 years ago
ApiResponse.php
2 years ago
ApplePayDomain.php
1 year ago
Application.php
2 years ago
ApplicationFee.php
1 year ago
ApplicationFeeRefund.php
2 years ago
Balance.php
1 year ago
BalanceTransaction.php
1 year ago
BankAccount.php
1 year ago
BaseStripeClient.php
1 year ago
BaseStripeClientInterface.php
1 year ago
Capability.php
1 year ago
Card.php
1 year ago
CashBalance.php
2 years ago
Charge.php
1 year ago
Collection.php
1 year ago
ConfirmationToken.php
1 year ago
ConnectCollectionTransfer.php
2 years ago
CountrySpec.php
1 year ago
Coupon.php
1 year ago
CreditNote.php
1 year ago
CreditNoteLineItem.php
1 year ago
Customer.php
1 year ago
CustomerBalanceTransaction.php
2 years ago
CustomerCashBalanceTransaction.php
2 years ago
CustomerSession.php
1 year ago
Discount.php
1 year ago
Dispute.php
1 year ago
EphemeralKey.php
1 year ago
ErrorObject.php
1 year ago
Event.php
1 year ago
ExchangeRate.php
1 year ago
File.php
1 year ago
FileLink.php
1 year ago
FundingInstructions.php
2 years ago
Invoice.php
1 year ago
InvoiceItem.php
1 year ago
InvoiceLineItem.php
1 year ago
InvoiceRenderingTemplate.php
1 year ago
LineItem.php
1 year ago
LoginLink.php
1 year ago
Mandate.php
1 year ago
OAuth.php
2 years ago
OAuthErrorObject.php
1 year ago
PaymentIntent.php
1 year ago
PaymentLink.php
1 year ago
PaymentMethod.php
1 year ago
PaymentMethodConfiguration.php
1 year ago
PaymentMethodDomain.php
1 year ago
Payout.php
1 year ago
Person.php
1 year ago
Plan.php
1 year ago
Price.php
1 year ago
Product.php
1 year ago
ProductFeature.php
1 year ago
PromotionCode.php
1 year ago
Quote.php
1 year ago
Reason.php
1 year ago
RecipientTransfer.php
2 years ago
Refund.php
1 year ago
RelatedObject.php
1 year ago
RequestTelemetry.php
2 years ago
ReserveTransaction.php
2 years ago
Review.php
1 year ago
SearchResult.php
1 year ago
SetupAttempt.php
1 year ago
SetupIntent.php
1 year ago
ShippingRate.php
1 year ago
SingletonApiResource.php
2 years ago
Source.php
1 year ago
SourceMandateNotification.php
2 years ago
SourceTransaction.php
2 years ago
Stripe.php
1 year ago
StripeClient.php
1 year ago
StripeClientInterface.php
2 years ago
StripeObject.php
1 year ago
StripeStreamingClientInterface.php
2 years ago
Subscription.php
1 year ago
SubscriptionItem.php
1 year ago
SubscriptionSchedule.php
1 year ago
TaxCode.php
1 year ago
TaxDeductedAtSource.php
2 years ago
TaxId.php
1 year ago
TaxRate.php
1 year ago
ThinEvent.php
1 year ago
Token.php
1 year ago
Topup.php
1 year ago
Transfer.php
1 year ago
TransferReversal.php
1 year ago
UsageRecord.php
1 year ago
UsageRecordSummary.php
1 year ago
Webhook.php
1 year ago
WebhookEndpoint.php
1 year ago
WebhookSignature.php
2 years ago
Person.php
118 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace WPForms\Vendor\Stripe; |
| 5 | |
| 6 | /** |
| 7 | * This is an object representing a person associated with a Stripe account. |
| 8 | * |
| 9 | * A platform cannot access a person for an account where <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>stripe</code>, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. |
| 10 | * |
| 11 | * See the <a href="/connect/standard-accounts">Standard onboarding</a> or <a href="/connect/express-accounts">Express onboarding</a> documentation for information about prefilling information and account onboarding steps. Learn more about <a href="/connect/handling-api-verification#person-information">handling identity verification with the API</a>. |
| 12 | * |
| 13 | * @property string $id Unique identifier for the object. |
| 14 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 15 | * @property null|string $account The account the person is associated with. |
| 16 | * @property null|\Stripe\StripeObject $additional_tos_acceptances |
| 17 | * @property null|\Stripe\StripeObject $address |
| 18 | * @property null|\Stripe\StripeObject $address_kana The Kana variation of the person's address (Japan only). |
| 19 | * @property null|\Stripe\StripeObject $address_kanji The Kanji variation of the person's address (Japan only). |
| 20 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 21 | * @property null|\Stripe\StripeObject $dob |
| 22 | * @property null|string $email The person's email address. |
| 23 | * @property null|string $first_name The person's first name. |
| 24 | * @property null|string $first_name_kana The Kana variation of the person's first name (Japan only). |
| 25 | * @property null|string $first_name_kanji The Kanji variation of the person's first name (Japan only). |
| 26 | * @property null|string[] $full_name_aliases A list of alternate names or aliases that the person is known by. |
| 27 | * @property null|\Stripe\StripeObject $future_requirements Information about the <a href="https://stripe.com/docs/connect/custom-accounts/future-requirements">upcoming new requirements for this person</a>, including what information needs to be collected, and by when. |
| 28 | * @property null|string $gender The person's gender. |
| 29 | * @property null|bool $id_number_provided Whether the person's <code>id_number</code> was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by <code>ssn_last_4_provided</code>). |
| 30 | * @property null|bool $id_number_secondary_provided Whether the person's <code>id_number_secondary</code> was provided. |
| 31 | * @property null|string $last_name The person's last name. |
| 32 | * @property null|string $last_name_kana The Kana variation of the person's last name (Japan only). |
| 33 | * @property null|string $last_name_kanji The Kanji variation of the person's last name (Japan only). |
| 34 | * @property null|string $maiden_name The person's maiden name. |
| 35 | * @property null|\Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 36 | * @property null|string $nationality The country where the person is a national. |
| 37 | * @property null|string $phone The person's phone number. |
| 38 | * @property null|string $political_exposure Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. |
| 39 | * @property null|\Stripe\StripeObject $registered_address |
| 40 | * @property null|\Stripe\StripeObject $relationship |
| 41 | * @property null|\Stripe\StripeObject $requirements Information about the requirements for this person, including what information needs to be collected, and by when. |
| 42 | * @property null|bool $ssn_last_4_provided Whether the last four digits of the person's Social Security number have been provided (U.S. only). |
| 43 | * @property null|\Stripe\StripeObject $verification |
| 44 | */ |
| 45 | class Person extends ApiResource |
| 46 | { |
| 47 | const OBJECT_NAME = 'person'; |
| 48 | const GENDER_FEMALE = 'female'; |
| 49 | const GENDER_MALE = 'male'; |
| 50 | const POLITICAL_EXPOSURE_EXISTING = 'existing'; |
| 51 | const POLITICAL_EXPOSURE_NONE = 'none'; |
| 52 | const VERIFICATION_STATUS_PENDING = 'pending'; |
| 53 | const VERIFICATION_STATUS_UNVERIFIED = 'unverified'; |
| 54 | const VERIFICATION_STATUS_VERIFIED = 'verified'; |
| 55 | use ApiOperations\Delete; |
| 56 | /** |
| 57 | * @return string the API URL for this Stripe account reversal |
| 58 | */ |
| 59 | public function instanceUrl() |
| 60 | { |
| 61 | $id = $this['id']; |
| 62 | $account = $this['account']; |
| 63 | if (!$id) { |
| 64 | throw new Exception\UnexpectedValueException('Could not determine which URL to request: ' . "class instance has invalid ID: {$id}", null); |
| 65 | } |
| 66 | $id = Util\Util::utf8($id); |
| 67 | $account = Util\Util::utf8($account); |
| 68 | $base = Account::classUrl(); |
| 69 | $accountExtn = \urlencode($account); |
| 70 | $extn = \urlencode($id); |
| 71 | return "{$base}/{$accountExtn}/persons/{$extn}"; |
| 72 | } |
| 73 | /** |
| 74 | * @param array|string $_id |
| 75 | * @param null|array|string $_opts |
| 76 | * |
| 77 | * @throws \Stripe\Exception\BadMethodCallException |
| 78 | */ |
| 79 | public static function retrieve($_id, $_opts = null) |
| 80 | { |
| 81 | $msg = 'Persons cannot be retrieved without an account ID. Retrieve ' . "a person using `Account::retrievePerson('account_id', " . "'person_id')`."; |
| 82 | throw new Exception\BadMethodCallException($msg); |
| 83 | } |
| 84 | /** |
| 85 | * @param string $_id |
| 86 | * @param null|array $_params |
| 87 | * @param null|array|string $_options |
| 88 | * |
| 89 | * @throws \Stripe\Exception\BadMethodCallException |
| 90 | */ |
| 91 | public static function update($_id, $_params = null, $_options = null) |
| 92 | { |
| 93 | $msg = 'Persons cannot be updated without an account ID. Update ' . "a person using `Account::updatePerson('account_id', " . "'person_id', \$updateParams)`."; |
| 94 | throw new Exception\BadMethodCallException($msg); |
| 95 | } |
| 96 | /** |
| 97 | * @param null|array|string $opts |
| 98 | * |
| 99 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 100 | * |
| 101 | * @return static the saved resource |
| 102 | * |
| 103 | * @deprecated The `save` method is deprecated and will be removed in a |
| 104 | * future major version of the library. Use the static method `update` |
| 105 | * on the resource instead. |
| 106 | */ |
| 107 | public function save($opts = null) |
| 108 | { |
| 109 | $params = $this->serializeParameters(); |
| 110 | if (\count($params) > 0) { |
| 111 | $url = $this->instanceUrl(); |
| 112 | list($response, $opts) = $this->_request('post', $url, $params, $opts, ['save']); |
| 113 | $this->refreshFrom($response, $opts); |
| 114 | } |
| 115 | return $this; |
| 116 | } |
| 117 | } |
| 118 |