Retrieve an Account v2

Retrieves the details of an Account.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
The ID of the Account to retrieve.

includearray 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.

configuration.storer

Include parameter to expose configuration.storer on an Account.

defaults

Include parameter to expose defaults on an Account.

identity

Include parameter to expose identity on an Account.

requirements

Include parameter to expose requirements on an Account.

Returns

Response attributes

idstring
Unique identifier for the Account.

objectstring, value is "v2.core.account"
String representing the object’s type. Objects of the same type share the same value of the object field.

applied_configurationsarray 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.
storer
The Account can be used as a storer.

configurationnullable object
An Account Configuration which allows the Account to take on a key persona across Stripe products.

contact_emailnullable string
The default contact email address for the Account. Required when configuring the account as a merchant or recipient.

createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

dashboardnullable enum
A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.
Possible enum values
express
The Account has access to the Express hosted dashboard.
full
The Account has access to the full Stripe hosted dashboard.
none
The Account does not have access to any Stripe hosted dashboard.

defaultsnullable object
Default values to be used on Account Configurations.

display_namenullable string
A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.

identitynullable object
Information about the company, individual, and business represented by the Account.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

requirementsnullable object
Information about the requirements for the Account, including what information needs to be collected, and by when.

Error Codes

400v1_account_instead_of_v2_account

V1 Account ID cannot be used in V2 Account APIs.

400v1_customer_instead_of_v2_account

V1 Customer ID cannot be used in V2 Account APIs.

404not_found

The resource wasn’t found.

GET /v2/core/accounts/:id

Server-side language

curl -G https://api.stripe.com/v2/core/accounts/acct_1Nv0FGQ9RKHgCVdK \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview" \
  -d include=identity \
  -d include="configuration.merchant"

Response

{
  "id": "acct_1Nv0FGQ9RKHgCVdK",
  "object": "v2.core.account",
  "applied_configurations": [
    "merchant",
    "customer"
  ],
  "configuration": {
    "merchant": {
      "card_payments": {
        "decline_on": {
          "avs_failure": false,
          "cvc_failure": false
        }
      },
      "capabilities": {
        "card_payments": {
          "requested": true,
          "status": "restricted",
          "status_details": [
            {
              "code": "requirements_past_due",
              "resolution": "provide_info"
            }
          ]
        }
      },
      "statement_descriptor": {
        "descriptor": "accessible.stripe.com"
      },
      "mcc": "5734"
    }
  },
  "contact_email": "furever@example.com",
  "created": "2024-11-26T16:33:03.000Z",
  "dashboard": "none",
  "identity": {
    "business_details": {
      "doing_business_as": "FurEver",
      "id_numbers": [
        {
          "type": "us_ein"
        }
      ],
      "product_description": "Saas pet grooming platform at furever.dev using Connect embedded components",
      "structure": "sole_proprietorship",
      "url": "http://accessible.stripe.com"
    },
    "country": "us"
  },
  "display_name": "Furever",
  "livemode": true,
  "metadata": {}
}

List all Account objects v2

Returns a list of Accounts.

Learn more about calling API v2 endpoints.

Parameters

applied_configurationsarray of strings
Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have.

limitinteger
The upper limit on the number of accounts returned by the List Account request.

pagestring
The page token to navigate to next or previous batch of accounts given by the list request.

Returns

Response attributes

dataarray of objects
A list of retrieved Account objects.

next_page_urlnullable string
URL with page token to navigate to next batch of accounts given by the list request.

previous_page_urlnullable string
URL with page token to navigate to previous batch of accounts given by the list request.

GET /v2/core/accounts

Server-side language

curl -G https://api.stripe.com/v2/core/accounts \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview" \
  -d limit=2 \
  -d applied_configurations=customer

Response

