Generate External Account Link
Generate External Account Link
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Path Parameters
The unique identifier for the business
Body
Common request body for endpoints that generate hosted (link-out) URLs.
The URL the user will be redirected to if the link is expired
The URL that the user will be redirected to upon leaving or completing the linked flow.
Controls the account linking behavior. "standard" shows the entry page with "Add payment method" button. "setup" skips the entry page and goes directly to bank selection flow. "verification" opens a focused verification view for a single pending account and requires externalAccountId.
standard, setup, verification The external account to verify. Required when mode is verification; the account must belong to the business and be in needs_confirmation status — otherwise the request fails with 404 (unknown account) or 400 (account does not require verification). Ignored for other modes.
"1f2e3d4c-5678-9012-cdef-345678901234"
Response
Common response body for endpoints that return a hosted (link-out) URL.
Fully-qualified hosted URL valid until the embedded token expires.