Struct UserAccountRevokedWebhook

pub struct UserAccountRevokedWebhook {
    pub account_id: String,
    pub environment: WebhookEnvironmentValues,
    pub error: Option<PlaidError>,
    pub item_id: String,
    pub webhook_code: String,
    pub webhook_type: String,
}

The USER_ACCOUNT_REVOKED webhook is fired when an end user has revoked access to their account on the Data Provider’s portal. This webhook is currently sent only for Chase Items, but may be sent in the future for other financial institutions that allow account-level permissions revocation through their portals. Upon receiving this webhook, it is recommended to delete any Plaid-derived data you have stored that is associated with the revoked account.

If you are using Auth and receive this webhook, this webhook indicates that the TAN associated with the revoked account is no longer valid and cannot be used to create new transfers. You should not create new ACH transfers for the account that was revoked until access has been re-granted.

You can request the user to re-grant access to their account by sending them through update mode. Alternatively, they may re-grant access directly through the Data Provider’s portal.

After the user has re-granted access, Auth customers should call the auth endpoint again to obtain the new TAN.

Fields

account_id: String

The external account ID of the affected account

environment: WebhookEnvironmentValues

The Plaid environment the webhook was sent from

error: Option<PlaidError>

Errors are identified by error_code and categorized by error_type. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null error object will only be part of an API response when calling /item/get to view Item status. Otherwise, error fields will be null if no error has occurred; if an error has occurred, an error code will be returned instead.

item_id: String

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

webhook_code: String

USER_ACCOUNT_REVOKED

webhook_type: String

ITEM

Trait Implementations

impl Clone for UserAccountRevokedWebhook

fn clone(&self) -> UserAccountRevokedWebhook

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserAccountRevokedWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserAccountRevokedWebhook

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UserAccountRevokedWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for UserAccountRevokedWebhook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.