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.
Parameters
- accountstringRequired
The identifier of the account to create an account link for.
- typeenumRequired
The type of account link the user is requesting.
You can create Account Links of type
account_
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.update Possible enum valuesaccount_
onboarding Provides a form for inputting outstanding requirements. Send the user to the form in this mode to just collect the new information you need.
account_
update Displays the fields that are already populated on the account object, and allows your user to edit previously provided information. Consider framing this as “edit my profile” or “update my verification information”.
- refresh_
urlstringRequired 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_
urlstringRequired The URL that the user will be redirected to upon leaving or completing the linked flow.
More parameters
- collectenumDeprecated
- collection_
optionsobject
Returns
Returns an account link object if the call succeeded.
{ "object": "account_link", "created": 1680577733, "expires_at": 1680578033, "url": "https://connect.stripe.com/setup/c/acct_1Mt0CORHFI4mz9Rw/TqckGNUHg2mG"}
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once.
Related guide: Connect embedded components
When you collect a transaction fee on top of a charge made for your user (using Connect), an Application Fee
object is created in your account. You can list, retrieve, and refund application fees.
Related guide: Collecting application fees
Application Fee Refund
objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.
Related guide: Refunding application fees
This is an object representing a capability for a Stripe account.
Related guide: Account capabilities