Retrieve an account v2

GET / v2 / core / accounts /:id

Retrieves the details of an Account.

Learn more about calling API v2 endpoints.

Parameters

include array of enums Additional fields to include in the response. Possible enum values configuration.customer Include parameter to expose configuration.customer on an Account. configuration.merchant Include parameter to expose configuration.merchant on an Account. configuration.recipient Include parameter to expose configuration.recipient on an Account. defaults Include parameter to expose defaults on an Account. future_requirements Include parameter to expose future_requirements on an Account. identity Include parameter to expose identity on an Account. requirements Include parameter to expose requirements on an Account.

Returns

Returns an Account object.

Error Codes

400 account _ not _ yet _ compatible _ with _ v2

Account is not yet compatible with V2 APIs.

400 accounts _ v2 _ access _ blocked

Accounts v2 is not enabled for your merchant.

400 non _ connect _ platform _ accounts _ v2 _ access _ blocked

Needs to use the newer API version or onboard to Connect.

400 v1 _ account _ instead _ of _ v2 _ account

V1 Account ID cannot be used in V2 Account APIs.

400 v1 _ customer _ instead _ of _ v2 _ account

V1 Customer ID cannot be used in V2 Account APIs.

404 not _ found

The resource wasn’t found.

429 account _ rate _ limit _ exceeded

Account cannot exceed a configured concurrency rate limit on updates.

Response

{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "v2.core.account", "applied_configurations": [ "customer", "merchant" ], "configuration": { "merchant": { "applied": "2024-11-26T16:33:03.000Z", "card_payments": { "decline_on": { "avs_failure": false, "cvc_failure": false } }, "capabilities": { "card_payments": { "status": "restricted", "status_details": [ { "code": "requirements_past_due", "resolution": "provide_info" } ] } }, "statement_descriptor": { "descriptor": "accessible.stripe.com" } } }, "contact_email": "furever@example.com", "created": "2024-11-26T16:33:03.000Z", "dashboard": "full", "identity": { "business_details": { "address": { "country": "us" }, "id_numbers": [ { "type": "us_ein" } ], "structure": "sole_proprietorship" }, "country": "us", "entity_type": "company" }, "defaults": { "currency": "usd", "locales": [], "profile": { "business_url": "http://accessible.stripe.com", "doing_business_as": "FurEver", "product_description": "Saas pet grooming platform at furever.dev using Connect embedded components" }, "responsibilities": { "fees_collector": "stripe", "losses_collector": "stripe", "requirements_collector": "stripe" } }, "display_name": "Furever", "livemode": true, "metadata": {}}

List accounts v2

GET / v2 / core / accounts

Returns a list of Accounts.

Learn more about calling API v2 endpoints.

Parameters

applied _ configurations array of enums Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have. Possible enum values customer The Account can be used as a customer. merchant The Account can be used as a merchant. recipient The Account can be used as a recipient.
closed boolean Filter by whether the account is closed. If omitted, returns only Accounts that are not closed.
limit integer The upper limit on the number of accounts returned by the List Account request.
page string The page token to navigate to next or previous batch of accounts given by the list request.

Returns

Response attributes

data array of objects A list of retrieved Account objects.
next _ page _ url nullable string URL to fetch the next page of the list. If there are no more pages, the value is null.
previous _ page _ url nullable string URL to fetch the previous page of the list. If there are no previous pages, the value is null.

Error Codes

400 accounts _ v2 _ access _ blocked

Accounts v2 is not enabled for your merchant.

400 non _ connect _ platform _ accounts _ v2 _ access _ blocked

Needs to use the newer API version or onboard to Connect.

429 account _ rate _ limit _ exceeded

Account cannot exceed a configured concurrency rate limit on updates.

Response

Close an account v2

POST / v2 / core / accounts /:id / close

Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.

Learn more about calling API v2 endpoints.

Parameters

applied _ configurations array of enums Configurations on the Account to be closed. All configurations on the Account must be passed in for this request to succeed. Possible enum values customer The Account can be used as a customer. merchant The Account can be used as a merchant. recipient The Account can be used as a recipient.

Returns

Returns an Account object.

Error Codes

400 account _ not _ yet _ compatible _ with _ v2

Account is not yet compatible with V2 APIs.

400 accounts _ v2 _ access _ blocked

Accounts v2 is not enabled for your merchant.

400 cannot _ delete _ account _ with _ balance

Account with Merchant or Recipient configuration with transfers feature cannot be closed because the account has a cash balance.

400 cannot _ delete _ customer _ with _ available _ cash _ balance

Account with Customer configuration cannot be closed because the customer has a cash balance.

400 configs _ must _ match _ to _ close

Account cannot be closed without specifying the right configurations.

400 non _ connect _ platform _ accounts _ v2 _ access _ blocked

Needs to use the newer API version or onboard to Connect.

400 pending _ transactions _ cannot _ be _ deleted

Account cannot be closed due to other pending resources.

400 platform _ registration _ required

The direct merchant has not signed up for Connect and cannot create connected accounts.

400 stripe _ loss _ liable _ cannot _ be _ deleted

Account with Stripe-owned loss liability and dashboard cannot be deleted.

400 v1 _ account _ instead _ of _ v2 _ account

V1 Account ID cannot be used in V2 Account APIs.

400 v1 _ customer _ instead _ of _ v2 _ account

V1 Customer ID cannot be used in V2 Account APIs.

404 not _ found

The resource wasn’t found.

429 account _ rate _ limit _ exceeded

Account cannot exceed a configured concurrency rate limit on updates.

Response

{ "id": "acct_1Nv0FGQ9RKHgCVdK", "object": "v2.core.account", "applied_configurations": [ "merchant" ], "contact_email": "jenny.rosen@example.com", "created": "2024-11-26T16:33:03.000Z", "dashboard": "none", "display_name": "Jenny Rosen", "livemode": true, "metadata": {}}