{ "opencollection": "1.0.0", "info": { "name": "Stripe Accounts Account API", "version": "2023-10-16" }, "items": [ { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Stripe Retrieve Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/account", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of an account.

" }, { "info": { "name": "Stripe Create Account Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/account_links", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

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.

" }, { "info": { "name": "Stripe Create Account Session", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/account_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

" }, { "info": { "name": "Stripe Create Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

With Connect, you can create Stripe accounts for your users.\nTo do this, youll first need to register your platform.

\n\n

If youve already collected information for your connected accounts, you can prefill that information when\ncreating the account. Connect Onboarding wont ask for the prefilled information during account onboarding.\nYou " }, { "info": { "name": "Stripe Retrieve Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/accounts/:account", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of an account.

" }, { "info": { "name": "Stripe Update Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts/:account", "params": [ { "name": "account", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.

\n\n

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an Account Link\nfor a Standard or Express account, some parameters can no longer be change" }, { "info": { "name": "Stripe Delete Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/accounts/:account", "params": [ { "name": "account", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

With Connect, you can delete accounts you manage.

\n\n

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

\n\n

If you want to delete your own account, use the account information tab in your account settings instead.Create an external account for a given account.

" }, { "info": { "name": "Stripe Retrieve Bank Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/accounts/:account/bank_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieve a specified external account for a given account.

" }, { "info": { "name": "Stripe Update Bank Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts/:account/bank_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

" }, { "info": { "name": "Stripe Delete Bank Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/accounts/:account/bank_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Delete a specified external account for a given account.

" }, { "info": { "name": "Stripe Create External Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts/:account/external_accounts", "params": [ { "name": "account", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Create an external account for a given account.

" }, { "info": { "name": "Stripe Retrieve External Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/accounts/:account/external_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieve a specified external account for a given account.

" }, { "info": { "name": "Stripe Update External Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts/:account/external_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

\n\n

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

" }, { "info": { "name": "Stripe Delete External Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/accounts/:account/external_accounts/:id", "params": [ { "name": "account", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Delete a specified external account for a given account.

" }, { "info": { "name": "Stripe Reject Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/accounts/:account/reject", "params": [ { "name": "account", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

With Connect, you may flag accounts as suspicious.

\n\n

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

" }, { "info": { "name": "Stripe Post Link Account Sessions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/link_account_sessions", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

" }, { "info": { "name": "Stripe Get Link Account Sessions Session", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/link_account_sessions/:session", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "session", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "

Retrieves the details of a Financial Connections Session

" } ] } ], "bundled": true }