Create Bank Widget

Create a Widget URL to add a Bank Account using Plaid Link.
View the About Widgets page to learn about optional widget_params.
201 - Created
400 - Bad Request, missing or invalid parameters.

Upon completion of bank account link, Interchecks will utilize the redirect_url parameter in the widget_params to redirect control back to the client's browser. The completion page should provide the appropriate messaging to the user to indicate next steps or action required.

📘

Account Creation Success

A webhook with the account_id will be posted if your API account is configured for Payment Account Webhooks upon successful account creation via Widget UI.

The redirect_url provided with the widget_params will have the accountId and widget_id parameters appended and URL encoded.

🚧

Account Creation Failure

A webhook with the error_code will be posted if your API account is configured for Payment Account Webhooks upon failing to create/authenticate a user's bank account.

The redirect_url provided with the widget_params will have the accountId, widget_id, and errorCode parameters appended and URL encoded.

❗️

Link Provider

Due to requirements from Chase Bank, clients should migrate to link_provider PLAID. Plaid's Hosted Link meets Chase Bank's requirements for webviews and browser-based account linking.

On mobile devices, the Plaid Hosted Link domain must be served in an out of process webview. In process webviews are not supported by Chase Bank.

Plaid Hosted Link is not supported as an iFrame element.

Path Params
string
required

Payer ID

Body Params
string

Recipient ID

string
Defaults to optional

Required if the bank account requires a re-authorization process with Plaid Link

boolean
Defaults to false

Indicate mobile device to render appropriate UI

string
enum
Defaults to INTERCHECKS
Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json