{
  "data": [
    {
      "id": "acct_1QP3oLBUFVXWiKFB",
      "object": "v2.core.account",
      "applied_configurations": [
        "customer"
      ],
      "contact_email": "jenny.rosen@example.com",
      "created": "2024-11-25T15:02:50.000Z",
      "display_name": "Jenny Rosen",
      "livemode": true,
      "metadata": {}
    },
    {
      "id": "acct_1QO24tPeVxUa6gV6",
      "object": "v2.core.account",
      "applied_configurations": [
        "recipient",
        "customer",
        "merchant"
      ],
      "contact_email": "jenny.rosen@example.com",
      "created": "2024-11-22T18:59:45.000Z",
      "dashboard": "none",
      "display_name": "Jenny Rosen 2",
      "livemode": true,
      "metadata": {
        "my_key": "my_value"
      }
    }
  ],
  "next_page_url": "/v2/core/accounts?page=page_5dr8SFDbv7rZ2aj4ZSGuf4J1Dv58yE0YM4BhBqb2tg94CD5PDoUA7RD2AE7VBEH5C0E0qGJi1wMFPf9MEBbh6M125&limit=2&applied_configurations=customer"
}

Close an Account v2

Removes access to the Account and its associated resources.

Learn more about calling API v2 endpoints.

Parameters

idstringRequired
The ID of the Account to close.

applied_configurationsarray 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.
storer
The Account can be used as a storer.

Returns

Response attributes

idstring
Unique identifier for the Account.

objectstring, value is "v2.core.account"
String representing the object’s type. Objects of the same type share the same value of the object field.

applied_configurationsarray 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.
storer
The Account can be used as a storer.

configurationnullable object
An Account Configuration which allows the Account to take on a key persona across Stripe products.

contact_emailnullable string
The default contact email address for the Account. Required when configuring the account as a merchant or recipient.

createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

dashboardnullable enum
A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.
Possible enum values
express
The Account has access to the Express hosted dashboard.
full
The Account has access to the full Stripe hosted dashboard.
none
The Account does not have access to any Stripe hosted dashboard.

defaultsnullable object
Default values to be used on Account Configurations.

display_namenullable string
A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.

identitynullable object
Information about the company, individual, and business represented by the Account.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

requirementsnullable object
Information about the requirements for the Account, including what information needs to be collected, and by when.

Error Codes

400cannot_delete_account_with_balance

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

400cannot_delete_customer_with_available_cash_balance

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

400configs_must_match_to_close

Account cannot be closed without specifying the right configurations.

400pending_transactions_cannot_be_deleted

Account cannot be closed due to other pending resources.

400platform_registration_required

Platform has not signed up for Connect and cannot create connected accounts.

400stripe_loss_liable_cannot_be_deleted

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

400v1_account_instead_of_v2_account

V1 Account ID cannot be used in V2 Account APIs.

400v1_customer_instead_of_v2_account

V1 Customer ID cannot be used in V2 Account APIs.

404not_found

The resource wasn’t found.

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

Server-side language

curl -X POST https://api.stripe.com/v2/core/accounts/acct_1Nv0FGQ9RKHgCVdK/close \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-07-30.preview" \
  --json '{
    "applied_configurations": [
        "merchant"
    ]
  }'

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": {}
}

Account event types v2

This is a list of all public thin events we currently send for updates to Account, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

v2.core.account.closed

This event occurs when an account is closed.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account.closed"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.core.account.created

Occurs when an Account is created.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account.created"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.core.account.updated

Occurs when an Account is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account.updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.core.account[configuration.customer].capability_status_updated

Occurs when the status of an Account's customer configuration capability is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.customer].capability_status_updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-28T20:33:01.123Z",
  "id": "evt_test_65SSMJhMl1dA8fh6lLW16RXPD96YSQQWRFoysHSB2ueQ9A",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.customer].capability_status_updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.customer"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-28T20:33:01.123Z",
  "id": "evt_test_65SSMJhMl1dA8fh6lLW16RXPD96YSQQWRFoysHSB2ueQ9A",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.customer].capability_status_updated",
  "data": {
    "updated_capability": "automatic_indirect_tax"
  },
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.customer"
  },
  "changes": null
}

v2.core.account[configuration.customer].updated

