Package model

Class IdentityEntityForm

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class IdentityEntityForm
extends Object
    Information needed to verify the identity of the entity.

    • Constructor Detail

      • IdentityEntityForm

        public IdentityEntityForm()

    • Method Detail

      • getAmexMid

        @Nullable
public String getAmexMid()
        Assigned amex_Mid value. If included must be 10 or 11 digits.
        Returns:
        amexMid

      • setAmexMid

        public void setAmexMid​(String amexMid)

      • getAnnualCardVolume

        @Nullable
public Long getAnnualCardVolume()
        Approximate annual credit card sales expected to be processed in cents by this merchant (max 19 characters).
        Returns:
        annualCardVolume

      • setAnnualCardVolume

        public void setAnnualCardVolume​(Long annualCardVolume)

      • getBusinessName

        @Nullable
public String getBusinessName()
        Merchant's full legal business name (If **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP**, input first name, Full legal last name and middle initial; max 120 characters)
        Returns:
        businessName

      • setBusinessName

        public void setBusinessName​(String businessName)

      • getBusinessPhone

        @Nonnull
public String getBusinessPhone()
        Customer service phone number where the merchant can be reached (max 10 characters).
        Returns:
        businessPhone

      • setBusinessPhone

        public void setBusinessPhone​(String businessPhone)

      • getBusinessTaxId

        @Nonnull
public String getBusinessTaxId()
        Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the `business_type` is **INDIVIDUAL\\_SOLE\\_PROPRIETORSHIP** and they do not have an EIN, use the sole proprietor's Social Security Number (SSN).
        Returns:
        businessTaxId

      • setBusinessTaxId

        public void setBusinessTaxId​(String businessTaxId)

      • defaultStatementDescriptor

        public IdentityEntityForm defaultStatementDescriptor​(String defaultStatementDescriptor)

      • getDefaultStatementDescriptor

        @Nullable
public String getDefaultStatementDescriptor()
        Billing description displayed on the buyer's bank or card statement (Length must be between 1 and 20 characters).
        Returns:
        defaultStatementDescriptor

      • setDefaultStatementDescriptor

        public void setDefaultStatementDescriptor​(String defaultStatementDescriptor)

      • getDiscoverMid

        @Nullable
public String getDiscoverMid()
        Assigned Discover Mid value.
        Returns:
        discoverMid

      • setDiscoverMid

        public void setDiscoverMid​(String discoverMid)

      • getDoingBusinessAs

        @Nonnull
public String getDoingBusinessAs()
        Alternate name of the business. If no other name is used use the same value used in `business_name` (max 60 characters).
        Returns:
        doingBusinessAs

      • setDoingBusinessAs

        public void setDoingBusinessAs​(String doingBusinessAs)

      • getEmail

        @Nonnull
public String getEmail()
        Control person's email address where they can be reached (max 100 characters).
        Returns:
        email

      • setEmail

        public void setEmail​(String email)

      • getFirstName

        @Nonnull
public String getFirstName()
        Full legal first name of the merchant's principal representative (max 20 characters).
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)

      • hasAcceptedCreditCardsPreviously

        public IdentityEntityForm hasAcceptedCreditCardsPreviously​(Boolean hasAcceptedCreditCardsPreviously)

      • getHasAcceptedCreditCardsPreviously

        @Nullable
public Boolean getHasAcceptedCreditCardsPreviously()
        Defaults to **false** if not passed.
        Returns:
        hasAcceptedCreditCardsPreviously

      • setHasAcceptedCreditCardsPreviously

        public void setHasAcceptedCreditCardsPreviously​(Boolean hasAcceptedCreditCardsPreviously)

      • getLastName

        @Nonnull
public String getLastName()
        Full legal last name of the merchant's principal representative (max 20 characters).
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)

      • getMaxTransactionAmount

        @Nullable
public Long getMaxTransactionAmount()
        Maximum amount that can be transacted for a single transaction in cents (max 12 characters).
        Returns:
        maxTransactionAmount

      • setMaxTransactionAmount

        public void setMaxTransactionAmount​(Long maxTransactionAmount)

      • getMcc

        @Nullable
public String getMcc()
        The Merchant Category Code ([MCC](http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf)) the merchant is classified under.
        Returns:
        mcc

      • setMcc

        public void setMcc​(String mcc)

      • getOwnershipType

        @Nullable
public IdentityEntityForm.OwnershipTypeEnum getOwnershipType()
        Values can be either: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.
        Returns:
        ownershipType

      • getPersonalAddress

        @Nullable
public Address getPersonalAddress()
        Get personalAddress
        Returns:
        personalAddress

      • setPersonalAddress

        public void setPersonalAddress​(Address personalAddress)

      • getPhone

        @Nonnull
public String getPhone()
        Principal's phone number (max 10 characters).
        Returns:
        phone

      • setPhone

        public void setPhone​(String phone)

      • principalPercentageOwnership

        public IdentityEntityForm principalPercentageOwnership​(Long principalPercentageOwnership)

      • getPrincipalPercentageOwnership

        @Nullable
public Long getPrincipalPercentageOwnership()
        Percentage of company owned by the principal (min 0; max 100). minimum: 0 maximum: 100
        Returns:
        principalPercentageOwnership

      • setPrincipalPercentageOwnership

        public void setPrincipalPercentageOwnership​(Long principalPercentageOwnership)

      • getShortBusinessName

        @Nullable
public String getShortBusinessName()
        The short version of the business name. (Defaults to **null**).
        Returns:
        shortBusinessName

      • setShortBusinessName

        public void setShortBusinessName​(String shortBusinessName)

      • getTaxAuthority

        @Nullable
public String getTaxAuthority()
        Used and required when onboarding a `Merchant` with a `MCC` of **9311**. The `tax_authority` is the tax gathering entity (e.g San Francisco Water Authority).
        Returns:
        taxAuthority

      • setTaxAuthority

        public void setTaxAuthority​(String taxAuthority)

      • getTaxId

        @Nonnull
public String getTaxId()
        Used to verify `tax_id` was provided.
        Returns:
        taxId

      • setTaxId

        public void setTaxId​(String taxId)

      • getTitle

        @Nullable
public String getTitle()
        Control person's corporate title or role (i.e. Chief Executive Officer, CFO, etc.; max 60 characters).
        Returns:
        title

      • setTitle

        public void setTitle​(String title)

      • getUrl

        @Nullable
public String getUrl()
        Merchant's publicly available website (max 100 characters).
        Returns:
        url

      • setUrl

        public void setUrl​(String url)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        IOException - if the JSON Object is invalid with respect to IdentityEntityForm

      • fromJson

        public static IdentityEntityForm fromJson​(String jsonString)
                                   throws IOException
        Create an instance of IdentityEntityForm given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of IdentityEntityForm
        Throws:
        IOException - if the JSON string is invalid with respect to IdentityEntityForm

      • toJson

        public String toJson()
        Convert an instance of IdentityEntityForm to an JSON string
        Returns:
        JSON string