LinkTokenCreateRequest (com.plaid:plaid-java 18.0.0 API)

java.lang.Object
- com.plaid.client.model.LinkTokenCreateRequest

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

LinkTokenCreateRequest defines the request schema for `/link/token/create`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACCESS_TOKEN`
`static String`	`SERIALIZED_NAME_ACCOUNT_FILTERS`
`static String`	`SERIALIZED_NAME_ADDITIONAL_CONSENTED_PRODUCTS`
`static String`	`SERIALIZED_NAME_ANDROID_PACKAGE_NAME`
`static String`	`SERIALIZED_NAME_AUTH`
`static String`	`SERIALIZED_NAME_BASE_REPORT`
`static String`	`SERIALIZED_NAME_CLIENT_ID`
`static String`	`SERIALIZED_NAME_CLIENT_NAME`
`static String`	`SERIALIZED_NAME_CONSUMER_REPORT_PERMISSIBLE_PURPOSE`
`static String`	`SERIALIZED_NAME_COUNTRY_CODES`
`static String`	`SERIALIZED_NAME_DEPOSIT_SWITCH`
`static String`	`SERIALIZED_NAME_EMPLOYMENT`
`static String`	`SERIALIZED_NAME_EU_CONFIG`
`static String`	`SERIALIZED_NAME_HOSTED_LINK`
`static String`	`SERIALIZED_NAME_IDENTITY_VERIFICATION`
`static String`	`SERIALIZED_NAME_INCOME_VERIFICATION`
`static String`	`SERIALIZED_NAME_INSTITUTION_DATA`
`static String`	`SERIALIZED_NAME_INSTITUTION_ID`
`static String`	`SERIALIZED_NAME_INVESTMENTS`
`static String`	`SERIALIZED_NAME_INVESTMENTS_AUTH`
`static String`	`SERIALIZED_NAME_LANGUAGE`
`static String`	`SERIALIZED_NAME_LINK_CUSTOMIZATION_NAME`
`static String`	`SERIALIZED_NAME_OPTIONAL_PRODUCTS`
`static String`	`SERIALIZED_NAME_PAYMENT_INITIATION`
`static String`	`SERIALIZED_NAME_PRODUCTS`
`static String`	`SERIALIZED_NAME_REDIRECT_URI`
`static String`	`SERIALIZED_NAME_REQUIRED_IF_SUPPORTED_PRODUCTS`
`static String`	`SERIALIZED_NAME_SECRET`
`static String`	`SERIALIZED_NAME_STATEMENTS`
`static String`	`SERIALIZED_NAME_TRANSFER`
`static String`	`SERIALIZED_NAME_UPDATE`
`static String`	`SERIALIZED_NAME_USER`
`static String`	`SERIALIZED_NAME_USER_TOKEN`
`static String`	`SERIALIZED_NAME_WEBHOOK`

Constructor Summary

Constructors
Constructor and Description

LinkTokenCreateRequest()

Constructors
Constructor and Description
`LinkTokenCreateRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinkTokenCreateRequest`	`accessToken(String accessToken)`
`LinkTokenCreateRequest`	`accountFilters(LinkTokenAccountFilters accountFilters)`
`LinkTokenCreateRequest`	`addAdditionalConsentedProductsItem(Products additionalConsentedProductsItem)`
`LinkTokenCreateRequest`	`addCountryCodesItem(CountryCode countryCodesItem)`
`LinkTokenCreateRequest`	`additionalConsentedProducts(List<Products> additionalConsentedProducts)`
`LinkTokenCreateRequest`	`addOptionalProductsItem(Products optionalProductsItem)`
`LinkTokenCreateRequest`	`addProductsItem(Products productsItem)`
`LinkTokenCreateRequest`	`addRequiredIfSupportedProductsItem(Products requiredIfSupportedProductsItem)`
`LinkTokenCreateRequest`	`androidPackageName(String androidPackageName)`
`LinkTokenCreateRequest`	`auth(LinkTokenCreateRequestAuth auth)`
`LinkTokenCreateRequest`	`baseReport(LinkTokenCreateRequestBaseReport baseReport)`
`LinkTokenCreateRequest`	`clientId(String clientId)`
`LinkTokenCreateRequest`	`clientName(String clientName)`
`LinkTokenCreateRequest`	`consumerReportPermissiblePurpose(ConsumerReportPermissiblePurpose consumerReportPermissiblePurpose)`
`LinkTokenCreateRequest`	`countryCodes(List<CountryCode> countryCodes)`
`LinkTokenCreateRequest`	`depositSwitch(LinkTokenCreateRequestDepositSwitch depositSwitch)`
`LinkTokenCreateRequest`	`employment(LinkTokenCreateRequestEmployment employment)`
`boolean`	`equals(Object o)`
`LinkTokenCreateRequest`	`euConfig(LinkTokenEUConfig euConfig)`
`String`	`getAccessToken()` The `access_token` associated with the Item to update or reference, used when updating, modifying, or accessing an existing `access_token`.
`LinkTokenAccountFilters`	`getAccountFilters()` Get accountFilters
`List<Products>`	`getAdditionalConsentedProducts()` (Beta) This field has no effect unless you are participating in the [Data Transparency](https://plaid.com/docs/link/data-transparency-messaging-migration-guide) beta program.
`String`	`getAndroidPackageName()` The name of your app's Android package.
`LinkTokenCreateRequestAuth`	`getAuth()` Get auth
`LinkTokenCreateRequestBaseReport`	`getBaseReport()` Get baseReport
`String`	`getClientId()` Your Plaid API `client_id`.
`String`	`getClientName()` The name of your application, as it should be displayed in Link.
`ConsumerReportPermissiblePurpose`	`getConsumerReportPermissiblePurpose()` Get consumerReportPermissiblePurpose
`List<CountryCode>`	`getCountryCodes()` Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard.
`LinkTokenCreateRequestDepositSwitch`	`getDepositSwitch()` Get depositSwitch
`LinkTokenCreateRequestEmployment`	`getEmployment()` Get employment
`LinkTokenEUConfig`	`getEuConfig()` Get euConfig
`LinkTokenCreateHostedLink`	`getHostedLink()` Get hostedLink
`LinkTokenCreateRequestIdentityVerification`	`getIdentityVerification()` Get identityVerification
`LinkTokenCreateRequestIncomeVerification`	`getIncomeVerification()` Get incomeVerification
`LinkTokenCreateInstitutionData`	`getInstitutionData()` Get institutionData
`String`	`getInstitutionId()` Used for certain Europe-only configurations, as well as certain legacy use cases in other regions.
`LinkTokenInvestments`	`getInvestments()` Get investments
`LinkTokenInvestmentsAuth`	`getInvestmentsAuth()` Get investmentsAuth
`String`	`getLanguage()` The language that Link should be displayed in.
`String`	`getLinkCustomizationName()` The name of the Link customization from the Plaid Dashboard to be applied to Link.
`List<Products>`	`getOptionalProducts()` List of Plaid product(s) that you may wish to use but that are not required for your use case.
`LinkTokenCreateRequestPaymentInitiation`	`getPaymentInitiation()` Get paymentInitiation
`List<Products>`	`getProducts()` List of Plaid product(s) you wish to use.
`String`	`getRedirectUri()` A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview.
`List<Products>`	`getRequiredIfSupportedProducts()` List of Plaid product(s) you wish to use only if the institution and account(s) selected by the user support the product.
`String`	`getSecret()` Your Plaid API `secret`.
`LinkTokenCreateRequestStatements`	`getStatements()` Get statements
`LinkTokenCreateRequestTransfer`	`getTransfer()` Get transfer
`LinkTokenCreateRequestUpdate`	`getUpdate()` Get update
`LinkTokenCreateRequestUser`	`getUser()` Get user
`String`	`getUserToken()` A user token generated using `/user/create`.
`String`	`getWebhook()` The destination URL to which any webhooks should be sent.
`int`	`hashCode()`
`LinkTokenCreateRequest`	`hostedLink(LinkTokenCreateHostedLink hostedLink)`
`LinkTokenCreateRequest`	`identityVerification(LinkTokenCreateRequestIdentityVerification identityVerification)`
`LinkTokenCreateRequest`	`incomeVerification(LinkTokenCreateRequestIncomeVerification incomeVerification)`
`LinkTokenCreateRequest`	`institutionData(LinkTokenCreateInstitutionData institutionData)`
`LinkTokenCreateRequest`	`institutionId(String institutionId)`
`LinkTokenCreateRequest`	`investments(LinkTokenInvestments investments)`
`LinkTokenCreateRequest`	`investmentsAuth(LinkTokenInvestmentsAuth investmentsAuth)`
`LinkTokenCreateRequest`	`language(String language)`
`LinkTokenCreateRequest`	`linkCustomizationName(String linkCustomizationName)`
`LinkTokenCreateRequest`	`optionalProducts(List<Products> optionalProducts)`
`LinkTokenCreateRequest`	`paymentInitiation(LinkTokenCreateRequestPaymentInitiation paymentInitiation)`
`LinkTokenCreateRequest`	`products(List<Products> products)`
`LinkTokenCreateRequest`	`redirectUri(String redirectUri)`
`LinkTokenCreateRequest`	`requiredIfSupportedProducts(List<Products> requiredIfSupportedProducts)`
`LinkTokenCreateRequest`	`secret(String secret)`
`void`	`setAccessToken(String accessToken)`
`void`	`setAccountFilters(LinkTokenAccountFilters accountFilters)`
`void`	`setAdditionalConsentedProducts(List<Products> additionalConsentedProducts)`
`void`	`setAndroidPackageName(String androidPackageName)`
`void`	`setAuth(LinkTokenCreateRequestAuth auth)`
`void`	`setBaseReport(LinkTokenCreateRequestBaseReport baseReport)`
`void`	`setClientId(String clientId)`
`void`	`setClientName(String clientName)`
`void`	`setConsumerReportPermissiblePurpose(ConsumerReportPermissiblePurpose consumerReportPermissiblePurpose)`
`void`	`setCountryCodes(List<CountryCode> countryCodes)`
`void`	`setDepositSwitch(LinkTokenCreateRequestDepositSwitch depositSwitch)`
`void`	`setEmployment(LinkTokenCreateRequestEmployment employment)`
`void`	`setEuConfig(LinkTokenEUConfig euConfig)`
`void`	`setHostedLink(LinkTokenCreateHostedLink hostedLink)`
`void`	`setIdentityVerification(LinkTokenCreateRequestIdentityVerification identityVerification)`
`void`	`setIncomeVerification(LinkTokenCreateRequestIncomeVerification incomeVerification)`
`void`	`setInstitutionData(LinkTokenCreateInstitutionData institutionData)`
`void`	`setInstitutionId(String institutionId)`
`void`	`setInvestments(LinkTokenInvestments investments)`
`void`	`setInvestmentsAuth(LinkTokenInvestmentsAuth investmentsAuth)`
`void`	`setLanguage(String language)`
`void`	`setLinkCustomizationName(String linkCustomizationName)`
`void`	`setOptionalProducts(List<Products> optionalProducts)`
`void`	`setPaymentInitiation(LinkTokenCreateRequestPaymentInitiation paymentInitiation)`
`void`	`setProducts(List<Products> products)`
`void`	`setRedirectUri(String redirectUri)`
`void`	`setRequiredIfSupportedProducts(List<Products> requiredIfSupportedProducts)`
`void`	`setSecret(String secret)`
`void`	`setStatements(LinkTokenCreateRequestStatements statements)`
`void`	`setTransfer(LinkTokenCreateRequestTransfer transfer)`
`void`	`setUpdate(LinkTokenCreateRequestUpdate update)`
`void`	`setUser(LinkTokenCreateRequestUser user)`
`void`	`setUserToken(String userToken)`
`void`	`setWebhook(String webhook)`
`LinkTokenCreateRequest`	`statements(LinkTokenCreateRequestStatements statements)`
`String`	`toString()`
`LinkTokenCreateRequest`	`transfer(LinkTokenCreateRequestTransfer transfer)`
`LinkTokenCreateRequest`	`update(LinkTokenCreateRequestUpdate update)`
`LinkTokenCreateRequest`	`user(LinkTokenCreateRequestUser user)`
`LinkTokenCreateRequest`	`userToken(String userToken)`
`LinkTokenCreateRequest`	`webhook(String webhook)`

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_CLIENT_NAME
```
public static final String SERIALIZED_NAME_CLIENT_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LANGUAGE
```
public static final String SERIALIZED_NAME_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_COUNTRY_CODES
```
public static final String SERIALIZED_NAME_COUNTRY_CODES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER
```
public static final String SERIALIZED_NAME_USER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PRODUCTS
```
public static final String SERIALIZED_NAME_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REQUIRED_IF_SUPPORTED_PRODUCTS
```
public static final String SERIALIZED_NAME_REQUIRED_IF_SUPPORTED_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OPTIONAL_PRODUCTS
```
public static final String SERIALIZED_NAME_OPTIONAL_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ADDITIONAL_CONSENTED_PRODUCTS
```
public static final String SERIALIZED_NAME_ADDITIONAL_CONSENTED_PRODUCTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WEBHOOK
```
public static final String SERIALIZED_NAME_WEBHOOK
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCESS_TOKEN
```
public static final String SERIALIZED_NAME_ACCESS_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LINK_CUSTOMIZATION_NAME
```
public static final String SERIALIZED_NAME_LINK_CUSTOMIZATION_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REDIRECT_URI
```
public static final String SERIALIZED_NAME_REDIRECT_URI
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ANDROID_PACKAGE_NAME
```
public static final String SERIALIZED_NAME_ANDROID_PACKAGE_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_DATA
```
public static final String SERIALIZED_NAME_INSTITUTION_DATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_FILTERS
```
public static final String SERIALIZED_NAME_ACCOUNT_FILTERS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EU_CONFIG
```
public static final String SERIALIZED_NAME_EU_CONFIG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INSTITUTION_ID
```
public static final String SERIALIZED_NAME_INSTITUTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYMENT_INITIATION
```
public static final String SERIALIZED_NAME_PAYMENT_INITIATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DEPOSIT_SWITCH
```
public static final String SERIALIZED_NAME_DEPOSIT_SWITCH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EMPLOYMENT
```
public static final String SERIALIZED_NAME_EMPLOYMENT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INCOME_VERIFICATION
```
public static final String SERIALIZED_NAME_INCOME_VERIFICATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_BASE_REPORT
```
public static final String SERIALIZED_NAME_BASE_REPORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CONSUMER_REPORT_PERMISSIBLE_PURPOSE
```
public static final String SERIALIZED_NAME_CONSUMER_REPORT_PERMISSIBLE_PURPOSE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTH
```
public static final String SERIALIZED_NAME_AUTH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSFER
```
public static final String SERIALIZED_NAME_TRANSFER
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UPDATE
```
public static final String SERIALIZED_NAME_UPDATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_IDENTITY_VERIFICATION
```
public static final String SERIALIZED_NAME_IDENTITY_VERIFICATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATEMENTS
```
public static final String SERIALIZED_NAME_STATEMENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_USER_TOKEN
```
public static final String SERIALIZED_NAME_USER_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INVESTMENTS
```
public static final String SERIALIZED_NAME_INVESTMENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INVESTMENTS_AUTH
```
public static final String SERIALIZED_NAME_INVESTMENTS_AUTH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HOSTED_LINK
```
public static final String SERIALIZED_NAME_HOSTED_LINK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LinkTokenCreateRequest
```
public LinkTokenCreateRequest()
```
- Method Detail
  - clientId
```
public LinkTokenCreateRequest 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 LinkTokenCreateRequest 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)
```
  - clientName
```
public LinkTokenCreateRequest clientName(String clientName)
```
  - getClientName
```
public String getClientName()
```
    The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display \"This Application\" instead.
    
    Returns:
    
    clientName
  - setClientName
```
public void setClientName(String clientName)
```
  - language
```
public LinkTokenCreateRequest language(String language)
```
  - getLanguage
```
public String getLanguage()
```
    The language that Link should be displayed in. When initializing with Identity Verification, this field is not used; for more details, see [Identity Verification supported languages](https://www.plaid.com/docs/identity-verification/#supported-languages). Supported languages are: - Danish (`'da'`) - Dutch (`'nl'`) - English (`'en'`) - Estonian (`'et'`) - French (`'fr'`) - German (`'de'`) - Italian (`'it'`) - Latvian (`'lv'`) - Lithuanian (`'lt'`) - Norwegian (`'no'`) - Polish (`'pl'`) - Portuguese (`'pt'`) - Romanian (`'ro'`) - Spanish (`'es'`) - Swedish (`'sv'`) When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(String language)
```
  - countryCodes
