Package com.stripe.param

Class TokenCreateParams.Person.Builder

java.lang.Object

com.stripe.param.TokenCreateParams.Person.Builder

Enclosing class:

TokenCreateParams.Person

public static class TokenCreateParams.Person.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Finalize and obtain parameter instance from this builder.

setAdditionalTosAcceptances

public TokenCreateParams.Person.Builder setAdditionalTosAcceptances(TokenCreateParams.Person.AdditionalTosAcceptances additionalTosAcceptances)

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

setAddress

public TokenCreateParams.Person.Builder setAddress(TokenCreateParams.Person.Address address)

The person's address.

setAddressKana

public TokenCreateParams.Person.Builder setAddressKana(TokenCreateParams.Person.AddressKana addressKana)

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

setAddressKanji

public TokenCreateParams.Person.Builder setAddressKanji(TokenCreateParams.Person.AddressKanji addressKanji)

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

setDob

public TokenCreateParams.Person.Builder setDob(TokenCreateParams.Person.Dob dob)

The person's date of birth.

setDob

public TokenCreateParams.Person.Builder setDob(EmptyParam dob)

The person's date of birth.

setDocuments

public TokenCreateParams.Person.Builder setDocuments(TokenCreateParams.Person.Documents documents)

Documents that may be submitted to satisfy various informational requests.

setEmail

public TokenCreateParams.Person.Builder setEmail(String email)

The person's email address.

putExtraParam

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

putAllExtraParam

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

setFirstName

public TokenCreateParams.Person.Builder setFirstName(String firstName)

The person's first name.

setFirstNameKana

public TokenCreateParams.Person.Builder setFirstNameKana(String firstNameKana)

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

setFirstNameKanji

public TokenCreateParams.Person.Builder setFirstNameKanji(String firstNameKanji)

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

addFullNameAlias

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

addAllFullNameAlias

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

setFullNameAliases

public TokenCreateParams.Person.Builder setFullNameAliases(EmptyParam fullNameAliases)

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

setFullNameAliases

public TokenCreateParams.Person.Builder setFullNameAliases(List<String> fullNameAliases)

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

setGender

public TokenCreateParams.Person.Builder setGender(String gender)

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

setIdNumber

public TokenCreateParams.Person.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 TokenCreateParams.Person.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 TokenCreateParams.Person.Builder setLastName(String lastName)

The person's last name.

setLastNameKana

public TokenCreateParams.Person.Builder setLastNameKana(String lastNameKana)

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

setLastNameKanji

public TokenCreateParams.Person.Builder setLastNameKanji(String lastNameKanji)

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

setMaidenName

public TokenCreateParams.Person.Builder setMaidenName(String maidenName)

The person's maiden name.

putMetadata

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

putAllMetadata

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

setMetadata

public TokenCreateParams.Person.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 TokenCreateParams.Person.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 TokenCreateParams.Person.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.

setPhone

public TokenCreateParams.Person.Builder setPhone(String phone)

The person's phone number.

setPoliticalExposure

public TokenCreateParams.Person.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 TokenCreateParams.Person.Builder setRegisteredAddress(TokenCreateParams.Person.RegisteredAddress registeredAddress)

The person's registered address.

setRelationship

public TokenCreateParams.Person.Builder setRelationship(TokenCreateParams.Person.Relationship relationship)

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

setSsnLast4

public TokenCreateParams.Person.Builder setSsnLast4(String ssnLast4)

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

setVerification

public TokenCreateParams.Person.Builder setVerification(TokenCreateParams.Person.Verification verification)

The person's verification status.