Occurs when an Account's customer configuration is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.customer].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SSMJhhIMgYc9ZsFLW16RXPD96YSQQWRFoysHSB2ueOUy",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.customer].updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.customer"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SSMJhhIMgYc9ZsFLW16RXPD96YSQQWRFoysHSB2ueOUy",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.customer].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.customer"
  },
  "changes": null
}

v2.core.account[configuration.merchant].capability_status_updated

Occurs when the status of an Account's merchant configuration capability is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.merchant].capability_status_updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-28T20:34:42.026Z",
  "id": "evt_test_65SSMLK1ZTX7OYhyjSr16RXPD96YSQQWRFoysHSB2ueHya",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.merchant].capability_status_updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.merchant"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-28T20:34:42.026Z",
  "id": "evt_test_65SSMLK1ZTX7OYhyjSr16RXPD96YSQQWRFoysHSB2ueHya",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.merchant].capability_status_updated",
  "data": {
    "updated_capability": "card_payments"
  },
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.merchant"
  },
  "changes": null
}

v2.core.account[configuration.merchant].updated

Occurs when an Account's merchant configuration is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.merchant].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SSMLJIK4u1GJY5ySr16RXPD96YSQQWRFoysHSB2ueWLg",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.merchant].updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.merchant"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SSMLJIK4u1GJY5ySr16RXPD96YSQQWRFoysHSB2ueWLg",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.merchant].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.merchant"
  },
  "changes": null
}

v2.core.account[configuration.recipient].capability_status_updated

Occurs when the status of an Account's recipient configuration capability is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.recipient].capability_status_updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-01T23:03:17.678Z",
  "id": "evt_test_65SIbnJV74bY3Gprd8316RXPD96YSQQWRFoysHSB2ueM52",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.recipient].capability_status_updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.recipient"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-01T23:03:17.678Z",
  "id": "evt_test_65SIbnJV74bY3Gprd8316RXPD96YSQQWRFoysHSB2ueM52",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.recipient].capability_status_updated",
  "data": {
    "updated_capability": "stripe_balance.stripe_transfers"
  },
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.recipient"
  },
  "changes": null
}

v2.core.account[configuration.recipient].updated

Occurs when a Recipient's configuration is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.recipient].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SIbnIZpPGoUur818316RXPD96YSQQWRFoysHSB2ue7Qm",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.recipient].updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.recipient"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-01T23:03:16.425Z",
  "id": "evt_test_65SIbnIZpPGoUur818316RXPD96YSQQWRFoysHSB2ue7Qm",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.recipient].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=configuration.recipient"
  },
  "changes": null
}

v2.core.account[configuration.storer].capability_status_updated

Occurs when the status of an Account's storer configuration capability is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.storer].capability_status_updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-06-26T17:32:39.530Z",
  "id": "evt_test_65SnhcVsdHPetOMGZki16SmWzO0eE9IIrYxa2T2K4MqDdY",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.storer].capability_status_updated",
  "data": {
    "updated_capability": "outbound_transfers.financial_accounts"
  },
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1Re4Nh05fklPI6a9",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1Re4Nh05fklPI6a9?include=configuration.storer"
  },
  "changes": {
    "before": null,
    "after": null
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "id": "evt_test_65SnhcVsdHPetOMGZki16SmWzO0eE9IIrYxa2T2K4MqDdY",
  "object": "v2.core.event",
  "changes": {
    "before": null,
    "after": null
  },
  "context": "acct_1Rd92306GG1czfwR",
  "created": "2025-06-26T17:32:39.530Z",
  "data": null,
  "reason": null,
  "related_object": {
    "id": "acct_1Re4Nh05fklPI6a9",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1Re4Nh05fklPI6a9?include=configuration.storer"
  },
  "type": "v2.core.account[configuration.storer].capability_status_updated",
  "livemode": false
}

v2.core.account[configuration.storer].updated

