Package com.stripe.param

Class PersonUpdateParams.Builder

java.lang.Object

com.stripe.param.PersonUpdateParams.Builder

Enclosing class:

PersonUpdateParams

public static class PersonUpdateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PersonUpdateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
PersonUpdateParams.Builder	addAllFullNameAlias(List<String> elements)	Add all elements to `fullNameAliases` list.
PersonUpdateParams.Builder	addExpand(String element)	Add an element to `expand` list.
PersonUpdateParams.Builder	addFullNameAlias(String element)	Add an element to `fullNameAliases` list.
PersonUpdateParams	build()	Finalize and obtain parameter instance from this builder.
PersonUpdateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PersonUpdateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PersonUpdateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PersonUpdateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PersonUpdateParams.Builder	setAdditionalTosAcceptances(PersonUpdateParams.AdditionalTosAcceptances additionalTosAcceptances)	Details on the legal guardian's acceptance of the required Stripe agreements.
PersonUpdateParams.Builder	setAddress(PersonUpdateParams.Address address)	The person's address.
PersonUpdateParams.Builder	setAddressKana(PersonUpdateParams.AddressKana addressKana)	The Kana variation of the person's address (Japan only).
PersonUpdateParams.Builder	setAddressKanji(PersonUpdateParams.AddressKanji addressKanji)	The Kanji variation of the person's address (Japan only).
PersonUpdateParams.Builder	setDob(EmptyParam dob)	The person's date of birth.
PersonUpdateParams.Builder	setDob(PersonUpdateParams.Dob dob)	The person's date of birth.
PersonUpdateParams.Builder	setDocuments(PersonUpdateParams.Documents documents)	Documents that may be submitted to satisfy various informational requests.
PersonUpdateParams.Builder	setEmail(EmptyParam email)	The person's email address.
PersonUpdateParams.Builder	setEmail(String email)	The person's email address.
PersonUpdateParams.Builder	setFirstName(EmptyParam firstName)	The person's first name.
PersonUpdateParams.Builder	setFirstName(String firstName)	The person's first name.
PersonUpdateParams.Builder	setFirstNameKana(EmptyParam firstNameKana)	The Kana variation of the person's first name (Japan only).
PersonUpdateParams.Builder	setFirstNameKana(String firstNameKana)	The Kana variation of the person's first name (Japan only).
PersonUpdateParams.Builder	setFirstNameKanji(EmptyParam firstNameKanji)	The Kanji variation of the person's first name (Japan only).
PersonUpdateParams.Builder	setFirstNameKanji(String firstNameKanji)	The Kanji variation of the person's first name (Japan only).
PersonUpdateParams.Builder	setFullNameAliases(EmptyParam fullNameAliases)	A list of alternate names or aliases that the person is known by.
PersonUpdateParams.Builder	setFullNameAliases(List<String> fullNameAliases)	A list of alternate names or aliases that the person is known by.
PersonUpdateParams.Builder	setGender(EmptyParam gender)	The person's gender (International regulations require either "male" or "female").
PersonUpdateParams.Builder	setGender(String gender)	The person's gender (International regulations require either "male" or "female").
PersonUpdateParams.Builder	setIdNumber(EmptyParam idNumber)	The person's ID number, as appropriate for their country.
PersonUpdateParams.Builder	setIdNumber(String idNumber)	The person's ID number, as appropriate for their country.
PersonUpdateParams.Builder	setIdNumberSecondary(EmptyParam idNumberSecondary)	The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks.
PersonUpdateParams.Builder	setIdNumberSecondary(String idNumberSecondary)	The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks.
PersonUpdateParams.Builder	setLastName(EmptyParam lastName)	The person's last name.
PersonUpdateParams.Builder	setLastName(String lastName)	The person's last name.
PersonUpdateParams.Builder	setLastNameKana(EmptyParam lastNameKana)	The Kana variation of the person's last name (Japan only).
PersonUpdateParams.Builder	setLastNameKana(String lastNameKana)	The Kana variation of the person's last name (Japan only).
PersonUpdateParams.Builder	setLastNameKanji(EmptyParam lastNameKanji)	The Kanji variation of the person's last name (Japan only).
PersonUpdateParams.Builder	setLastNameKanji(String lastNameKanji)	The Kanji variation of the person's last name (Japan only).
PersonUpdateParams.Builder	setMaidenName(EmptyParam maidenName)	The person's maiden name.
PersonUpdateParams.Builder	setMaidenName(String maidenName)	The person's maiden name.
PersonUpdateParams.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
PersonUpdateParams.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
PersonUpdateParams.Builder	setNationality(EmptyParam nationality)	The country where the person is a national.
PersonUpdateParams.Builder	setNationality(String nationality)	The country where the person is a national.
PersonUpdateParams.Builder	setPersonToken(EmptyParam personToken)	A person token, used to securely provide details to the person.
PersonUpdateParams.Builder	setPersonToken(String personToken)	A person token, used to securely provide details to the person.
PersonUpdateParams.Builder	setPhone(EmptyParam phone)	The person's phone number.
PersonUpdateParams.Builder	setPhone(String phone)	The person's phone number.
PersonUpdateParams.Builder	setPoliticalExposure(EmptyParam politicalExposure)	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.Builder	setPoliticalExposure(String politicalExposure)	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.Builder	setRegisteredAddress(PersonUpdateParams.RegisteredAddress registeredAddress)	The person's registered address.
PersonUpdateParams.Builder	setRelationship(PersonUpdateParams.Relationship relationship)	The relationship that this person has with the account's legal entity.
PersonUpdateParams.Builder	setSsnLast4(EmptyParam ssnLast4)	The last four digits of the person's Social Security number (U.S.
PersonUpdateParams.Builder	setSsnLast4(String ssnLast4)	The last four digits of the person's Social Security number (U.S.
PersonUpdateParams.Builder	setVerification(PersonUpdateParams.Verification verification)	The person's verification status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public PersonUpdateParams build()

