From a77f746b8d4158209757cd26191fafcbc512e448 Mon Sep 17 00:00:00 2001 From: Shreya Thapa Date: Mon, 21 Apr 2025 09:33:16 -0500 Subject: [PATCH] DEV-1725: Remove unused exchange related event: customer_exchange_deactivated --- pages/changelog.mdx | 2 +- pages/docs/balance/api-reference/events/index.mdx | 1 - pages/docs/balance/open-banking/plaid.mdx | 2 +- pages/docs/balance/webhook-events.mdx | 1 - 4 files changed, 2 insertions(+), 4 deletions(-) diff --git a/pages/changelog.mdx b/pages/changelog.mdx index 4da76cb1..e453b395 100644 --- a/pages/changelog.mdx +++ b/pages/changelog.mdx @@ -27,7 +27,7 @@ To facilitate Open Banking integration with Plaid, we've updated three API endpo - **/customers/{id}/exchange-sessions (POST)**: Updated API endpoint to support Plaid as a provider. - **/exchange-sessions/{id} (GET)**: Added new atrribute `externalProviderSessionToken` to the response to accommodate Plaid-specific information, such as Plaid link token. - **/customers/{id}/exchanges**: Modified to include a `plaid` JSON object containing a Plaid `publicToken`. -- Introduced new webhooks `customer_exchange_deactivated` and `customer_exchange_reauth_required` for exchange related events specific to Plaid. These webhooks will be triggered when a user's bank connection has been interrupted or is requiring reauthentication in order to ensure continued access to the user's financial data. +- Introduced new webhook `customer_exchange_reauth_required`, an exchange related event specific to Plaid. This webhook will be triggered when a user's bank connection has been interrupted or is requiring re-authentication in order to ensure continued access to the user's financial data. ### 2024-10-30 diff --git a/pages/docs/balance/api-reference/events/index.mdx b/pages/docs/balance/api-reference/events/index.mdx index 476ef899..78c6c829 100644 --- a/pages/docs/balance/api-reference/events/index.mdx +++ b/pages/docs/balance/api-reference/events/index.mdx @@ -138,7 +138,6 @@ For [Account](/api-reference/accounts) transfer events, in addition to the [defa | Event Topic Name | Description | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| customer_exchange_deactivated | **Description:** An exchange was deactivated for a Customer.
**Timing:** Occurs when access to a user's connected bank account has been interrupted. A user's bank connection needs to be refreshed by [creating a reauth exchange session](https://developers.dwolla.com/docs/balance/api-reference/open-banking/create-reauth-exchange-session). | | customer_exchange_reauth_required | **Description:** An exchange is pending deactivation and requires reauthentication.
**Timing:** Occurs when access to a user's connected bank account will soon be interrupted. This interruption could be due to changes on the bank's end, such as a password update, multi-factor authentication reset or revoked consent. This event signals that a user's bank connection needs to be refreshed by [creating a reauth exchange session](https://developers.dwolla.com/docs/balance/api-reference/open-banking/create-reauth-exchange-session). | ### Funding Sources diff --git a/pages/docs/balance/open-banking/plaid.mdx b/pages/docs/balance/open-banking/plaid.mdx index 3cf6a61d..2d08be79 100644 --- a/pages/docs/balance/open-banking/plaid.mdx +++ b/pages/docs/balance/open-banking/plaid.mdx @@ -423,7 +423,7 @@ Location: https://api.dwolla.com/funding-sources/AB443D36-3757-44C1-A1B4-29727FB When Customers initially connect their bank account via Instant Account Verification, they authenticate their bank account with Plaid and grant permission to access their account information. This allows Dwolla to perform actions like [checking bank balances](https://developers.dwolla.com/docs/balance/api-reference/open-banking/retrieve-bank-balance). However, this access can be interrupted by changes made by the Customer, such as if the Customer updates their bank password, multi-factor authentication method or revokes consent to access their account information. -To maintain a smooth user experience, your application needs to handle these scenarios gracefully. Dwolla's API provides an `UpdateCredentials` error response to signal when a Customer’s bank connection needs to be refreshed. Additionally, Dwolla will also send a `customer_exchange_reauth_required` webhook denoting whether an exchange is pending deactivation, or a `customer_exchange_deactivated` webhook denoting that an exchange has been deactivated and requires re-authentication. +To maintain a smooth user experience, your application needs to handle these scenarios gracefully. Dwolla's API provides an `UpdateCredentials` error response to signal when a Customer’s bank connection needs to be refreshed. Additionally, Dwolla will also send a `customer_exchange_reauth_required` webhook denoting whether an exchange is pending deactivation and requires re-authentication. ##### `UpdateCredentials` error response diff --git a/pages/docs/balance/webhook-events.mdx b/pages/docs/balance/webhook-events.mdx index d44c7628..d8690a7a 100755 --- a/pages/docs/balance/webhook-events.mdx +++ b/pages/docs/balance/webhook-events.mdx @@ -127,7 +127,6 @@ Customer related webhooks are available for the list of Events shown below. As A | Event Topic Name | Description | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| customer_exchange_deactivated | **Description:** An exchange was deactivated for a Customer.
**Timing:** Occurs when access to a user's connected bank account has been interrupted. A user's bank connection needs to be refreshed by [creating a reauth exchange session](https://developers.dwolla.com/docs/balance/api-reference/open-banking/create-reauth-exchange-session). | | customer_exchange_reauth_required | **Description:** An exchange is pending deactivation and requires reauthentication.
**Timing:** Occurs when access to a user's connected bank account will soon be interrupted. This interruption could be due to changes on the bank's end, such as a password update, multi-factor authentication reset or revoked consent. This event signals that a user's bank connection needs to be refreshed by [creating a reauth exchange session](https://developers.dwolla.com/docs/balance/api-reference/open-banking/create-reauth-exchange-session). | ### Customers - Funding Sources