com.plaid.client.model

Class AuthDefaultUpdateWebhook

java.lang.Object

com.plaid.client.model.AuthDefaultUpdateWebhook

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class AuthDefaultUpdateWebhook
extends Object

Plaid will trigger a `DEFAULT_UPDATE` webhook for Items that undergo a change in Auth data. This is generally caused by data partners notifying Plaid of a change in their account numbering system or to their routing numbers. To avoid returned transactions, customers that receive a `DEFAULT_UPDATE` webhook with the `account_ids_with_updated_auth` object populated should immediately discontinue all usages of existing Auth data for those accounts and call `/auth/get` or `/processor/auth/get` to obtain updated account and routing numbers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_IDS_WITH_NEW_AUTH
static String	SERIALIZED_NAME_ACCOUNT_IDS_WITH_UPDATED_AUTH
static String	SERIALIZED_NAME_ENVIRONMENT
static String	SERIALIZED_NAME_ERROR
static String	SERIALIZED_NAME_ITEM_ID
static String	SERIALIZED_NAME_WEBHOOK_CODE
static String	SERIALIZED_NAME_WEBHOOK_TYPE

Constructor Summary

Constructors

Constructor and Description
AuthDefaultUpdateWebhook()

Method Summary

Modifier and Type	Method and Description
AuthDefaultUpdateWebhook	accountIdsWithNewAuth(List<String> accountIdsWithNewAuth)
AuthDefaultUpdateWebhook	accountIdsWithUpdatedAuth(Map<String,List<AuthUpdateTypes>> accountIdsWithUpdatedAuth)
AuthDefaultUpdateWebhook	addAccountIdsWithNewAuthItem(String accountIdsWithNewAuthItem)
AuthDefaultUpdateWebhook	environment(WebhookEnvironmentValues environment)
boolean	equals(Object o)
AuthDefaultUpdateWebhook	error(PlaidError error)
List<String>	getAccountIdsWithNewAuth() An array of `account_id`'s for accounts that contain new auth.
Map<String,List<AuthUpdateTypes>>	getAccountIdsWithUpdatedAuth() An object with keys of `account_id`'s that are mapped to their respective auth attributes that changed.
WebhookEnvironmentValues	getEnvironment() Get environment
PlaidError	getError() Get error
String	getItemId() The `item_id` of the Item associated with this webhook, warning, or error
String	getWebhookCode() `DEFAULT_UPDATE`
String	getWebhookType() `AUTH`
int	hashCode()
AuthDefaultUpdateWebhook	itemId(String itemId)
AuthDefaultUpdateWebhook	putAccountIdsWithUpdatedAuthItem(String key, List<AuthUpdateTypes> accountIdsWithUpdatedAuthItem)
void	setAccountIdsWithNewAuth(List<String> accountIdsWithNewAuth)
void	setAccountIdsWithUpdatedAuth(Map<String,List<AuthUpdateTypes>> accountIdsWithUpdatedAuth)
void	setEnvironment(WebhookEnvironmentValues environment)
void	setError(PlaidError error)
void	setItemId(String itemId)
void	setWebhookCode(String webhookCode)
void	setWebhookType(String webhookType)
String	toString()
AuthDefaultUpdateWebhook	webhookCode(String webhookCode)
AuthDefaultUpdateWebhook	webhookType(String webhookType)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_WEBHOOK_TYPE

public static final String SERIALIZED_NAME_WEBHOOK_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_CODE

public static final String SERIALIZED_NAME_WEBHOOK_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_ITEM_ID

public static final String SERIALIZED_NAME_ITEM_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_IDS_WITH_NEW_AUTH

public static final String SERIALIZED_NAME_ACCOUNT_IDS_WITH_NEW_AUTH

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_IDS_WITH_UPDATED_AUTH

public static final String SERIALIZED_NAME_ACCOUNT_IDS_WITH_UPDATED_AUTH

See Also:

Constant Field Values

SERIALIZED_NAME_ERROR

public static final String SERIALIZED_NAME_ERROR

See Also:

Constant Field Values

SERIALIZED_NAME_ENVIRONMENT

public static final String SERIALIZED_NAME_ENVIRONMENT

See Also:

Constant Field Values

Constructor Detail

AuthDefaultUpdateWebhook

public AuthDefaultUpdateWebhook()

Method Detail

webhookType

public AuthDefaultUpdateWebhook webhookType(String webhookType)

getWebhookType

public String getWebhookType()

`AUTH`

Returns:

webhookType

setWebhookType

public void setWebhookType(String webhookType)

webhookCode

public AuthDefaultUpdateWebhook webhookCode(String webhookCode)

getWebhookCode

public String getWebhookCode()

`DEFAULT_UPDATE`

Returns:

webhookCode

setWebhookCode

public void setWebhookCode(String webhookCode)

itemId

public AuthDefaultUpdateWebhook itemId(String itemId)

getItemId

public String getItemId()

The `item_id` of the Item associated with this webhook, warning, or error

Returns:

itemId

setItemId

public void setItemId(String itemId)

accountIdsWithNewAuth

public AuthDefaultUpdateWebhook accountIdsWithNewAuth(List<String> accountIdsWithNewAuth)

addAccountIdsWithNewAuthItem

public AuthDefaultUpdateWebhook addAccountIdsWithNewAuthItem(String accountIdsWithNewAuthItem)

getAccountIdsWithNewAuth

public List<String> getAccountIdsWithNewAuth()

An array of `account_id`'s for accounts that contain new auth.

Returns:

accountIdsWithNewAuth

setAccountIdsWithNewAuth

public void setAccountIdsWithNewAuth(List<String> accountIdsWithNewAuth)

accountIdsWithUpdatedAuth

public AuthDefaultUpdateWebhook accountIdsWithUpdatedAuth(Map<String,List<AuthUpdateTypes>> accountIdsWithUpdatedAuth)

putAccountIdsWithUpdatedAuthItem

public AuthDefaultUpdateWebhook putAccountIdsWithUpdatedAuthItem(String key,
                                                                 List<AuthUpdateTypes> accountIdsWithUpdatedAuthItem)

getAccountIdsWithUpdatedAuth

public Map<String,List<AuthUpdateTypes>> getAccountIdsWithUpdatedAuth()

An object with keys of `account_id`'s that are mapped to their respective auth attributes that changed. `ACCOUNT_NUMBER` and `ROUTING_NUMBER` are the two potential values that can be flagged as updated. Example: `{ \"XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58\": [\"ACCOUNT_NUMBER\"] }`

Returns:

accountIdsWithUpdatedAuth

setAccountIdsWithUpdatedAuth

public void setAccountIdsWithUpdatedAuth(Map<String,List<AuthUpdateTypes>> accountIdsWithUpdatedAuth)

error

public AuthDefaultUpdateWebhook error(PlaidError error)

getError

@Nullable
public PlaidError getError()

Get error

Returns:

error

setError

public void setError(PlaidError error)

environment

public AuthDefaultUpdateWebhook environment(WebhookEnvironmentValues environment)

getEnvironment

public WebhookEnvironmentValues getEnvironment()

Get environment

Returns:

environment

setEnvironment

public void setEnvironment(WebhookEnvironmentValues environment)

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