Package com.stripe.param
Class PersonCollectionCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PersonCollectionCreateParams
-
public class PersonCollectionCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPersonCollectionCreateParams.Addressstatic classPersonCollectionCreateParams.AddressKanaState, county, province, or region.static classPersonCollectionCreateParams.AddressKanjiTown or cho-me.static classPersonCollectionCreateParams.Builderstatic classPersonCollectionCreateParams.DobTown or cho-me.static classPersonCollectionCreateParams.DocumentsThe four-digit year of birth.static classPersonCollectionCreateParams.RelationshipAdd all elements to `files` list.static classPersonCollectionCreateParams.VerificationThe person's title (e.g., CEO, Support Engineer).-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PersonCollectionCreateParams.Builderbuilder()PersonCollectionCreateParams.AddressgetAddress()The person's address.PersonCollectionCreateParams.AddressKanagetAddressKana()The Kana variation of the person's address (Japan only).PersonCollectionCreateParams.AddressKanjigetAddressKanji()The Kanji variation of the person's address (Japan only).java.lang.ObjectgetDob()The person's date of birth.PersonCollectionCreateParams.DocumentsgetDocuments()Documents that may be submitted to satisfy various informational requests.java.lang.StringgetEmail()The person's email address.java.util.List<java.lang.String>getExpand()Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>getExtraParams()Map of extra parameters for custom features not available in this client library.java.lang.StringgetFirstName()The person's first name.java.lang.StringgetFirstNameKana()The Kana variation of the person's first name (Japan only).java.lang.StringgetFirstNameKanji()The Kanji variation of the person's first name (Japan only).java.lang.StringgetGender()The person's gender (International regulations require either "male" or "female").java.lang.StringgetIdNumber()The person's ID number, as appropriate for their country.java.lang.StringgetLastName()The person's last name.java.lang.StringgetLastNameKana()The Kana variation of the person's last name (Japan only).java.lang.StringgetLastNameKanji()The Kanji variation of the person's last name (Japan only).java.lang.StringgetMaidenName()The person's maiden name.java.lang.ObjectgetMetadata()Set of key-value pairs that you can attach to an object.java.lang.StringgetNationality()The country where the person is a national.java.lang.StringgetPersonToken()A person token, used to securely provide details to the person.java.lang.StringgetPhone()The person's phone number.java.lang.StringgetPoliticalExposure()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.PersonCollectionCreateParams.RelationshipgetRelationship()The relationship that this person has with the account's legal entity.java.lang.StringgetSsnLast4()The last four digits of the person's Social Security number (U.S.PersonCollectionCreateParams.VerificationgetVerification()The person's verification status.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PersonCollectionCreateParams.Builder builder()
-
getAddress
public PersonCollectionCreateParams.Address getAddress()
The person's address.
-
getAddressKana
public PersonCollectionCreateParams.AddressKana getAddressKana()
The Kana variation of the person's address (Japan only).
-
getAddressKanji
public PersonCollectionCreateParams.AddressKanji getAddressKanji()
The Kanji variation of the person's address (Japan only).
-
getDob
public java.lang.Object getDob()
The person's date of birth.
-
getDocuments
public PersonCollectionCreateParams.Documents getDocuments()
Documents that may be submitted to satisfy various informational requests.
-
getEmail
public java.lang.String getEmail()
The person's email address.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedNamevalue. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
-
getFirstName
public java.lang.String getFirstName()
The person's first name.
-
getFirstNameKana
public java.lang.String getFirstNameKana()
The Kana variation of the person's first name (Japan only).
-
getFirstNameKanji
public java.lang.String getFirstNameKanji()
The Kanji variation of the person's first name (Japan only).
-
getGender
public java.lang.String getGender()
The person's gender (International regulations require either "male" or "female").
-
getIdNumber
public java.lang.String getIdNumber()
The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
-
getLastName
public java.lang.String getLastName()
The person's last name.
-
getLastNameKana
public java.lang.String getLastNameKana()
The Kana variation of the person's last name (Japan only).
-
getLastNameKanji
public java.lang.String getLastNameKanji()
The Kanji variation of the person's last name (Japan only).
-
getMaidenName
public java.lang.String getMaidenName()
The person's maiden name.
-
getMetadata
public java.lang.Object getMetadata()
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata.
-
getNationality
public java.lang.String getNationality()
The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.
-
getPersonToken
public java.lang.String getPersonToken()
A person token, used to securely provide details to the person.
-
getPhone
public java.lang.String getPhone()
The person's phone number.
-
getPoliticalExposure
public java.lang.String getPoliticalExposure()
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.
-
getRelationship
public PersonCollectionCreateParams.Relationship getRelationship()
The relationship that this person has with the account's legal entity.
-
getSsnLast4
public java.lang.String getSsnLast4()
The last four digits of the person's Social Security number (U.S. only).
-
getVerification
public PersonCollectionCreateParams.Verification getVerification()
The person's verification status.
-
-