Finalize and obtain parameter instance from this builder.

setAdditionalTosAcceptances

public PersonUpdateParams.Builder setAdditionalTosAcceptances(PersonUpdateParams.AdditionalTosAcceptances additionalTosAcceptances)

Details on the legal guardian's acceptance of the required Stripe agreements.

setAddress

public PersonUpdateParams.Builder setAddress(PersonUpdateParams.Address address)

The person's address.

setAddressKana

public PersonUpdateParams.Builder setAddressKana(PersonUpdateParams.AddressKana addressKana)

The Kana variation of the person's address (Japan only).

setAddressKanji

public PersonUpdateParams.Builder setAddressKanji(PersonUpdateParams.AddressKanji addressKanji)

The Kanji variation of the person's address (Japan only).

setDob

public PersonUpdateParams.Builder setDob(PersonUpdateParams.Dob dob)

The person's date of birth.

setDob

public PersonUpdateParams.Builder setDob(EmptyParam dob)

The person's date of birth.

setDocuments

public PersonUpdateParams.Builder setDocuments(PersonUpdateParams.Documents documents)

Documents that may be submitted to satisfy various informational requests.

setEmail

public PersonUpdateParams.Builder setEmail(String email)

The person's email address.

setEmail

public PersonUpdateParams.Builder setEmail(EmptyParam email)

The person's email address.

addExpand

public PersonUpdateParams.Builder addExpand(String element)

Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PersonUpdateParams.expand for the field documentation.

addAllExpand

public PersonUpdateParams.Builder addAllExpand(List<String> elements)

Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PersonUpdateParams.expand for the field documentation.

putExtraParam

public PersonUpdateParams.Builder putExtraParam(String key,
 Object value)

Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PersonUpdateParams.extraParams for the field documentation.

putAllExtraParam

public PersonUpdateParams.Builder putAllExtraParam(Map<String,Object> map)

Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PersonUpdateParams.extraParams for the field documentation.

setFirstName

public PersonUpdateParams.Builder setFirstName(String firstName)

The person's first name.

setFirstName

public PersonUpdateParams.Builder setFirstName(EmptyParam firstName)

The person's first name.

setFirstNameKana

public PersonUpdateParams.Builder setFirstNameKana(String firstNameKana)

The Kana variation of the person's first name (Japan only).

setFirstNameKana

public PersonUpdateParams.Builder setFirstNameKana(EmptyParam firstNameKana)

The Kana variation of the person's first name (Japan only).

setFirstNameKanji

public PersonUpdateParams.Builder setFirstNameKanji(String firstNameKanji)

The Kanji variation of the person's first name (Japan only).

setFirstNameKanji

public PersonUpdateParams.Builder setFirstNameKanji(EmptyParam firstNameKanji)

The Kanji variation of the person's first name (Japan only).

addFullNameAlias

public PersonUpdateParams.Builder addFullNameAlias(String element)

Add an element to `fullNameAliases` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PersonUpdateParams.fullNameAliases for the field documentation.

addAllFullNameAlias

