Package com.stripe.param

Class PersonCollectionCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.PersonCollectionCreateParams
public class PersonCollectionCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static PersonCollectionCreateParams.Builder builder()

    • getAdditionalTosAcceptances

      public PersonCollectionCreateParams.AdditionalTosAcceptances getAdditionalTosAcceptances()
      Details on the legal guardian's acceptance of the required Stripe agreements.

    • 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 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 String getEmail()
      The person's email address.

    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.

    • getExtraParams

      public Map<String,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 String getFirstName()
      The person's first name.

    • getFirstNameKana

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

    • getFirstNameKanji

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

    • getFullNameAliases

      public Object getFullNameAliases()
      A list of alternate names or aliases that the person is known by.

    • getGender

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

    • getIdNumber

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

    • getIdNumberSecondary

      public String getIdNumberSecondary()
      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.

    • getLastName

      public String getLastName()
      The person's last name.

    • getLastNameKana

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

    • getLastNameKanji

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

    • getMaidenName

      public String getMaidenName()
      The person's maiden name.

    • getMetadata

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

    • getNationality

      public 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 String getPersonToken()
      A person token, used to securely provide details to the person.

    • getPhone

      public String getPhone()
      The person's phone number.

    • getPoliticalExposure

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

    • getRegisteredAddress

      public PersonCollectionCreateParams.RegisteredAddress getRegisteredAddress()
      The person's registered address.

    • getRelationship

      public PersonCollectionCreateParams.Relationship getRelationship()
      The relationship that this person has with the account's legal entity.

    • getSsnLast4

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