Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion pages/docs/balance/api-reference/events/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br /> **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.<br /> **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
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/balance/open-banking/plaid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion pages/docs/balance/webhook-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br /> **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.<br /> **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
Expand Down
Loading