Package model

Class IdentityEntity

java.lang.Object
model.IdentityEntity
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]") public class IdentityEntity extends Object
The underwriting details required to verify the `Identity` of the `Merchant`.

  • Field Details

  • Constructor Details

    • IdentityEntity

      public IdentityEntity()

  • Method Details

    • title

      public IdentityEntity title(String title)

    • 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)

    • firstName

      public IdentityEntity firstName(String firstName)

    • 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)

    • lastName

      public IdentityEntity lastName(String lastName)

    • 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)

    • email

      public IdentityEntity email(String email)

    • 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)

    • businessName

      public IdentityEntity businessName(String businessName)

    • 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)

    • businessType

      public IdentityEntity businessType(String businessType)

    • getBusinessType

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

    • setBusinessType

      public void setBusinessType(String businessType)

    • doingBusinessAs

      public IdentityEntity doingBusinessAs(String doingBusinessAs)

    • 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)

    • phone

      public IdentityEntity phone(String phone)

    • getPhone

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

    • setPhone

      public void setPhone(String phone)

    • businessPhone

      public IdentityEntity businessPhone(String businessPhone)

    • 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)

    • personalAddress

      public IdentityEntity personalAddress(IdentityEntityPersonalAddress personalAddress)

    • getPersonalAddress

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

    • setPersonalAddress

      public void setPersonalAddress(IdentityEntityPersonalAddress personalAddress)

    • businessAddress

      public IdentityEntity businessAddress(IdentityEntityBusinessAddress businessAddress)

    • getBusinessAddress

      @Nullable public IdentityEntityBusinessAddress getBusinessAddress()
      Get businessAddress
      Returns:
      businessAddress

    • setBusinessAddress

      public void setBusinessAddress(IdentityEntityBusinessAddress businessAddress)

    • mcc

      public IdentityEntity mcc(String mcc)

    • 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)

    • dob

      public IdentityEntity dob(IdentityEntityDob dob)

    • getDob

      @Nullable public IdentityEntityDob getDob()
      Get dob
      Returns:
      dob

    • setDob

      public void setDob(IdentityEntityDob dob)

    • 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)

    • amexMid

      public IdentityEntity amexMid(Long amexMid)

    • getAmexMid

      @Nullable public Long getAmexMid()
      Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.
      Returns:
      amexMid

    • setAmexMid

      public void setAmexMid(Long amexMid)

    • discoverMid

      public IdentityEntity discoverMid(Long discoverMid)

    • getDiscoverMid

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

    • setDiscoverMid

      public void setDiscoverMid(Long discoverMid)

    • url

      public IdentityEntity url(String url)

    • getUrl

      @Nullable public String getUrl()
      The URL of the merchant's public website.
      Returns:
      url

    • setUrl

      public void setUrl(String url)

    • annualCardVolume

      public IdentityEntity annualCardVolume(Long annualCardVolume)

    • 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)

    • 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)

    • incorporationDate

      public IdentityEntity incorporationDate(IdentityEntityIncorporationDate incorporationDate)

    • getIncorporationDate

      @Nullable public IdentityEntityIncorporationDate getIncorporationDate()
      Get incorporationDate
      Returns:
      incorporationDate

    • setIncorporationDate

      public void setIncorporationDate(IdentityEntityIncorporationDate incorporationDate)

    • 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)

    • shortBusinessName

      public IdentityEntity shortBusinessName(String shortBusinessName)

    • 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)

    • ownershipType

      public IdentityEntity ownershipType(IdentityEntity.OwnershipTypeEnum ownershipType)

    • 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

    • setOwnershipType

      public void setOwnershipType(IdentityEntity.OwnershipTypeEnum ownershipType)

    • taxAuthority

      public IdentityEntity taxAuthority(String taxAuthority)

    • 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)

    • taxIdProvided

      public IdentityEntity taxIdProvided(Boolean taxIdProvided)

    • getTaxIdProvided

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

    • setTaxIdProvided

      public void setTaxIdProvided(Boolean taxIdProvided)

    • businessTaxIdProvided

      public IdentityEntity businessTaxIdProvided(Boolean businessTaxIdProvided)

    • getBusinessTaxIdProvided

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

    • setBusinessTaxIdProvided

      public void setBusinessTaxIdProvided(Boolean businessTaxIdProvided)

    • 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)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString 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