Skip to main content
POST
Generate External Account Link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

businessId
string
required

The unique identifier for the business

Body

application/json

Common request body for endpoints that generate hosted (link-out) URLs.

refreshURL
string

The URL the user will be redirected to if the link is expired

returnURL
string

The URL that the user will be redirected to upon leaving or completing the linked flow.

mode
enum<string>
default:standard

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.

Available options:
standard,
setup,
verification
externalAccountId
string<uuid>

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.

Example:

"1f2e3d4c-5678-9012-cdef-345678901234"

Response

Common response body for endpoints that return a hosted (link-out) URL.

url
string

Fully-qualified hosted URL valid until the embedded token expires.