Package model

Class IdentityEntityForm

java.lang.Object
model.IdentityEntityForm
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]") public class IdentityEntityForm extends Object
Information needed to verify the identity of the entity.

  • Field Details

  • Constructor Details

    • IdentityEntityForm

      public IdentityEntityForm()

  • Method Details

    • title

      public IdentityEntityForm title(String title)

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

    • amexMid

      public IdentityEntityForm amexMid(String amexMid)

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

    • annualCardVolume

      public IdentityEntityForm annualCardVolume(Long annualCardVolume)

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

    • businessAddress

      public IdentityEntityForm businessAddress(IdentityEntityFormBusinessAddress businessAddress)

    • getBusinessAddress

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

    • setBusinessAddress

      public void setBusinessAddress(IdentityEntityFormBusinessAddress businessAddress)

    • businessName

      public IdentityEntityForm businessName(String businessName)

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

    • businessPhone

      public IdentityEntityForm 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)

    • businessTaxId

      public IdentityEntityForm businessTaxId(String businessTaxId)

    • getBusinessTaxId

      @Nullable 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)

    • businessType

      public IdentityEntityForm businessType(IdentityEntityForm.BusinessTypeEnum businessType)

    • getBusinessType

      @Nullable public IdentityEntityForm.BusinessTypeEnum getBusinessType()
      Include the value that applies the best.
      Returns:
      businessType

    • setBusinessType

      public void setBusinessType(IdentityEntityForm.BusinessTypeEnum businessType)

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

    • discoverMid

      public IdentityEntityForm discoverMid(String discoverMid)

    • getDiscoverMid

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

    • setDiscoverMid

      public void setDiscoverMid(String discoverMid)

    • dob

      public IdentityEntityForm dob(IdentityEntityFormDob dob)

    • getDob

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

    • setDob

      public void setDob(IdentityEntityFormDob dob)

    • doingBusinessAs

      public IdentityEntityForm doingBusinessAs(String doingBusinessAs)

    • getDoingBusinessAs

      @Nullable 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)

    • email

      public IdentityEntityForm email(String email)

    • getEmail

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

    • setEmail

      public void setEmail(String email)

    • firstName

      public IdentityEntityForm firstName(String firstName)

    • getFirstName

      @Nullable 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)

    • incorporationDate

      public IdentityEntityForm incorporationDate(IdentityEntityFormIncorporationDate incorporationDate)

    • getIncorporationDate

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

    • setIncorporationDate

      public void setIncorporationDate(IdentityEntityFormIncorporationDate incorporationDate)

    • lastName

      public IdentityEntityForm lastName(String lastName)

    • getLastName

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

    • setLastName

      public void setLastName(String lastName)

    • maxTransactionAmount

      public IdentityEntityForm maxTransactionAmount(Long maxTransactionAmount)

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

    • mcc

      public IdentityEntityForm mcc(String mcc)

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

    • ownershipType

      public IdentityEntityForm ownershipType(IdentityEntityForm.OwnershipTypeEnum ownershipType)

    • 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

    • setOwnershipType

      public void setOwnershipType(IdentityEntityForm.OwnershipTypeEnum ownershipType)

    • personalAddress

      public IdentityEntityForm personalAddress(Address personalAddress)

    • getPersonalAddress

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

    • setPersonalAddress

      public void setPersonalAddress(Address personalAddress)

    • phone

      public IdentityEntityForm phone(String phone)

    • getPhone

      @Nullable 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)

    • shortBusinessName

      public IdentityEntityForm shortBusinessName(String shortBusinessName)

    • getShortBusinessName

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

    • setShortBusinessName

      public void setShortBusinessName(String shortBusinessName)

    • taxAuthority

      public IdentityEntityForm taxAuthority(String taxAuthority)

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

    • taxId

      public IdentityEntityForm taxId(String taxId)

    • getTaxId

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

    • setTaxId

      public void setTaxId(String taxId)

    • url

      public IdentityEntityForm url(String url)

    • getUrl

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

    • setUrl

      public void setUrl(String url)

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