com.plaid.client.model

Class PartnerCustomerCreateRequest

java.lang.Object

com.plaid.client.model.PartnerCustomerCreateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class PartnerCustomerCreateRequest
extends Object

Request schema for `/partner/customer/create`.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ADDRESS
static String	SERIALIZED_NAME_APPLICATION_NAME
static String	SERIALIZED_NAME_ASSETS_UNDER_MANAGEMENT
static String	SERIALIZED_NAME_BILLING_CONTACT
static String	SERIALIZED_NAME_CLIENT_ID
static String	SERIALIZED_NAME_COMPANY_NAME
static String	SERIALIZED_NAME_CREATE_LINK_CUSTOMIZATION
static String	SERIALIZED_NAME_CUSTOMER_SUPPORT_INFO
static String	SERIALIZED_NAME_IS_BANK_ADDENDUM_COMPLETED
static String	SERIALIZED_NAME_IS_DILIGENCE_ATTESTED
static String	SERIALIZED_NAME_LEGAL_ENTITY_NAME
static String	SERIALIZED_NAME_LOGO
static String	SERIALIZED_NAME_PRODUCTS
static String	SERIALIZED_NAME_REDIRECT_URIS
static String	SERIALIZED_NAME_SECRET
static String	SERIALIZED_NAME_TECHNICAL_CONTACT
static String	SERIALIZED_NAME_WEBSITE

Constructor Summary

Constructors

Constructor and Description
PartnerCustomerCreateRequest()

Method Summary

Modifier and Type	Method and Description
PartnerCustomerCreateRequest	addProductsItem(Products productsItem)
PartnerCustomerCreateRequest	addRedirectUrisItem(String redirectUrisItem)
PartnerCustomerCreateRequest	address(PartnerEndCustomerAddress address)
PartnerCustomerCreateRequest	applicationName(String applicationName)
PartnerCustomerCreateRequest	assetsUnderManagement(PartnerEndCustomerAssetsUnderManagement assetsUnderManagement)
PartnerCustomerCreateRequest	billingContact(PartnerEndCustomerBillingContact billingContact)
PartnerCustomerCreateRequest	clientId(String clientId)
PartnerCustomerCreateRequest	companyName(String companyName)
PartnerCustomerCreateRequest	createLinkCustomization(Boolean createLinkCustomization)
PartnerCustomerCreateRequest	customerSupportInfo(PartnerEndCustomerCustomerSupportInfo customerSupportInfo)
boolean	equals(Object o)
PartnerEndCustomerAddress	getAddress() Get address
String	getApplicationName() The name of the end customer's application.
PartnerEndCustomerAssetsUnderManagement	getAssetsUnderManagement() Get assetsUnderManagement
PartnerEndCustomerBillingContact	getBillingContact() Get billingContact
String	getClientId() Your Plaid API `client_id`.
String	getCompanyName() The company name of the end customer being created.
Boolean	getCreateLinkCustomization() If `true`, the end customer's default Link customization will be set to match the partner's.
PartnerEndCustomerCustomerSupportInfo	getCustomerSupportInfo() Get customerSupportInfo
Boolean	getIsBankAddendumCompleted() Denotes whether the partner has forwarded the Plaid bank addendum to the end customer.
Boolean	getIsDiligenceAttested() Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.
String	getLegalEntityName() The end customer's legal name.
String	getLogo() Base64-encoded representation of the end customer's logo.
List<Products>	getProducts() The products to be enabled for the end customer.
List<String>	getRedirectUris() A list of URIs indicating the destination(s) where a user can be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview.
String	getSecret() Your Plaid API `secret`.
PartnerEndCustomerTechnicalContact	getTechnicalContact() Get technicalContact
String	getWebsite() The end customer's website.
int	hashCode()
PartnerCustomerCreateRequest	isBankAddendumCompleted(Boolean isBankAddendumCompleted)
PartnerCustomerCreateRequest	isDiligenceAttested(Boolean isDiligenceAttested)
PartnerCustomerCreateRequest	legalEntityName(String legalEntityName)
PartnerCustomerCreateRequest	logo(String logo)
PartnerCustomerCreateRequest	products(List<Products> products)
PartnerCustomerCreateRequest	redirectUris(List<String> redirectUris)
PartnerCustomerCreateRequest	secret(String secret)
void	setAddress(PartnerEndCustomerAddress address)
void	setApplicationName(String applicationName)
void	setAssetsUnderManagement(PartnerEndCustomerAssetsUnderManagement assetsUnderManagement)
void	setBillingContact(PartnerEndCustomerBillingContact billingContact)
void	setClientId(String clientId)
void	setCompanyName(String companyName)
void	setCreateLinkCustomization(Boolean createLinkCustomization)
void	setCustomerSupportInfo(PartnerEndCustomerCustomerSupportInfo customerSupportInfo)
void	setIsBankAddendumCompleted(Boolean isBankAddendumCompleted)
void	setIsDiligenceAttested(Boolean isDiligenceAttested)
void	setLegalEntityName(String legalEntityName)
void	setLogo(String logo)
void	setProducts(List<Products> products)
void	setRedirectUris(List<String> redirectUris)
void	setSecret(String secret)
void	setTechnicalContact(PartnerEndCustomerTechnicalContact technicalContact)
void	setWebsite(String website)
PartnerCustomerCreateRequest	technicalContact(PartnerEndCustomerTechnicalContact technicalContact)
String	toString()
PartnerCustomerCreateRequest	website(String website)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_CLIENT_ID

