Package model

Class IdentityEntity

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class IdentityEntity
extends Object
    The underwriting details required to verify the `Identity`.

    • Constructor Detail

      • IdentityEntity

        public IdentityEntity()

    • Method Detail

      • getAnnualCardVolume

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

      • setAnnualCardVolume

        public void setAnnualCardVolume​(Long annualCardVolume)

      • getBusinessName

        @Nullable
public String getBusinessName()
        The merchant's legal business name (max 120 characters).<ul><li>If <strong>INDIVIDUAL_SOLE_PROPRIETORSHIP</strong>, pass the owner's legal first name, last name and middle initial.
        Returns:
        businessName

      • setBusinessName

        public void setBusinessName​(String businessName)

      • getBusinessPhone

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

      • setBusinessPhone

        public void setBusinessPhone​(String businessPhone)

      • getBusinessTaxIdProvided

        @Nullable
public Boolean getBusinessTaxIdProvided()
        Details if the `business_tax_id` was provided.
        Returns:
        businessTaxIdProvided

      • setBusinessTaxIdProvided

        public void setBusinessTaxIdProvided​(Boolean businessTaxIdProvided)

      • getBusinessType

        @Nullable
public String getBusinessType()
        Include the value that best applies to the merchant.
        Returns:
        businessType

      • setBusinessType

        public void setBusinessType​(String businessType)

      • defaultStatementDescriptor

        public IdentityEntity defaultStatementDescriptor​(String defaultStatementDescriptor)

      • getDefaultStatementDescriptor

        @Nullable
public String getDefaultStatementDescriptor()
        The description of the merchant that appears on the buyer's bank or card statement.
        Returns:
        defaultStatementDescriptor

      • setDefaultStatementDescriptor

        public void setDefaultStatementDescriptor​(String defaultStatementDescriptor)

      • getDiscoverMid

        @Nullable
public Long getDiscoverMid()
        Assigned discoverMid value.
        Returns:
        discoverMid

      • setDiscoverMid

        public void setDiscoverMid​(Long discoverMid)

      • getDoingBusinessAs

        @Nullable
public String getDoingBusinessAs()
        Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters).
        Returns:
        doingBusinessAs

      • setDoingBusinessAs

        public void setDoingBusinessAs​(String doingBusinessAs)

      • getEmail

        @Nullable
public String getEmail()
        The email address of the principal control owner where they can be reached (max 100 characters).
        Returns:
        email

      • setEmail

        public void setEmail​(String email)

      • getFirstName

        @Nullable
public String getFirstName()
        The legal first name of the merchant's control owner (max 20 characters).
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)

      • hasAcceptedCreditCardsPreviously

        public IdentityEntity hasAcceptedCreditCardsPreviously​(Boolean hasAcceptedCreditCardsPreviously)

      • getHasAcceptedCreditCardsPreviously

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

      • setHasAcceptedCreditCardsPreviously

        public void setHasAcceptedCreditCardsPreviously​(Boolean hasAcceptedCreditCardsPreviously)

      • getLastName

        @Nullable
public String getLastName()
        The legal last name of the merchant's control owner (max 20 characters).
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)

      • maxTransactionAmount

        public IdentityEntity maxTransactionAmount​(Long maxTransactionAmount)

      • getMaxTransactionAmount

        @Nullable
public Long getMaxTransactionAmount()
        The maximum amount (in cents) that can be charged for a single transaction (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)) that this merchant will be classified under.
        Returns:
        mcc

      • setMcc

        public void setMcc​(String mcc)

      • getOwnershipType

        @Nullable
public IdentityEntity.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

      • getPhone

        @Nullable
public String getPhone()
        The principal control owner's phone number (max 10 characters).
        Returns:
        phone

      • setPhone

        public void setPhone​(String phone)

      • principalPercentageOwnership

        public IdentityEntity principalPercentageOwnership​(Long principalPercentageOwnership)

      • getPrincipalPercentageOwnership

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

      • setPrincipalPercentageOwnership

        public void setPrincipalPercentageOwnership​(Long principalPercentageOwnership)

      • getShortBusinessName

        @Nullable
public String getShortBusinessName()
        Abbreviated names of the business. If there are no abbreviated name, leave this field blank.
        Returns:
        shortBusinessName

      • setShortBusinessName

        public void setShortBusinessName​(String shortBusinessName)

      • getTaxAuthority

        @Nullable
public String getTaxAuthority()
        <ul><li>Only required when onboarding a merchant with a <tt>MCC</tt> of <strong>9311</strong>.<li> The <tt>tax_authority</tt> is the tax gathering entity (e.g San Francisco Water Authority).
        Returns:
        taxAuthority

      • setTaxAuthority

        public void setTaxAuthority​(String taxAuthority)

      • getTaxIdProvided

        @Nullable
public Boolean getTaxIdProvided()
        Details if the `tax_id` was provided.
        Returns:
        taxIdProvided

      • setTaxIdProvided

        public void setTaxIdProvided​(Boolean taxIdProvided)

      • getTitle

        @Nullable
public String getTitle()
        The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).
        Returns:
        title

      • setTitle

        public void setTitle​(String title)

      • getUrl

        @Nullable
public String getUrl()
        The URL of the merchant's public website.
        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 IdentityEntity

      • fromJson

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

      • toJson

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