Package model

Class CreateIdentityRequestEntity

java.lang.Object

model.CreateIdentityRequestEntity

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-06-24T13:03:18.088665-07:00[America/Los_Angeles]")
public class CreateIdentityRequestEntity
extends Object

The underwriting details required to verify the `Identity` of the `Merchant`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateIdentityRequestEntity.BusinessTypeEnum	Include the value that best applies to the merchant.
static class	CreateIdentityRequestEntity.CustomTypeAdapterFactory
static enum	CreateIdentityRequestEntity.OwnershipTypeEnum	Avalible values include: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ANNUAL_CARD_VOLUME
static final String	SERIALIZED_NAME_BUSINESS_ADDRESS
static final String	SERIALIZED_NAME_BUSINESS_NAME
static final String	SERIALIZED_NAME_BUSINESS_PHONE
static final String	SERIALIZED_NAME_BUSINESS_TAX_ID
static final String	SERIALIZED_NAME_BUSINESS_TYPE
static final String	SERIALIZED_NAME_DEFAULT_STATEMENT_DESCRIPTOR
static final String	SERIALIZED_NAME_DOB
static final String	SERIALIZED_NAME_DOING_BUSINESS_AS
static final String	SERIALIZED_NAME_EMAIL
static final String	SERIALIZED_NAME_FIRST_NAME
static final String	SERIALIZED_NAME_HAS_ACCEPTED_CREDIT_CARDS_PREVIOUSLY
static final String	SERIALIZED_NAME_INCORPORATION_DATE
static final String	SERIALIZED_NAME_LAST_NAME
static final String	SERIALIZED_NAME_MAX_TRANSACTION_AMOUNT
static final String	SERIALIZED_NAME_MCC
static final String	SERIALIZED_NAME_OWNERSHIP_TYPE
static final String	SERIALIZED_NAME_PERSONAL_ADDRESS
static final String	SERIALIZED_NAME_PHONE
static final String	SERIALIZED_NAME_PRINCIPAL_PERCENTAGE_OWNERSHIP
static final String	SERIALIZED_NAME_TAX_ID
static final String	SERIALIZED_NAME_TITLE
static final String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor	Description
CreateIdentityRequestEntity()

Method Summary