Occurs when a Storer's configuration is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[configuration.storer].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-06-26T17:32:40.295Z",
  "id": "evt_test_65SnhcWJSyXD7prOFki16SmWzO0eE9IIrYxa2T2K4MqLGy",
  "object": "v2.core.event",
  "type": "v2.core.account[configuration.storer].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1Re4Nh05fklPI6a9",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1Re4Nh05fklPI6a9?include=configuration.storer"
  },
  "changes": null
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "id": "evt_test_65SnhcWJSyXD7prOFki16SmWzO0eE9IIrYxa2T2K4MqLGy",
  "object": "v2.core.event",
  "changes": null,
  "context": "acct_1Rd92306GG1czfwR",
  "created": "2025-06-26T17:32:40.295Z",
  "data": null,
  "reason": null,
  "related_object": {
    "id": "acct_1Re4Nh05fklPI6a9",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1Re4Nh05fklPI6a9?include=configuration.storer"
  },
  "type": "v2.core.account[configuration.storer].updated",
  "livemode": false
}

v2.core.account[defaults].updated

This event occurs when account defaults are created or updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[defaults].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

v2.core.account[identity].updated

Occurs when an Identity is updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[identity].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-28T20:48:08.710Z",
  "id": "evt_test_65SSMYK8uw9bZdmkiyd16RXPD96YSQQWRFoysHSB2ueSn2",
  "object": "v2.core.event",
  "type": "v2.core.account[identity].updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=identity"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-28T20:48:08.710Z",
  "id": "evt_test_65SSMYK8uw9bZdmkiyd16RXPD96YSQQWRFoysHSB2ueSn2",
  "object": "v2.core.event",
  "type": "v2.core.account[identity].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=identity"
  },
  "changes": null
}

v2.core.account[requirements].updated

Occurs when an Account's requirements are updated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.core.account[requirements].updated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-04-01T23:03:18.235Z",
  "id": "evt_test_65SIbnKv7aZvHPCht8316RXPD96YSQQWRFoysHSB2ue4iG",
  "object": "v2.core.event",
  "type": "v2.core.account[requirements].updated",
  "livemode": false,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=requirements"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-04-01T23:03:18.235Z",
  "id": "evt_test_65SIbnKv7aZvHPCht8316RXPD96YSQQWRFoysHSB2ue4iG",
  "object": "v2.core.event",
  "type": "v2.core.account[requirements].updated",
  "data": {},
  "livemode": false,
  "reason": null,
  "related_object": {
    "id": "acct_1RIyMKPt46znscxj",
    "type": "v2.core.account",
    "url": "/v2/core/accounts/acct_1RIyMKPt46znscxj?include=requirements"
  },
  "changes": null
}

Account Links v2

AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.

Learn more about calling API v2 endpoints.

Endpoints

POST/v2/core/account_links

Retrieve an Account v2

Parameters

idstringRequired

includearray of enums

Returns

Response attributes

idstring

objectstring, value is "v2.core.account"

applied_configurationsarray of enums

configurationnullable object

contact_emailnullable string

createdtimestamp

dashboardnullable enum

defaultsnullable object

display_namenullable string

identitynullable object

livemodeboolean

metadatanullable map

requirementsnullable object

List all Account objects v2

Parameters

applied_configurationsarray of strings

limitinteger

pagestring

Returns

Response attributes

dataarray of objects

next_page_urlnullable string

previous_page_urlnullable string

Close an Account v2

Parameters

idstringRequired

applied_configurationsarray of enums

Returns

Response attributes

idstring

objectstring, value is "v2.core.account"

applied_configurationsarray of enums

configurationnullable object

contact_emailnullable string

createdtimestamp

dashboardnullable enum

defaultsnullable object

display_namenullable string

identitynullable object

livemodeboolean

metadatanullable map

requirementsnullable object

Account event types v2

Event types

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.core.account.closed"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object

typestring, value is "v2.core.account.created"

Fetched attributes

dataobject

Attributes

idstring

objectstring, value is "v2.core.event"

contextnullable string

createdtimestamp

livemodeboolean

reasonnullable object

related_objectnullable object