public static final String SERIALIZED_NAME_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SECRET

public static final String SERIALIZED_NAME_SECRET

See Also:

Constant Field Values

SERIALIZED_NAME_COMPANY_NAME

public static final String SERIALIZED_NAME_COMPANY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_IS_DILIGENCE_ATTESTED

public static final String SERIALIZED_NAME_IS_DILIGENCE_ATTESTED

See Also:

Constant Field Values

SERIALIZED_NAME_PRODUCTS

public static final String SERIALIZED_NAME_PRODUCTS

See Also:

Constant Field Values

SERIALIZED_NAME_CREATE_LINK_CUSTOMIZATION

public static final String SERIALIZED_NAME_CREATE_LINK_CUSTOMIZATION

See Also:

Constant Field Values

SERIALIZED_NAME_LOGO

public static final String SERIALIZED_NAME_LOGO

See Also:

Constant Field Values

SERIALIZED_NAME_LEGAL_ENTITY_NAME

public static final String SERIALIZED_NAME_LEGAL_ENTITY_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_WEBSITE

public static final String SERIALIZED_NAME_WEBSITE

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICATION_NAME

public static final String SERIALIZED_NAME_APPLICATION_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_TECHNICAL_CONTACT

public static final String SERIALIZED_NAME_TECHNICAL_CONTACT

See Also:

Constant Field Values

SERIALIZED_NAME_BILLING_CONTACT

public static final String SERIALIZED_NAME_BILLING_CONTACT

See Also:

Constant Field Values

SERIALIZED_NAME_CUSTOMER_SUPPORT_INFO

public static final String SERIALIZED_NAME_CUSTOMER_SUPPORT_INFO

See Also:

Constant Field Values

SERIALIZED_NAME_ADDRESS

public static final String SERIALIZED_NAME_ADDRESS

See Also:

Constant Field Values

SERIALIZED_NAME_IS_BANK_ADDENDUM_COMPLETED

public static final String SERIALIZED_NAME_IS_BANK_ADDENDUM_COMPLETED

See Also:

Constant Field Values

SERIALIZED_NAME_ASSETS_UNDER_MANAGEMENT

public static final String SERIALIZED_NAME_ASSETS_UNDER_MANAGEMENT

See Also:

Constant Field Values

SERIALIZED_NAME_REDIRECT_URIS

public static final String SERIALIZED_NAME_REDIRECT_URIS

See Also:

Constant Field Values

Constructor Detail

PartnerCustomerCreateRequest

public PartnerCustomerCreateRequest()

Method Detail

clientId

public PartnerCustomerCreateRequest clientId(String clientId)

getClientId

@Nullable
public String getClientId()

Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

clientId

setClientId

public void setClientId(String clientId)

secret

public PartnerCustomerCreateRequest secret(String secret)

getSecret

@Nullable
public String getSecret()

Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

secret

setSecret

public void setSecret(String secret)

companyName

public PartnerCustomerCreateRequest companyName(String companyName)

getCompanyName

public String getCompanyName()

The company name of the end customer being created. This will be used to display the end customer in the Plaid Dashboard. It will not be shown to end users.

Returns:

companyName

setCompanyName

public void setCompanyName(String companyName)

isDiligenceAttested

public PartnerCustomerCreateRequest isDiligenceAttested(Boolean isDiligenceAttested)

getIsDiligenceAttested

public Boolean getIsDiligenceAttested()

Denotes whether or not the partner has completed attestation of diligence for the end customer to be created.

Returns:

isDiligenceAttested

setIsDiligenceAttested

public void setIsDiligenceAttested(Boolean isDiligenceAttested)

products

public PartnerCustomerCreateRequest products(List<Products> products)

addProductsItem

public PartnerCustomerCreateRequest addProductsItem(Products productsItem)

getProducts

public List<Products> getProducts()

The products to be enabled for the end customer.

Returns:

products

setProducts

public void setProducts(List<Products> products)

createLinkCustomization

public PartnerCustomerCreateRequest createLinkCustomization(Boolean createLinkCustomization)

getCreateLinkCustomization

@Nullable
public Boolean getCreateLinkCustomization()