Modifier and Type	Method	Description
CreateIdentityRequestEntity	annualCardVolume(Long annualCardVolume)
CreateIdentityRequestEntity	businessAddress(CreateIdentityRequestEntityBusinessAddress businessAddress)
CreateIdentityRequestEntity	businessName(String businessName)
CreateIdentityRequestEntity	businessPhone(String businessPhone)
CreateIdentityRequestEntity	businessTaxId(String businessTaxId)
CreateIdentityRequestEntity	businessType(CreateIdentityRequestEntity.BusinessTypeEnum businessType)
CreateIdentityRequestEntity	defaultStatementDescriptor(String defaultStatementDescriptor)
CreateIdentityRequestEntity	dob(CreateIdentityRequestEntityDob dob)
CreateIdentityRequestEntity	doingBusinessAs(String doingBusinessAs)
CreateIdentityRequestEntity	email(String email)
boolean	equals(Object o)
CreateIdentityRequestEntity	firstName(String firstName)
static CreateIdentityRequestEntity	fromJson(String jsonString)	Create an instance of CreateIdentityRequestEntity given an JSON string
Long	getAnnualCardVolume()	The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).
CreateIdentityRequestEntityBusinessAddress	getBusinessAddress()	Get businessAddress
String	getBusinessName()	The merchant's legal business name (max 120 characters).<ul><li>If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner's legal first name, last name and middle initial.
String	getBusinessPhone()	Customer service phone number where the merchant can be reached (max 10 characters).
String	getBusinessTaxId()	Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN).
CreateIdentityRequestEntity.BusinessTypeEnum	getBusinessType()	Include the value that best applies to the merchant.
String	getDefaultStatementDescriptor()	The description of the merchant that appears on the buyer's bank or card statement.
CreateIdentityRequestEntityDob	getDob()	Get dob
String	getDoingBusinessAs()	Alternate names of the business.
String	getEmail()	The email address of the principal control owner where they can be reached (max 100 characters).
String	getFirstName()	The legal first name of the merchant's control owner (max 20 characters).
Boolean	getHasAcceptedCreditCardsPreviously()	Defaults to **false** if not passed.
CreateIdentityRequestEntityIncorporationDate	getIncorporationDate()	Get incorporationDate
String	getLastName()	The legal last name of the merchant's control owner (max 20 characters).
Long	getMaxTransactionAmount()	The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).
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.
CreateIdentityRequestEntity.OwnershipTypeEnum	getOwnershipType()	Avalible values include: <ul><li><strong>PUBLIC</strong> to indicate a publicly-traded company.<li><strong>PRIVATE</strong> for privately-held businesses.
CreateIdentityRequestEntityPersonalAddress	getPersonalAddress()	Get personalAddress
String	getPhone()	The principal control owner's phone number (max 10 characters).
Long	getPrincipalPercentageOwnership()	Percentage of the company owned by the principal control owner (min 0; max 100).
String	getTaxId()	Pass one of the following values (nine digits):<ul><li>Social Security Number (SSN)<li>Tax Identification Number (TIN)<li>Individual Taxpayer Identification Number (ITIN)</ul>
String	getTitle()	The corporate title of the control owner (e.g.
String	getUrl()	The URL of the merchant's public website.
CreateIdentityRequestEntity	hasAcceptedCreditCardsPreviously(Boolean hasAcceptedCreditCardsPreviously)
int	hashCode()
CreateIdentityRequestEntity	incorporationDate(CreateIdentityRequestEntityIncorporationDate incorporationDate)
CreateIdentityRequestEntity	lastName(String lastName)
CreateIdentityRequestEntity	maxTransactionAmount(Long maxTransactionAmount)
CreateIdentityRequestEntity	mcc(String mcc)
CreateIdentityRequestEntity	ownershipType(CreateIdentityRequestEntity.OwnershipTypeEnum ownershipType)
CreateIdentityRequestEntity	personalAddress(CreateIdentityRequestEntityPersonalAddress personalAddress)
CreateIdentityRequestEntity	phone(String phone)
CreateIdentityRequestEntity	principalPercentageOwnership(Long principalPercentageOwnership)
void	setAnnualCardVolume(Long annualCardVolume)
void	setBusinessAddress(CreateIdentityRequestEntityBusinessAddress businessAddress)
void	setBusinessName(String businessName)
void	setBusinessPhone(String businessPhone)
void	setBusinessTaxId(String businessTaxId)
void	setBusinessType(CreateIdentityRequestEntity.BusinessTypeEnum businessType)
void	setDefaultStatementDescriptor(String defaultStatementDescriptor)
void	setDob(CreateIdentityRequestEntityDob dob)
void	setDoingBusinessAs(String doingBusinessAs)
void	setEmail(String email)
void	setFirstName(String firstName)
void	setHasAcceptedCreditCardsPreviously(Boolean hasAcceptedCreditCardsPreviously)
void	setIncorporationDate(CreateIdentityRequestEntityIncorporationDate incorporationDate)
void	setLastName(String lastName)
void	setMaxTransactionAmount(Long maxTransactionAmount)
void	setMcc(String mcc)
void	setOwnershipType(CreateIdentityRequestEntity.OwnershipTypeEnum ownershipType)
void	setPersonalAddress(CreateIdentityRequestEntityPersonalAddress personalAddress)
void	setPhone(String phone)
void	setPrincipalPercentageOwnership(Long principalPercentageOwnership)
void	setTaxId(String taxId)
void	setTitle(String title)
void	setUrl(String url)
CreateIdentityRequestEntity	taxId(String taxId)
CreateIdentityRequestEntity	title(String title)
String	toJson()	Convert an instance of CreateIdentityRequestEntity to an JSON string
String	toString()
CreateIdentityRequestEntity	url(String url)
static void	validateJsonObject(com.google.gson.JsonObject jsonObj)	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_LAST_NAME

public static final String SERIALIZED_NAME_LAST_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_MAX_TRANSACTION_AMOUNT

public static final String SERIALIZED_NAME_MAX_TRANSACTION_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_HAS_ACCEPTED_CREDIT_CARDS_PREVIOUSLY

public static final String SERIALIZED_NAME_HAS_ACCEPTED_CREDIT_CARDS_PREVIOUSLY

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_STATEMENT_DESCRIPTOR

public static final String SERIALIZED_NAME_DEFAULT_STATEMENT_DESCRIPTOR

See Also:

• Constant Field Values

SERIALIZED_NAME_PERSONAL_ADDRESS

public static final String SERIALIZED_NAME_PERSONAL_ADDRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_INCORPORATION_DATE

public static final String SERIALIZED_NAME_INCORPORATION_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_BUSINESS_ADDRESS

public static final String SERIALIZED_NAME_BUSINESS_ADDRESS

See Also:

• Constant Field Values

SERIALIZED_NAME_OWNERSHIP_TYPE

public static final String SERIALIZED_NAME_OWNERSHIP_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_TITLE

public static final String SERIALIZED_NAME_TITLE

See Also:

• Constant Field Values

SERIALIZED_NAME_BUSINESS_TAX_ID

public static final String SERIALIZED_NAME_BUSINESS_TAX_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_DOING_BUSINESS_AS

public static final String SERIALIZED_NAME_DOING_BUSINESS_AS

See Also:

• Constant Field Values

SERIALIZED_NAME_PRINCIPAL_PERCENTAGE_OWNERSHIP

public static final String SERIALIZED_NAME_PRINCIPAL_PERCENTAGE_OWNERSHIP

See Also:

• Constant Field Values

SERIALIZED_NAME_EMAIL

public static final String SERIALIZED_NAME_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_MCC

public static final String SERIALIZED_NAME_MCC

See Also:

• Constant Field Values

SERIALIZED_NAME_PHONE

public static final String SERIALIZED_NAME_PHONE

See Also:

• Constant Field Values

SERIALIZED_NAME_BUSINESS_NAME

public static final String SERIALIZED_NAME_BUSINESS_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_TAX_ID

public static final String SERIALIZED_NAME_TAX_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_BUSINESS_TYPE

public static final String SERIALIZED_NAME_BUSINESS_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_BUSINESS_PHONE

public static final String SERIALIZED_NAME_BUSINESS_PHONE

See Also:

• Constant Field Values

SERIALIZED_NAME_DOB

public static final String SERIALIZED_NAME_DOB

See Also:

• Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_ANNUAL_CARD_VOLUME

public static final String SERIALIZED_NAME_ANNUAL_CARD_VOLUME

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CreateIdentityRequestEntity

public CreateIdentityRequestEntity()

Method Details

lastName

public CreateIdentityRequestEntity lastName(String lastName)

getLastName

@Nonnull
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 CreateIdentityRequestEntity 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)

