POST /v1/account_links

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

Servers

https://api.stripe.com/

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`account`	String	Yes	The identifier of the account to create an account link for.
`refresh_url`	String	No	The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`collect`	String	No	The collect parameter is deprecated. Use `collection_options` instead. Possible values: `"currently_due"` `"eventually_due"`
`collection_options`	Object	No	Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
`collection_options.fields`	String	No	Possible values: `"currently_due"` `"eventually_due"`
`collection_options.future_requirements`	String	No	Possible values: `"omit"` `"include"`
`type`	String	Yes	The type of account link the user is requesting. You can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use Connect embedded components, you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components. Possible values: `"account_update"` `"account_onboarding"`
`return_url`	String	No	The URL that the user will be redirected to upon leaving or completing the linked flow.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.