List all connected accounts
GET / v1 / accounts
Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
Parameters
No parameters.
More parameters
- created object
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit accounts, starting after account starting_after. Each entry in the array is a separate Account object. If no more accounts are available, the resulting array is empty.
Response
Delete an account
DELETE / v1 / accounts /:id
With Connect, you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
Parameters
No parameters.
Returns
Returns an object with a deleted parameter if the call succeeds. If the account ID does not exist, this call raises an error.
Response
{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "account", "deleted": true}
Reject an account
POST / v1 / accounts /:id / reject
With Connect, you can reject accounts that you have flagged as suspicious.
Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.
Parameters
- reason string Required The reason for rejecting the account. Can be
fraud,terms_of_service, orother. - payouts _ action enum Preview feature Whether to pause payouts on the account as part of the rejection. Defaults to
pause. Usenoneto leave payouts enabled.
Returns
Returns an account with payouts_enabled and charges_enabled set to false on success. If the account ID does not exist, this call raises an error.
Response