hasAcceptedCreditCardsPreviously

public CreateIdentityRequestEntity hasAcceptedCreditCardsPreviously(Boolean hasAcceptedCreditCardsPreviously)

getHasAcceptedCreditCardsPreviously

@Nullable
public Boolean getHasAcceptedCreditCardsPreviously()

Defaults to **false** if not passed.

Returns:

hasAcceptedCreditCardsPreviously

setHasAcceptedCreditCardsPreviously

public void setHasAcceptedCreditCardsPreviously(Boolean hasAcceptedCreditCardsPreviously)

defaultStatementDescriptor

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

personalAddress

public CreateIdentityRequestEntity personalAddress(CreateIdentityRequestEntityPersonalAddress personalAddress)

getPersonalAddress

@Nullable
public CreateIdentityRequestEntityPersonalAddress getPersonalAddress()

Get personalAddress

Returns:

personalAddress

setPersonalAddress

public void setPersonalAddress(CreateIdentityRequestEntityPersonalAddress personalAddress)

incorporationDate

public CreateIdentityRequestEntity incorporationDate(CreateIdentityRequestEntityIncorporationDate incorporationDate)

getIncorporationDate

@Nullable
public CreateIdentityRequestEntityIncorporationDate getIncorporationDate()

Get incorporationDate

