Skip to main content
GET
Get a Link for the User to Reconnect a Bank Account

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

bank_account_id
string<uuid>
required

The unique ID of the linked bank account whose connection needs refreshing.

Example:

"e5f6a7b8-c9d0-1234-5678-9abcdef01234"

Query Parameters

parent_origin
string | null

Optional. The bare origin of the page that will embed the link in an iframe (e.g. https://app.example.com). When provided, the page sends the outcome back to that exact window via a browser message. Omit it when opening the link as a full page or popup.

Maximum string length: 255
Example:

"https://app.example.com"

Response

A short-lived, single-use hosted relink link.

status_code
integer
required

HTTP status code for the response.

data
HostedRelinkBankUrlRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.