public PersonUpdateParams.Builder addAllFullNameAlias(List<String> elements)

Add all elements to `fullNameAliases` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PersonUpdateParams.fullNameAliases for the field documentation.

setFullNameAliases

public PersonUpdateParams.Builder setFullNameAliases(EmptyParam fullNameAliases)

A list of alternate names or aliases that the person is known by.

setFullNameAliases

public PersonUpdateParams.Builder setFullNameAliases(List<String> fullNameAliases)

A list of alternate names or aliases that the person is known by.

setGender

public PersonUpdateParams.Builder setGender(String gender)

The person's gender (International regulations require either "male" or "female").

setGender

public PersonUpdateParams.Builder setGender(EmptyParam gender)

The person's gender (International regulations require either "male" or "female").

setIdNumber

public PersonUpdateParams.Builder setIdNumber(String idNumber)

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.

setIdNumber

public PersonUpdateParams.Builder setIdNumber(EmptyParam idNumber)

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.

setIdNumberSecondary

public PersonUpdateParams.Builder setIdNumberSecondary(String idNumberSecondary)

The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js.

setIdNumberSecondary

public PersonUpdateParams.Builder setIdNumberSecondary(EmptyParam idNumberSecondary)

The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js.

setLastName

public PersonUpdateParams.Builder setLastName(String lastName)

The person's last name.

setLastName

public PersonUpdateParams.Builder setLastName(EmptyParam lastName)

The person's last name.

setLastNameKana

public PersonUpdateParams.Builder setLastNameKana(String lastNameKana)

The Kana variation of the person's last name (Japan only).

setLastNameKana

public PersonUpdateParams.Builder setLastNameKana(EmptyParam lastNameKana)

The Kana variation of the person's last name (Japan only).

setLastNameKanji

public PersonUpdateParams.Builder setLastNameKanji(String lastNameKanji)

The Kanji variation of the person's last name (Japan only).

setLastNameKanji

public PersonUpdateParams.Builder setLastNameKanji(EmptyParam lastNameKanji)

The Kanji variation of the person's last name (Japan only).

setMaidenName

public PersonUpdateParams.Builder setMaidenName(String maidenName)

The person's maiden name.

setMaidenName

public PersonUpdateParams.Builder setMaidenName(EmptyParam maidenName)

The person's maiden name.

putMetadata

public PersonUpdateParams.Builder putMetadata(String key,
 String value)

Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PersonUpdateParams.metadata for the field documentation.

putAllMetadata

public PersonUpdateParams.Builder putAllMetadata(Map<String,String> map)

Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PersonUpdateParams.metadata for the field documentation.

setMetadata

public PersonUpdateParams.Builder setMetadata(EmptyParam metadata)

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 to metadata.

setMetadata

public PersonUpdateParams.Builder setMetadata(Map<String,String> metadata)

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 to metadata.

setNationality

public PersonUpdateParams.Builder setNationality(String nationality)

The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

setNationality

public PersonUpdateParams.Builder setNationality(EmptyParam nationality)

The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or "XX" if unavailable.

setPersonToken

public PersonUpdateParams.Builder setPersonToken(String personToken)

A person token, used to securely provide details to the person.

setPersonToken

public PersonUpdateParams.Builder setPersonToken(EmptyParam personToken)

A person token, used to securely provide details to the person.

setPhone

public PersonUpdateParams.Builder setPhone(String phone)

The person's phone number.

setPhone

public PersonUpdateParams.Builder setPhone(EmptyParam phone)

The person's phone number.

setPoliticalExposure

public PersonUpdateParams.Builder setPoliticalExposure(String politicalExposure)

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.

setPoliticalExposure

public PersonUpdateParams.Builder setPoliticalExposure(EmptyParam politicalExposure)

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.

setRegisteredAddress

public PersonUpdateParams.Builder setRegisteredAddress(PersonUpdateParams.RegisteredAddress registeredAddress)

The person's registered address.

setRelationship

public PersonUpdateParams.Builder setRelationship(PersonUpdateParams.Relationship relationship)

The relationship that this person has with the account's legal entity.

setSsnLast4

public PersonUpdateParams.Builder setSsnLast4(String ssnLast4)

The last four digits of the person's Social Security number (U.S. only).

setSsnLast4

public PersonUpdateParams.Builder setSsnLast4(EmptyParam ssnLast4)

The last four digits of the person's Social Security number (U.S. only).

setVerification

public PersonUpdateParams.Builder setVerification(PersonUpdateParams.Verification verification)

The person's verification status.