Swagger Petstore - OpenAPI 3.0
POST/v1/account_links

Create an account link

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

7 body fields
accountstringrequired

The identifier of the account to create an account link for.

collectstringoptional

The collect parameter is deprecated. Use collection_options instead.

Allowed:currently_dueeventually_due
collection_optionsobjectoptional

Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.

expandarray<string>optional

Specifies which fields in the response should be expanded.

refresh_urlstringoptional

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.

return_urlstringoptional

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

typestringrequired

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.

Allowed:account_onboardingaccount_update

2 status codes
200Successful response.
createdintegerrequired

Time at which the object was created. Measured in seconds since the Unix epoch.

expires_atintegerrequired

The timestamp at which this account link will expire.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:account_link
urlstringrequired

The URL for the account link.

defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.