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
- createddictionary
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
accounts, starting after account starting_
. Each entry in the array is a separate Account
object. If no more accounts are available, the resulting array is empty.
{ "object": "list", "url": "/v1/accounts", "has_more": false, "data": [ { "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "account", "business_profile": { "annual_revenue": null, "estimated_worker_count": null, "mcc": null, "name": null, "product_description": null, "support_address": null, "support_email": null, "support_phone": null, "support_url": null, "url": null }, "business_type": null, "capabilities": {}, "charges_enabled": false, "controller": { "fees": { "payer": "application" }, "is_controller": true, "losses": { "payments": "application" }, "requirement_collection": "stripe", "stripe_dashboard": { "type": "express" }, "type": "application" }, "country": "US", "created": 1695830751, "default_currency": "usd", "details_submitted": false, "email": "jenny.rosen@example.com", "external_accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "login_links": { "object": "list", "total_count": 0, "has_more": false, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/login_links", "data": [] }, "metadata": {}, "payouts_enabled": false, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "requirements.past_due", "errors": [], "eventually_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [ "business_profile.mcc", "business_profile.url", "business_type", "external_account", "representative.first_name", "representative.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": false, "cvc_failure": false }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kanji": null, "statement_descriptor_prefix_kana": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "invoices": { "default_account_tax_ids": null }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "none" } ]}
With Connect, you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express 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.
{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "account", "deleted": true}
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. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
Parameters
- reasonstringRequired
The reason for rejecting the account. Can be
fraud
,terms_
, orof_ service other
.
Returns
Returns an account with payouts_
and charges_
set to false on success. If the account ID does not exist, this call raises an error.
{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "account", "business_profile": { "annual_revenue": null, "estimated_worker_count": null, "mcc": null, "name": null, "product_description": null, "support_address": null, "support_email": null, "support_phone": null, "support_url": null, "url": null }, "business_type": null, "capabilities": {}, "charges_enabled": false, "controller": { "fees": { "payer": "application" }, "is_controller": true, "losses": { "payments": "application" }, "requirement_collection": "stripe", "stripe_dashboard": { "type": "express" }, "type": "application" }, "country": "US", "created": 1385798567, "default_currency": "usd", "details_submitted": true, "email": "jenny.rosen@example.com", "external_accounts": { "object": "list", "data": [], "has_more": false, "total_count": 0, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/external_accounts" }, "future_requirements": { "alternatives": [], "current_deadline": null, "currently_due": [], "disabled_reason": null, "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "login_links": { "object": "list", "total_count": 0, "has_more": false, "url": "/v1/accounts/acct_1Nv0FGQ9RKHgCVdK/login_links", "data": [] }, "metadata": {}, "payouts_enabled": true, "requirements": { "alternatives": [], "current_deadline": null, "currently_due": [ "business_profile.mcc", "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "business_type", "external_account", "person_8UayFKIMRJklog.first_name", "person_8UayFKIMRJklog.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "disabled_reason": "rejected.fraud", "errors": [], "eventually_due": [ "business_profile.mcc", "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "business_type", "external_account", "person_8UayFKIMRJklog.first_name", "person_8UayFKIMRJklog.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "past_due": [ "business_profile.mcc", "business_profile.product_description", "business_profile.support_phone", "business_profile.url", "business_type", "external_account", "person_8UayFKIMRJklog.first_name", "person_8UayFKIMRJklog.last_name", "tos_acceptance.date", "tos_acceptance.ip" ], "pending_verification": [] }, "settings": { "bacs_debit_payments": { "display_name": null, "service_user_number": null }, "branding": { "icon": null, "logo": null, "primary_color": null, "secondary_color": null }, "card_issuing": { "tos_acceptance": { "date": null, "ip": null } }, "card_payments": { "decline_on": { "avs_failure": false, "cvc_failure": false }, "statement_descriptor_prefix": null, "statement_descriptor_prefix_kanji": null, "statement_descriptor_prefix_kana": null }, "dashboard": { "display_name": null, "timezone": "Etc/UTC" }, "invoices": { "default_account_tax_ids": null }, "payments": { "statement_descriptor": null, "statement_descriptor_kana": null, "statement_descriptor_kanji": null }, "payouts": { "debit_negative_balances": true, "schedule": { "delay_days": 2, "interval": "daily" }, "statement_descriptor": null }, "sepa_debit_payments": {} }, "tos_acceptance": { "date": null, "ip": null, "user_agent": null }, "type": "none"}
Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. A Login Link differs from an Account Link in that it takes the user directly to their Express dashboard for the specified account
Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.
Related guide: Connect Onboarding