Returns:

incorporationDate

setIncorporationDate

public void setIncorporationDate(CreateIdentityRequestEntityIncorporationDate incorporationDate)

businessAddress

public CreateIdentityRequestEntity businessAddress(CreateIdentityRequestEntityBusinessAddress businessAddress)

getBusinessAddress

@Nullable
public CreateIdentityRequestEntityBusinessAddress getBusinessAddress()

Get businessAddress

Returns:

businessAddress

setBusinessAddress

public void setBusinessAddress(CreateIdentityRequestEntityBusinessAddress businessAddress)

ownershipType

public CreateIdentityRequestEntity ownershipType(CreateIdentityRequestEntity.OwnershipTypeEnum ownershipType)

getOwnershipType

@Nullable
public CreateIdentityRequestEntity.OwnershipTypeEnum getOwnershipType()

Avalible values include: <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(CreateIdentityRequestEntity.OwnershipTypeEnum ownershipType)

firstName

public CreateIdentityRequestEntity firstName(String firstName)

getFirstName

@Nonnull
public String getFirstName()

The legal first name of the merchant's control owner (max 20 characters).

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

title

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

businessTaxId

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

doingBusinessAs

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

principalPercentageOwnership

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

email

public CreateIdentityRequestEntity email(String email)

getEmail

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

mcc

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

phone

public CreateIdentityRequestEntity phone(String phone)

getPhone

@Nonnull
public String getPhone()

The principal control owner's phone number (max 10 characters).

Returns:

phone

setPhone

public void setPhone(String phone)

businessName

public CreateIdentityRequestEntity businessName(String businessName)

getBusinessName

@Nullable
public String getBusinessName()

The merchant's legal business name (max 120 characters).<ul><li>If **INDIVIDUAL_SOLE_PROPRIETORSHIP**, pass the owner's legal first name, last name and middle initial.

Returns:

businessName

setBusinessName

public void setBusinessName(String businessName)

taxId

public CreateIdentityRequestEntity taxId(String taxId)

getTaxId

@Nullable
public String getTaxId()

Pass one of the following values (nine digits):<ul><li>Social Security Number (SSN)<li>Tax Identification Number (TIN)<li>Individual Taxpayer Identification Number (ITIN)</ul>

Returns:

taxId

setTaxId

public void setTaxId(String taxId)

businessType

public CreateIdentityRequestEntity businessType(CreateIdentityRequestEntity.BusinessTypeEnum businessType)

getBusinessType

@Nullable
public CreateIdentityRequestEntity.BusinessTypeEnum getBusinessType()

Include the value that best applies to the merchant.

Returns:

businessType

setBusinessType

public void setBusinessType(CreateIdentityRequestEntity.BusinessTypeEnum businessType)

businessPhone

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

dob

public CreateIdentityRequestEntity dob(CreateIdentityRequestEntityDob dob)

getDob

@Nullable
public CreateIdentityRequestEntityDob getDob()

Get dob

Returns:

dob

setDob

public void setDob(CreateIdentityRequestEntityDob dob)

url

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

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 CreateIdentityRequestEntity

fromJson

public static CreateIdentityRequestEntity fromJson(String jsonString)
                                            throws IOException

Create an instance of CreateIdentityRequestEntity given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateIdentityRequestEntity

Throws:

IOException - if the JSON string is invalid with respect to CreateIdentityRequestEntity

toJson

public String toJson()

Convert an instance of CreateIdentityRequestEntity to an JSON string

Returns:

JSON string