com.plaid.client.model

Class IncomeVerificationCreateRequest

java.lang.Object

com.plaid.client.model.IncomeVerificationCreateRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-08-10T22:39:54.038561Z[Etc/UTC]")
public class IncomeVerificationCreateRequest
extends Object

IncomeVerificationCreateRequest defines the request schema for `/income/verification/create`

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_CLIENT_ID
static String	SERIALIZED_NAME_OPTIONS
static String	SERIALIZED_NAME_PRECHECK_ID
static String	SERIALIZED_NAME_SECRET
static String	SERIALIZED_NAME_WEBHOOK

Constructor Summary

Constructors

Constructor and Description
IncomeVerificationCreateRequest()

Method Summary

Modifier and Type	Method and Description
IncomeVerificationCreateRequest	clientId(String clientId)
boolean	equals(Object o)
String	getClientId() Your Plaid API `client_id`.
IncomeVerificationCreateRequestOptions	getOptions() Get options
String	getPrecheckId() The ID of a precheck created with `/income/verification/precheck`.
String	getSecret() Your Plaid API `secret`.
String	getWebhook() The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.
int	hashCode()
IncomeVerificationCreateRequest	options(IncomeVerificationCreateRequestOptions options)
IncomeVerificationCreateRequest	precheckId(String precheckId)
IncomeVerificationCreateRequest	secret(String secret)
void	setClientId(String clientId)
void	setOptions(IncomeVerificationCreateRequestOptions options)
void	setPrecheckId(String precheckId)
void	setSecret(String secret)
void	setWebhook(String webhook)
String	toString()
IncomeVerificationCreateRequest	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_WEBHOOK

public static final String SERIALIZED_NAME_WEBHOOK

See Also:

Constant Field Values

SERIALIZED_NAME_PRECHECK_ID

public static final String SERIALIZED_NAME_PRECHECK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_OPTIONS

public static final String SERIALIZED_NAME_OPTIONS

See Also:

Constant Field Values

Constructor Detail

IncomeVerificationCreateRequest

public IncomeVerificationCreateRequest()

Method Detail

clientId

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

webhook

public IncomeVerificationCreateRequest webhook(String webhook)

getWebhook

public String getWebhook()

The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.

Returns:

webhook

setWebhook

public void setWebhook(String webhook)

precheckId

public IncomeVerificationCreateRequest precheckId(String precheckId)

getPrecheckId

@Nullable
public String getPrecheckId()

The ID of a precheck created with `/income/verification/precheck`. Will be used to improve conversion of the income verification flow.

Returns:

precheckId

setPrecheckId

public void setPrecheckId(String precheckId)

options

public IncomeVerificationCreateRequest options(IncomeVerificationCreateRequestOptions options)

getOptions

@Nullable
public IncomeVerificationCreateRequestOptions getOptions()

Get options

Returns:

options

setOptions

public void setOptions(IncomeVerificationCreateRequestOptions options)

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