```
public LinkTokenCreateRequest countryCodes(List<CountryCode> countryCodes)
```
  - addCountryCodesItem
```
public LinkTokenCreateRequest addCountryCodesItem(CountryCode countryCodesItem)
```
  - getCountryCodes
```
public List<CountryCode> getCountryCodes()
```
    Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. For a complete mapping of supported products by country, see https://plaid.com/global/. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. Access to European institutions requires additional compliance steps. To request access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow. If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`, or the customization may not be applied. If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`.
    
    Returns:
    
    countryCodes
  - setCountryCodes
```
public void setCountryCodes(List<CountryCode> countryCodes)
```
  - user
```
public LinkTokenCreateRequest user(LinkTokenCreateRequestUser user)
```
  - getUser
```
public LinkTokenCreateRequestUser getUser()
```
    Get user
    
    Returns:
    
    user
  - setUser
```
public void setUser(LinkTokenCreateRequestUser user)
```
  - products
```
public LinkTokenCreateRequest products(List<Products> products)
```
  - addProductsItem
```
public LinkTokenCreateRequest addProductsItem(Products productsItem)
```
  - getProducts
```
@Nullable
public List<Products> getProducts()
```
    List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted (unless you are using update mode to add Income or Assets to an Item); required otherwise. `balance` is *not* a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized. The products specified here will determine which institutions will be available to your users in Link. Only institutions that support *all* requested products can be selected; a if a user attempts to select an institution that does not support a listed product, a \"Connectivity not supported\" error message will appear in Link. To maximize the number of institutions available, initialize Link with the minimal product set required for your use case. Additional products can be included via the [`optional_products`](https://plaid.com/docs/api/tokens/#link-token-create-request-optional-products) or [`required_if_supported_products`](https://plaid.com/docs/api/tokens/#link-token-create-request-required-if-supported-products) fields, or can be initialized by calling the endpoint after obtaining an access token. For details and exceptions, see [Choosing when to initialize products](https://plaid.com/docs/link/initializing-products/). Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if `auth` is specified as a product, even though these institutions do not contain `auth` in their product array. In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`.
    
    Returns:
    
    products
  - setProducts
