NAME
Net::API::Stripe::Connect::Person - A Stripe Person Object
SYNOPSIS
my $pers = $stripe->person({
account => $account_object,
address => $address_object,
address_kana => $address_kana_object,
address_kanji => $address_kanji_object,
# or:
# dob => DateTime->new( year => 1985, month => 8, day => 15 )
dob =>
{
day => 15
month => 8,
year => 1985,
},
email => 'nadeshiko.yamato@example.com',
first_name => 'Nadeshiko',
last_name => 'Yamato',
first_name_kana => 'なでしこ',
last_name_kana => 'やまと',
first_name_kanji => '撫子',
last_name_kanji => '大和',
gender => 'female',
metadata => { transaction_id => 123, customer_id => 456 },
phone => '+81-(0)90-1234-5678',
});See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.
VERSION
v0.201.1DESCRIPTION
This is an object representing a person associated with a Stripe account.
CONSTRUCTOR
new( %ARG )
Creates a new Net::API::Stripe::Connect::Person object. It may also take an hash like arguments, that also are method of the same name.
METHODS
id string
Unique identifier for the object.
object string, value is "person"
String representing the object’s type. Objects of the same type share the same value.
account string
The account the person is associated with. If expanded (currently not implemented in Stripe API), this will be a Net::API::Stripe::Connect::Account object.
additional string_array
Additional fields which are only required for some users.
address hash
The person’s address.
This is Net::API::Stripe::Address object.
address_kana hash
The Kana variation of the person’s address (Japan only).
This is Net::API::Stripe::Address object.
address_kanji hash
The Kanji variation of the person’s address (Japan only).
This is Net::API::Stripe::Address object.
created timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
dob DateTime object or hash
The person’s date of birth.
This returns a DateTime object. It can take either a DateTime object or an hash with the following properties:
- day positive integer
-
The day of birth, between 1 and 31.
- month positive integer
-
The month of birth, between 1 and 12.
- year positive integer
-
The four-digit year of birth.
email string
The person’s email address.
first_name string
The person’s first name.
first_name_kana string
The Kana variation of the person’s first name (Japan only).
first_name_kanji string
The Kanji variation of the person’s first name (Japan only).
full_name_aliases string_array
A list of alternate names or aliases that the individual is known by.
future_requirements object
Information about future requirements for the individual, including what information needs to be collected, and by when.
This is a Net::API::Stripe::Connect::Account::Requirements object.
gender string
The person’s gender (International regulations require either “male” or “female”).
id_number_provided boolean
Whether the person’s id_number was provided.
id_number_secondary_provided boolean
Whether the individual's personal secondary ID number was provided.
last_name string
The person’s last name.
last_name_kana string
The Kana variation of the person’s last name (Japan only).
last_name_kanji string
The Kanji variation of the person’s last name (Japan only).
maiden_name string
The person’s maiden name.
metadata hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
minimum string_array
Fields which every account must eventually provide.
nationality string
The country where the person is a national.
phone string
The person’s phone number.
political_exposure string
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.
registered_address object
The individual's registered address.
This is a Net::API::Stripe::Address object.
relationship hash
Describes the person’s relationship to the account.
This is a Net::API::Stripe::Connect::Account::Relationship object.
requirements hash
Information about the requirements for this person, including what information needs to be collected, and by when.
This is a Net::API::Stripe::Connect::Account::Requirements object.
ssn_last_4_provided boolean
Whether the last 4 digits of this person’s SSN have been provided.
verification hash
The persons’s verification status.
This is a Net::API::Stripe::Connect::Account::Verification object.
API SAMPLE
{
"id": "person_fake123456789",
"object": "person",
"account": "acct_fake123456789",
"created": 1571602397,
"dob": {
"day": null,
"month": null,
"year": null
},
"first_name_kana": null,
"first_name_kanji": null,
"gender": null,
"last_name_kana": null,
"last_name_kanji": null,
"metadata": {},
"relationship": {
"director": false,
"executive": false,
"owner": false,
"percent_ownership": null,
"representative": false,
"title": null
},
"requirements": {
"currently_due": [],
"eventually_due": [],
"past_due": [],
"pending_verification": []
},
"verification": {
"additional_document": {
"back": null,
"details": null,
"details_code": null,
"front": null
},
"details": null,
"details_code": null,
"document": {
"back": null,
"details": null,
"details_code": null,
"front": null
},
"status": "unverified"
}
}HISTORY
v0.1
Initial version
v0.2
Update the method dob to accept DateTime objects
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/persons/object, https://stripe.com/docs/connect/identity-verification-api#person-information
COPYRIGHT & LICENSE
Copyright (c) 2020-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.