Package com.stripe.param
Class PersonUpdateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.PersonUpdateParams
-
public class PersonUpdateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PersonUpdateParams.Address
static class
PersonUpdateParams.AddressKana
State, county, province, or region.static class
PersonUpdateParams.AddressKanji
Town or cho-me.static class
PersonUpdateParams.Builder
static class
PersonUpdateParams.Dob
Town or cho-me.static class
PersonUpdateParams.Documents
The four-digit year of birth.static class
PersonUpdateParams.Relationship
Add all elements to `files` list.static class
PersonUpdateParams.Verification
The 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 PersonUpdateParams.Builder
builder()
PersonUpdateParams.Address
getAddress()
The person's address.PersonUpdateParams.AddressKana
getAddressKana()
The Kana variation of the person's address (Japan only).PersonUpdateParams.AddressKanji
getAddressKanji()
The Kanji variation of the person's address (Japan only).java.lang.Object
getDob()
The person's date of birth.PersonUpdateParams.Documents
getDocuments()
Documents that may be submitted to satisfy various informational requests.java.lang.Object
getEmail()
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.Object
getFirstName()
The person's first name.java.lang.Object
getFirstNameKana()
The Kana variation of the person's first name (Japan only).java.lang.Object
getFirstNameKanji()
The Kanji variation of the person's first name (Japan only).java.lang.Object
getFullNameAliases()
A list of alternate names or aliases that the person is known by.java.lang.Object
getGender()
The person's gender (International regulations require either "male" or "female").java.lang.Object
getIdNumber()
The person's ID number, as appropriate for their country.java.lang.Object
getLastName()
The person's last name.java.lang.Object
getLastNameKana()
The Kana variation of the person's last name (Japan only).java.lang.Object
getLastNameKanji()
The Kanji variation of the person's last name (Japan only).java.lang.Object
getMaidenName()
The person's maiden name.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.Object
getNationality()
The country where the person is a national.java.lang.Object
getPersonToken()
A person token, used to securely provide details to the person.java.lang.Object
getPhone()
The person's phone number.java.lang.Object
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.PersonUpdateParams.Relationship
getRelationship()
The relationship that this person has with the account's legal entity.java.lang.Object
getSsnLast4()
The last four digits of the person's Social Security number (U.S.PersonUpdateParams.Verification
getVerification()
The person's verification status.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static PersonUpdateParams.Builder builder()
-
getAddress
public PersonUpdateParams.Address getAddress()
The person's address.
-
getAddressKana
public PersonUpdateParams.AddressKana getAddressKana()
The Kana variation of the person's address (Japan only).
-
getAddressKanji
public PersonUpdateParams.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 PersonUpdateParams.Documents getDocuments()
Documents that may be submitted to satisfy various informational requests.
-
getEmail
public java.lang.Object 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@SerializedName
value. 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.Object getFirstName()
The person's first name.
-
getFirstNameKana
public java.lang.Object getFirstNameKana()
The Kana variation of the person's first name (Japan only).
-
getFirstNameKanji
public java.lang.Object getFirstNameKanji()
The Kanji variation of the person's first name (Japan only).
-
getFullNameAliases
public java.lang.Object getFullNameAliases()
A list of alternate names or aliases that the person is known by.
-
getGender
public java.lang.Object getGender()
The person's gender (International regulations require either "male" or "female").
-
getIdNumber
public java.lang.Object 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.Object getLastName()
The person's last name.
-
getLastNameKana
public java.lang.Object getLastNameKana()
The Kana variation of the person's last name (Japan only).
-
getLastNameKanji
public java.lang.Object getLastNameKanji()
The Kanji variation of the person's last name (Japan only).
-
getMaidenName
public java.lang.Object 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.Object 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.Object getPersonToken()
A person token, used to securely provide details to the person.
-
getPhone
public java.lang.Object getPhone()
The person's phone number.
-
getPoliticalExposure
public java.lang.Object 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 PersonUpdateParams.Relationship getRelationship()
The relationship that this person has with the account's legal entity.
-
getSsnLast4
public java.lang.Object getSsnLast4()
The last four digits of the person's Social Security number (U.S. only).
-
getVerification
public PersonUpdateParams.Verification getVerification()
The person's verification status.
-
-