The AccountLink object 

Attributes

• objectstring, value is "v2.core.account_link"

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

• accountstring

  The ID of the Account the link was created for.

• createdtimestamp

  The timestamp at which this AccountLink was created.

• expires_attimestamp

  The timestamp at which this AccountLink will expire.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• urlstring

  The URL for the AccountLink.

• use_caseobject

  The use case of AccountLink the user is requesting.

  Hide child attributes

  • use_case.account_onboardingnullable object

    Indicates that the AccountLink provided should onboard an account.

    Hide child attributes

    • use_case.account_onboarding.collection_optionsnullable object

      Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.

      Hide child attributes

      • use_case.account_onboarding.collection_options.fieldsnullable enum

        Specifies whether the platform collects only currently_due requirements (currently_due) or both currently_due and eventually_due requirements (eventually_due). If you don’t specify collection_options, the default value is currently_due.

        Possible enum values

        currently_due Collect currently_due requirements.

        eventually_due Collect eventually_due and currently_due requirements.

      • use_case.account_onboarding.collection_options.future_requirementsnullable enum

        Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is omit.

        Possible enum values

        include Include future requirements.

        omit Omit future requirements.

    • use_case.account_onboarding.configurationsarray of enums

      Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.

      Possible enum values

      customer To onboard a new customer.

      merchant To onboard a new merchant.

      recipient To onboard a new recipient.

      storer To onboard a new storer.

    • use_case.account_onboarding.refresh_urlstring

      The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.

    • use_case.account_onboarding.return_urlnullable string

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

  • use_case.account_updatenullable object

    Indicates that the AccountLink provided should update a previously onboarded account.

    Hide child attributes

    • use_case.account_update.collection_optionsnullable object

      Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.

      Hide child attributes

      • use_case.account_update.collection_options.fieldsnullable enum

        Specifies whether the platform collects only currently_due requirements (currently_due) or both currently_due and eventually_due requirements (eventually_due). If you don’t specify collection_options, the default value is currently_due.

        Possible enum values

        currently_due Collect currently_due requirements.

        eventually_due Collect eventually_due and currently_due requirements.

      • use_case.account_update.collection_options.future_requirementsnullable enum

        Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is omit.

        Possible enum values

        include Include future requirements.

        omit Omit future requirements.

    • use_case.account_update.configurationsarray of enums

      Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.

      Possible enum values

      customer To onboard a new customer.

      merchant To onboard a new merchant.

      recipient To update a new recipient.

      storer To onboard a new storer.

    • use_case.account_update.refresh_urlstring

      The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.

    • use_case.account_update.return_urlnullable string

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

  • use_case.typeenum

    The type of AccountLink the user is requesting.

    Possible enum values

    account_onboarding A form to collect all required information to onboard a new account.

    account_update A form to collect all required information to update a previously onboarded account.