Package com.stripe.model

Class Person

    • Constructor Detail

      • Person

        public Person()

    • Method Detail

      • delete

        public Person delete()
              throws StripeException
        Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
        Throws:
        StripeException

      • delete

        public Person delete​(RequestOptions options)
              throws StripeException
        Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
        Throws:
        StripeException

      • delete

        public Person delete​(java.util.Map<java.lang.String,​java.lang.Object> params)
              throws StripeException
        Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
        Throws:
        StripeException

      • delete

        public Person delete​(java.util.Map<java.lang.String,​java.lang.Object> params,
                     RequestOptions options)
              throws StripeException
        Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
        Throws:
        StripeException

      • getAccount

        public java.lang.String getAccount()
        The account the person is associated with.

      • getAddress

        public Address getAddress()

      • getAddressKana

        public Person.JapanAddress getAddressKana()
        The Kana variation of the person's address (Japan only).

      • getAddressKanji

        public Person.JapanAddress getAddressKanji()
        The Kanji variation of the person's address (Japan only).

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDeleted

        public java.lang.Boolean getDeleted()
        Always true for a deleted object.

      • getEmail

        public java.lang.String getEmail()
        The person's email address.

      • getFirstName

        public java.lang.String getFirstName()
        The person's first name.

      • getFirstNameKana

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

      • getFirstNameKanji

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

      • getFullNameAliases

        public java.util.List<java.lang.String> getFullNameAliases()
        A list of alternate names or aliases that the person is known by.

      • getFutureRequirements

        public Person.FutureRequirements getFutureRequirements()
        Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

      • getGender

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

      • getIdNumberProvided

        public java.lang.Boolean getIdNumberProvided()
        Whether the person's id_number was provided.

      • getLastName

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

      • getLastNameKana

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

      • getLastNameKanji

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

      • getMaidenName

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

      • getNationality

        public java.lang.String getNationality()
        The country where the person is a national.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to person.

      • getPhone

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

      • getPoliticalExposure

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

        One of existing, or none.

      • getRequirements

        public Person.Requirements getRequirements()
        Information about the requirements for this person, including what information needs to be collected, and by when.

      • getSsnLast4Provided

        public java.lang.Boolean getSsnLast4Provided()
        Whether the last four digits of the person's Social Security number have been provided (U.S. only).

      • setAccount

        public void setAccount​(java.lang.String account)
        The account the person is associated with.

      • setAddress

        public void setAddress​(Address address)

      • setAddressKana

        public void setAddressKana​(Person.JapanAddress addressKana)
        The Kana variation of the person's address (Japan only).

      • setAddressKanji

        public void setAddressKanji​(Person.JapanAddress addressKanji)
        The Kanji variation of the person's address (Japan only).

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDeleted

        public void setDeleted​(java.lang.Boolean deleted)
        Always true for a deleted object.

      • setEmail

        public void setEmail​(java.lang.String email)
        The person's email address.

      • setFirstName

        public void setFirstName​(java.lang.String firstName)
        The person's first name.

      • setFirstNameKana

        public void setFirstNameKana​(java.lang.String firstNameKana)
        The Kana variation of the person's first name (Japan only).

      • setFirstNameKanji

        public void setFirstNameKanji​(java.lang.String firstNameKanji)
        The Kanji variation of the person's first name (Japan only).

      • setFullNameAliases

        public void setFullNameAliases​(java.util.List<java.lang.String> fullNameAliases)
        A list of alternate names or aliases that the person is known by.

      • setFutureRequirements

        public void setFutureRequirements​(Person.FutureRequirements futureRequirements)
        Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.

      • setGender

        public void setGender​(java.lang.String gender)
        The person's gender (International regulations require either "male" or "female").

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setIdNumberProvided

        public void setIdNumberProvided​(java.lang.Boolean idNumberProvided)
        Whether the person's id_number was provided.

      • setLastName

        public void setLastName​(java.lang.String lastName)
        The person's last name.

      • setLastNameKana

        public void setLastNameKana​(java.lang.String lastNameKana)
        The Kana variation of the person's last name (Japan only).

      • setLastNameKanji

        public void setLastNameKanji​(java.lang.String lastNameKanji)
        The Kanji variation of the person's last name (Japan only).

      • setMaidenName

        public void setMaidenName​(java.lang.String maidenName)
        The person's maiden name.

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.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.

      • setNationality

        public void setNationality​(java.lang.String nationality)
        The country where the person is a national.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to person.

      • setPhone

        public void setPhone​(java.lang.String phone)
        The person's phone number.

      • setPoliticalExposure

        public void setPoliticalExposure​(java.lang.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.

        One of existing, or none.

      • setRequirements

        public void setRequirements​(Person.Requirements requirements)
        Information about the requirements for this person, including what information needs to be collected, and by when.

      • setSsnLast4Provided

        public void setSsnLast4Provided​(java.lang.Boolean ssnLast4Provided)
        Whether the last four digits of the person's Social Security number have been provided (U.S. only).

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.String> 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.
        Specified by:
        getMetadata in interface MetadataStore<Person>