Package com.stripe.param

Class PersonCollectionCreateParams.Builder

java.lang.Object

com.stripe.param.PersonCollectionCreateParams.Builder

Enclosing class:

PersonCollectionCreateParams

public static class PersonCollectionCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Finalize and obtain parameter instance from this builder.

setAdditionalTosAcceptances

public PersonCollectionCreateParams.Builder setAdditionalTosAcceptances(PersonCollectionCreateParams.AdditionalTosAcceptances additionalTosAcceptances)

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

setAddress

public PersonCollectionCreateParams.Builder setAddress(PersonCollectionCreateParams.Address address)

The person's address.

setAddressKana

public PersonCollectionCreateParams.Builder setAddressKana(PersonCollectionCreateParams.AddressKana addressKana)

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

setAddressKanji

public PersonCollectionCreateParams.Builder setAddressKanji(PersonCollectionCreateParams.AddressKanji addressKanji)

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

setDob

public PersonCollectionCreateParams.Builder setDob(PersonCollectionCreateParams.Dob dob)

The person's date of birth.

setDob

public PersonCollectionCreateParams.Builder setDob(EmptyParam dob)

The person's date of birth.

setDocuments

public PersonCollectionCreateParams.Builder setDocuments(PersonCollectionCreateParams.Documents documents)

Documents that may be submitted to satisfy various informational requests.

setEmail

public PersonCollectionCreateParams.Builder setEmail(String email)

The person's email address.

addExpand

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.expand for the field documentation.

addAllExpand

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.expand for the field documentation.

putExtraParam

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.extraParams for the field documentation.

putAllExtraParam

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.extraParams for the field documentation.

setFirstName

public PersonCollectionCreateParams.Builder setFirstName(String firstName)

The person's first name.

setFirstNameKana

public PersonCollectionCreateParams.Builder setFirstNameKana(String firstNameKana)

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

setFirstNameKanji

public PersonCollectionCreateParams.Builder setFirstNameKanji(String firstNameKanji)

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

addFullNameAlias

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.fullNameAliases for the field documentation.

addAllFullNameAlias

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.fullNameAliases for the field documentation.

setFullNameAliases

public PersonCollectionCreateParams.Builder setFullNameAliases(EmptyParam fullNameAliases)

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

setFullNameAliases

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

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

setGender

public PersonCollectionCreateParams.Builder setGender(String gender)

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

setIdNumber

public PersonCollectionCreateParams.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.

setIdNumberSecondary

public PersonCollectionCreateParams.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.

setLastName

public PersonCollectionCreateParams.Builder setLastName(String lastName)

The person's last name.

setLastNameKana

public PersonCollectionCreateParams.Builder setLastNameKana(String lastNameKana)

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

setLastNameKanji

public PersonCollectionCreateParams.Builder setLastNameKanji(String lastNameKanji)

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

setMaidenName

public PersonCollectionCreateParams.Builder setMaidenName(String maidenName)

The person's maiden name.

putMetadata

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.metadata for the field documentation.

putAllMetadata

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.metadata for the field documentation.

setMetadata

public PersonCollectionCreateParams.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 PersonCollectionCreateParams.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 PersonCollectionCreateParams.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.

setPersonToken

public PersonCollectionCreateParams.Builder setPersonToken(String personToken)

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

setPhone

public PersonCollectionCreateParams.Builder setPhone(String phone)

The person's phone number.

setPoliticalExposure

public PersonCollectionCreateParams.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.

setRegisteredAddress

public PersonCollectionCreateParams.Builder setRegisteredAddress(PersonCollectionCreateParams.RegisteredAddress registeredAddress)

The person's registered address.

setRelationship

public PersonCollectionCreateParams.Builder setRelationship(PersonCollectionCreateParams.Relationship relationship)

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

setSsnLast4

public PersonCollectionCreateParams.Builder setSsnLast4(String ssnLast4)

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

setVerification

public PersonCollectionCreateParams.Builder setVerification(PersonCollectionCreateParams.Verification verification)

The person's verification status.