The Account Link object v2
Attributes
- object string, 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.
- account string The ID of the connected account this Account Link applies to.
- created timestamp The timestamp at which this Account Link was created.
- expires _ at timestamp The timestamp at which this Account Link will expire.
- livemode boolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - url string The URL at which the account can access the Stripe-hosted flow.
- use _ case object Hash containing usage options.
The Account Link object
Create an account link v2
POST / v2 / core / account_links
Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
Learn more about calling API v2 endpoints.
Parameters
- account string Required The ID of the Account to create link for.
- use _ case object Required The use case of the AccountLink.
Returns
Returns an Account Link object.
Error Codes
400 accounts _ v2 _ access _ blocked
Accounts v2 is not enabled for your merchant.
400 configs _ must _ match _ to _ use _ account _ links
Account cannot be onboard via the relevant part of the product without specifying the right configurations.
404 not _ found
The resource wasn’t found.
429 account _ rate _ limit _ exceeded
Account cannot exceed a configured concurrency rate limit on updates.
Response