If `true`, the end customer's default Link customization will be set to match the partner's. You can always change the end customer's Link customization in the Plaid Dashboard. See the [Link Customization docs](https://plaid.com/docs/link/customization/) for more information.

Returns:

createLinkCustomization

setCreateLinkCustomization

public void setCreateLinkCustomization(Boolean createLinkCustomization)

logo

public PartnerCustomerCreateRequest logo(String logo)

getLogo

@Nullable
public String getLogo()

Base64-encoded representation of the end customer's logo. Must be a PNG of size 1024x1024 under 4MB. The logo will be shared with financial institutions and shown to the end user during Link flows. A logo is required if `create_link_customization` is `true`. If `create_link_customization` is `false` and the logo is omitted, a stock logo will be used.

Returns:

logo

setLogo

public void setLogo(String logo)

legalEntityName

public PartnerCustomerCreateRequest legalEntityName(String legalEntityName)

getLegalEntityName

public String getLegalEntityName()

The end customer's legal name. This will be shared with financial institutions as part of the OAuth registration process. It will not be shown to end users.

Returns:

legalEntityName

setLegalEntityName

public void setLegalEntityName(String legalEntityName)

website

public PartnerCustomerCreateRequest website(String website)

getWebsite

public String getWebsite()

The end customer's website.

Returns:

website

setWebsite

public void setWebsite(String website)

applicationName

public PartnerCustomerCreateRequest applicationName(String applicationName)

getApplicationName

public String getApplicationName()

The name of the end customer's application. This will be shown to end users when they go through the Plaid Link flow.

Returns:

applicationName

setApplicationName

public void setApplicationName(String applicationName)

technicalContact

public PartnerCustomerCreateRequest technicalContact(PartnerEndCustomerTechnicalContact technicalContact)

getTechnicalContact

@Nullable
public PartnerEndCustomerTechnicalContact getTechnicalContact()

Get technicalContact

Returns:

technicalContact

setTechnicalContact

public void setTechnicalContact(PartnerEndCustomerTechnicalContact technicalContact)

billingContact

public PartnerCustomerCreateRequest billingContact(PartnerEndCustomerBillingContact billingContact)

getBillingContact

@Nullable
public PartnerEndCustomerBillingContact getBillingContact()

Get billingContact

Returns:

billingContact

setBillingContact

public void setBillingContact(PartnerEndCustomerBillingContact billingContact)

customerSupportInfo

public PartnerCustomerCreateRequest customerSupportInfo(PartnerEndCustomerCustomerSupportInfo customerSupportInfo)

getCustomerSupportInfo

@Nullable
public PartnerEndCustomerCustomerSupportInfo getCustomerSupportInfo()

Get customerSupportInfo

Returns:

customerSupportInfo

setCustomerSupportInfo

public void setCustomerSupportInfo(PartnerEndCustomerCustomerSupportInfo customerSupportInfo)

address

public PartnerCustomerCreateRequest address(PartnerEndCustomerAddress address)

getAddress

public PartnerEndCustomerAddress getAddress()

Get address

Returns:

address

setAddress

public void setAddress(PartnerEndCustomerAddress address)

isBankAddendumCompleted

public PartnerCustomerCreateRequest isBankAddendumCompleted(Boolean isBankAddendumCompleted)

getIsBankAddendumCompleted

public Boolean getIsBankAddendumCompleted()

Denotes whether the partner has forwarded the Plaid bank addendum to the end customer.

Returns:

isBankAddendumCompleted

setIsBankAddendumCompleted

public void setIsBankAddendumCompleted(Boolean isBankAddendumCompleted)

assetsUnderManagement

public PartnerCustomerCreateRequest assetsUnderManagement(PartnerEndCustomerAssetsUnderManagement assetsUnderManagement)

getAssetsUnderManagement

@Nullable
public PartnerEndCustomerAssetsUnderManagement getAssetsUnderManagement()

Get assetsUnderManagement

Returns:

assetsUnderManagement

setAssetsUnderManagement

public void setAssetsUnderManagement(PartnerEndCustomerAssetsUnderManagement assetsUnderManagement)

redirectUris

public PartnerCustomerCreateRequest redirectUris(List<String> redirectUris)

addRedirectUrisItem

public PartnerCustomerCreateRequest addRedirectUrisItem(String redirectUrisItem)

getRedirectUris

@Nullable
public List<String> getRedirectUris()

A list of URIs indicating the destination(s) where a user can be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. URIs should not contain any query parameters. When used in Production or Development, URIs must use https. To specify any subdomain, use `*` as a wildcard character, e.g. `https://_*.example.com/oauth.html`. To modify redirect URIs for an end customer after creating them, go to the end customer's [API page](https://dashboard.plaid.com/team/api) in the Dashboard.

Returns:

redirectUris

setRedirectUris

public void setRedirectUris(List<String> redirectUris)

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