```
public void setProducts(List<Products> products)
```
  - requiredIfSupportedProducts
```
public LinkTokenCreateRequest requiredIfSupportedProducts(List<Products> requiredIfSupportedProducts)
```
  - addRequiredIfSupportedProductsItem
```
public LinkTokenCreateRequest addRequiredIfSupportedProductsItem(Products requiredIfSupportedProductsItem)
```
  - getRequiredIfSupportedProducts
```
@Nullable
public List<Products> getRequiredIfSupportedProducts()
```
    List of Plaid product(s) you wish to use only if the institution and account(s) selected by the user support the product. Institutions that do not support these products will still be shown in Link. The products will only be extracted and billed if the user selects an institution and account type that supports them. There should be no overlap between this array and the `products`, `optional_products`, or `additional_consented_products` arrays. The `products` array must have at least one product. For more details on using this feature, see [Required if Supported Products](https://www.plaid.com/docs/link/initializing-products/#required-if-supported-products).
    
    Returns:
    
    requiredIfSupportedProducts
  - setRequiredIfSupportedProducts
```
public void setRequiredIfSupportedProducts(List<Products> requiredIfSupportedProducts)
```
  - optionalProducts
```
public LinkTokenCreateRequest optionalProducts(List<Products> optionalProducts)
```
  - addOptionalProductsItem
```
public LinkTokenCreateRequest addOptionalProductsItem(Products optionalProductsItem)
```
  - getOptionalProducts
```
@Nullable
public List<Products> getOptionalProducts()
```
    List of Plaid product(s) that you may wish to use but that are not required for your use case. Plaid will attempt to fetch data for these products on a best-effort basis, and failure to support these products will not affect Item creation. There should be no overlap between this array and the `products`, `required_if_supported_products`, or `additional_consented_products` arrays. The `products` array must have at least one product. For more details on using this feature, see [Optional Products](https://www.plaid.com/docs/link/initializing-products/#optional-products).
    
    Returns:
    
    optionalProducts
  - setOptionalProducts
```
public void setOptionalProducts(List<Products> optionalProducts)
```
  - additionalConsentedProducts
```
public LinkTokenCreateRequest additionalConsentedProducts(List<Products> additionalConsentedProducts)
```
  - addAdditionalConsentedProductsItem
```
public LinkTokenCreateRequest addAdditionalConsentedProductsItem(Products additionalConsentedProductsItem)
```
  - getAdditionalConsentedProducts
```
@Nullable
public List<Products> getAdditionalConsentedProducts()
```
    (Beta) This field has no effect unless you are participating in the [Data Transparency](https://plaid.com/docs/link/data-transparency-messaging-migration-guide) beta program. List of additional Plaid product(s) you wish to collect consent for. These products will not be billed until you start using them by calling the relevant endpoints. `balance` is *not* a valid value, the Balance product does not require explicit initialization and will automatically have consent collected. Institutions that do not support these products will still be shown in Link. There should be no overlap between this array and the `products` or `required_if_supported_products` arrays.
    
    Returns:
    
    additionalConsentedProducts
  - setAdditionalConsentedProducts
```
public void setAdditionalConsentedProducts(List<Products> additionalConsentedProducts)
```
  - webhook
```
public LinkTokenCreateRequest webhook(String webhook)
```
  - getWebhook
```
@Nullable
public String getWebhook()
```
    The destination URL to which any webhooks should be sent. Note that webhooks for Payment Initiation (e-wallet transactions only), Transfer, Bank Transfer (including Auth micro-deposit notification webhooks) and Identity Verification are configured via the Dashboard instead.
    
    Returns:
    
    webhook
  - setWebhook
```
public void setWebhook(String webhook)
```
  - accessToken
```
public LinkTokenCreateRequest accessToken(String accessToken)
```
  - getAccessToken
```
@Nullable
public String getAccessToken()
```
    The `access_token` associated with the Item to update or reference, used when updating, modifying, or accessing an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link for a returning user as part of the Transfer UI flow.
    
    Returns:
    
    accessToken
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
  - linkCustomizationName
```
public LinkTokenCreateRequest linkCustomizationName(String linkCustomizationName)
```
  - getLinkCustomizationName
```
@Nullable
public String getLinkCustomizationName()
```
    The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the `default` customization will be used. When using a Link customization, the language in the customization must match the language selected via the `language` parameter, and the countries in the customization should match the country codes selected via `country_codes`.
    
    Returns:
    
    linkCustomizationName
  - setLinkCustomizationName
```
public void setLinkCustomizationName(String linkCustomizationName)
```
  - redirectUri
```
public LinkTokenCreateRequest redirectUri(String redirectUri)
```
  - getRedirectUri
```
@Nullable
public String getRedirectUri()
```
    A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The `redirect_uri` should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `https://_*.example.com/oauth.html`. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](https://dashboard.plaid.com/team/api). If initializing on Android, `android_package_name` must be specified instead and `redirect_uri` should be left blank.
    
    Returns:
    
    redirectUri
  - setRedirectUri
```
public void setRedirectUri(String redirectUri)
```
  - androidPackageName
```
public LinkTokenCreateRequest androidPackageName(String androidPackageName)
```
  - getAndroidPackageName
```
@Nullable
public String getAndroidPackageName()
```
    The name of your app's Android package. Required if using the `link_token` to initialize Link on Android. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](https://dashboard.plaid.com/team/api). When creating a `link_token` for initializing Link on other platforms, `android_package_name` must be left blank and `redirect_uri` should be used instead.
    
    Returns:
    
    androidPackageName
  - setAndroidPackageName
```
public void setAndroidPackageName(String androidPackageName)
```
  - institutionData
```
public LinkTokenCreateRequest institutionData(LinkTokenCreateInstitutionData institutionData)
```
  - getInstitutionData
```
@Nullable
public LinkTokenCreateInstitutionData getInstitutionData()
```
    Get institutionData
    
    Returns:
    
    institutionData
  - setInstitutionData
```
public void setInstitutionData(LinkTokenCreateInstitutionData institutionData)
```
  - accountFilters
```
public LinkTokenCreateRequest accountFilters(LinkTokenAccountFilters accountFilters)
```
  - getAccountFilters
```
@Nullable
public LinkTokenAccountFilters getAccountFilters()
```
    Get accountFilters
    
    Returns:
    
    accountFilters
  - setAccountFilters
```
public void setAccountFilters(LinkTokenAccountFilters accountFilters)
```
  - euConfig
```
public LinkTokenCreateRequest euConfig(LinkTokenEUConfig euConfig)
```
  - getEuConfig
```
@Nullable
public LinkTokenEUConfig getEuConfig()
```
    Get euConfig
    
    Returns:
    
    euConfig
  - setEuConfig
```
public void setEuConfig(LinkTokenEUConfig euConfig)
```
  - institutionId
```
public LinkTokenCreateRequest institutionId(String institutionId)
```
  - getInstitutionId
```
@Nullable
public String getInstitutionId()
```
    Used for certain Europe-only configurations, as well as certain legacy use cases in other regions.
    
    Returns:
    
    institutionId
  - setInstitutionId
```
public void setInstitutionId(String institutionId)
```
  - paymentInitiation
```
public LinkTokenCreateRequest paymentInitiation(LinkTokenCreateRequestPaymentInitiation paymentInitiation)
```
  - getPaymentInitiation
```
@Nullable
public LinkTokenCreateRequestPaymentInitiation getPaymentInitiation()
```
    Get paymentInitiation
    
    Returns:
    
    paymentInitiation
  - setPaymentInitiation
```
public void setPaymentInitiation(LinkTokenCreateRequestPaymentInitiation paymentInitiation)
```
  - depositSwitch
```
public LinkTokenCreateRequest depositSwitch(LinkTokenCreateRequestDepositSwitch depositSwitch)
```
  - getDepositSwitch
```
@Nullable
public LinkTokenCreateRequestDepositSwitch getDepositSwitch()
```
    Get depositSwitch
    
    Returns:
    
    depositSwitch
  - setDepositSwitch
```
public void setDepositSwitch(LinkTokenCreateRequestDepositSwitch depositSwitch)
```
  - employment
```
public LinkTokenCreateRequest employment(LinkTokenCreateRequestEmployment employment)
```
  - getEmployment
```
@Nullable
public LinkTokenCreateRequestEmployment getEmployment()
```
    Get employment
    
    Returns:
    
    employment
  - setEmployment
```
public void setEmployment(LinkTokenCreateRequestEmployment employment)
```
  - incomeVerification
```
public LinkTokenCreateRequest incomeVerification(LinkTokenCreateRequestIncomeVerification incomeVerification)
```
  - getIncomeVerification
```
@Nullable
public LinkTokenCreateRequestIncomeVerification getIncomeVerification()
```
    Get incomeVerification
    
    Returns:
    
    incomeVerification
  - setIncomeVerification
```
public void setIncomeVerification(LinkTokenCreateRequestIncomeVerification incomeVerification)
```
  - baseReport
```
public LinkTokenCreateRequest baseReport(LinkTokenCreateRequestBaseReport baseReport)
```
  - getBaseReport
```
@Nullable
public LinkTokenCreateRequestBaseReport getBaseReport()
```
    Get baseReport
    
    Returns:
    
    baseReport
  - setBaseReport
```
public void setBaseReport(LinkTokenCreateRequestBaseReport baseReport)
```
  - consumerReportPermissiblePurpose
```
public LinkTokenCreateRequest consumerReportPermissiblePurpose(ConsumerReportPermissiblePurpose consumerReportPermissiblePurpose)
```
  - getConsumerReportPermissiblePurpose
```
@Nullable
public ConsumerReportPermissiblePurpose getConsumerReportPermissiblePurpose()
```
    Get consumerReportPermissiblePurpose
    
    Returns:
    
    consumerReportPermissiblePurpose
  - setConsumerReportPermissiblePurpose
```
public void setConsumerReportPermissiblePurpose(ConsumerReportPermissiblePurpose consumerReportPermissiblePurpose)
```
  - auth
```
public LinkTokenCreateRequest auth(LinkTokenCreateRequestAuth auth)
```
  - getAuth
```
@Nullable
public LinkTokenCreateRequestAuth getAuth()
```
    Get auth
    
    Returns:
    
    auth
  - setAuth
```
public void setAuth(LinkTokenCreateRequestAuth auth)
```
  - transfer
```
public LinkTokenCreateRequest transfer(LinkTokenCreateRequestTransfer transfer)
```
  - getTransfer
```
@Nullable
public LinkTokenCreateRequestTransfer getTransfer()
```
    Get transfer
    
    Returns:
    
    transfer
  - setTransfer
```
public void setTransfer(LinkTokenCreateRequestTransfer transfer)
```
  - update
```
public LinkTokenCreateRequest update(LinkTokenCreateRequestUpdate update)
```
  - getUpdate
```
@Nullable
public LinkTokenCreateRequestUpdate getUpdate()
```
    Get update
    
    Returns:
    
    update
  - setUpdate
```
public void setUpdate(LinkTokenCreateRequestUpdate update)
```
  - identityVerification
```
public LinkTokenCreateRequest identityVerification(LinkTokenCreateRequestIdentityVerification identityVerification)
```
  - getIdentityVerification
```
@Nullable
public LinkTokenCreateRequestIdentityVerification getIdentityVerification()
```
    Get identityVerification
    
    Returns:
    
    identityVerification
  - setIdentityVerification
```
public void setIdentityVerification(LinkTokenCreateRequestIdentityVerification identityVerification)
```
  - statements
```
public LinkTokenCreateRequest statements(LinkTokenCreateRequestStatements statements)
```
  - getStatements
```
@Nullable
public LinkTokenCreateRequestStatements getStatements()
```
    Get statements
    
    Returns:
    
    statements
  - setStatements
```
public void setStatements(LinkTokenCreateRequestStatements statements)
```
  - userToken
```
public LinkTokenCreateRequest userToken(String userToken)
```
  - getUserToken
```
@Nullable
public String getUserToken()
```
    A user token generated using `/user/create`. Any Item created during the Link session will be associated with the user.
    
    Returns:
    
    userToken
  - setUserToken
```
public void setUserToken(String userToken)
```
  - investments
```
public LinkTokenCreateRequest investments(LinkTokenInvestments investments)
```
  - getInvestments
```
@Nullable
public LinkTokenInvestments getInvestments()
```
    Get investments
    
    Returns:
    
    investments
  - setInvestments
```
public void setInvestments(LinkTokenInvestments investments)
```
  - investmentsAuth
```
public LinkTokenCreateRequest investmentsAuth(LinkTokenInvestmentsAuth investmentsAuth)
```
  - getInvestmentsAuth
```
@Nullable
public LinkTokenInvestmentsAuth getInvestmentsAuth()
```
    Get investmentsAuth
    
    Returns:
    
    investmentsAuth
  - setInvestmentsAuth
```
public void setInvestmentsAuth(LinkTokenInvestmentsAuth investmentsAuth)
```
  - hostedLink
```
public LinkTokenCreateRequest hostedLink(LinkTokenCreateHostedLink hostedLink)
```
  - getHostedLink
```
@Nullable
public LinkTokenCreateHostedLink getHostedLink()
```
    Get hostedLink
    
    Returns:
    
    hostedLink
  - setHostedLink
```
public void setHostedLink(LinkTokenCreateHostedLink hostedLink)
```
  - 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

Class LinkTokenCreateRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CLIENT_ID

SERIALIZED_NAME_SECRET

SERIALIZED_NAME_CLIENT_NAME

SERIALIZED_NAME_LANGUAGE

SERIALIZED_NAME_COUNTRY_CODES

SERIALIZED_NAME_USER

SERIALIZED_NAME_PRODUCTS

SERIALIZED_NAME_REQUIRED_IF_SUPPORTED_PRODUCTS

SERIALIZED_NAME_OPTIONAL_PRODUCTS

SERIALIZED_NAME_ADDITIONAL_CONSENTED_PRODUCTS

SERIALIZED_NAME_WEBHOOK

SERIALIZED_NAME_ACCESS_TOKEN

SERIALIZED_NAME_LINK_CUSTOMIZATION_NAME

SERIALIZED_NAME_REDIRECT_URI

SERIALIZED_NAME_ANDROID_PACKAGE_NAME

SERIALIZED_NAME_INSTITUTION_DATA

SERIALIZED_NAME_ACCOUNT_FILTERS

SERIALIZED_NAME_EU_CONFIG

SERIALIZED_NAME_INSTITUTION_ID

SERIALIZED_NAME_PAYMENT_INITIATION

SERIALIZED_NAME_DEPOSIT_SWITCH

SERIALIZED_NAME_EMPLOYMENT

SERIALIZED_NAME_INCOME_VERIFICATION

SERIALIZED_NAME_BASE_REPORT

SERIALIZED_NAME_CONSUMER_REPORT_PERMISSIBLE_PURPOSE

SERIALIZED_NAME_AUTH

SERIALIZED_NAME_TRANSFER

SERIALIZED_NAME_UPDATE

SERIALIZED_NAME_IDENTITY_VERIFICATION

SERIALIZED_NAME_STATEMENTS

SERIALIZED_NAME_USER_TOKEN

SERIALIZED_NAME_INVESTMENTS

SERIALIZED_NAME_INVESTMENTS_AUTH

SERIALIZED_NAME_HOSTED_LINK

Constructor Detail

LinkTokenCreateRequest

Method Detail

clientId

getClientId

setClientId

secret

getSecret

setSecret

clientName

getClientName

setClientName

language

getLanguage

setLanguage

countryCodes

addCountryCodesItem

getCountryCodes

setCountryCodes

user

getUser

setUser

products

addProductsItem

getProducts

setProducts

requiredIfSupportedProducts

addRequiredIfSupportedProductsItem

getRequiredIfSupportedProducts

setRequiredIfSupportedProducts

optionalProducts

addOptionalProductsItem

getOptionalProducts

setOptionalProducts

additionalConsentedProducts

addAdditionalConsentedProductsItem

getAdditionalConsentedProducts

setAdditionalConsentedProducts

webhook

getWebhook