Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Account event types v2

Core Resources
Accounts
Account event types

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

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

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

Event handler
# 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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

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

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

Event handler
# 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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account.updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

Event handler
# 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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.customer].capability_status_updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

    • data.updated_capabilityenum

      The capability which had its status updated.

      Possible enum values
      automatic_indirect_tax

      Refers to the customer.capabilities.card_payments capability.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.customer].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.merchant].capability_status_updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

    • data.updated_capabilityenum

      The capability which had its status updated.

      Possible enum values
      ach_debit_payments

      Refers to the merchant.capabilities.ach_debit_payments capability.

      acss_debit_payments

      Refers to the merchant.capabilities.acss_debit_payments capability.

      affirm_payments

      Refers to the merchant.capabilities.affirm_payments capability.

      afterpay_clearpay_payments

      Refers to the merchant.capabilities.afterpay_clearpay_payments capability.

      alma_payments

      Refers to the merchant.capabilities.alma_payments capability.

      amazon_pay_payments

      Refers to the merchant.capabilities.amazon_pay_payments capability.

      au_becs_debit_payments

      Refers to the merchant.capabilities.au_becs_debit_payments capability.

      bacs_debit_payments

      Refers to the merchant.capabilities.bacs_debit_payments capability.

      bancontact_payments

      Refers to the merchant.capabilities.bancontact_payments capability.

      blik_payments

      Refers to the merchant.capabilities.blik_payments capability.

      Show 35 more
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.merchant].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.recipient].capability_status_updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

    • data.updated_capabilityenum

      The capability which had its status updated.

      Possible enum values
      bank_accounts.local

      Refers to the recipient.capabilities.bank_accounts.local capability.

      bank_accounts.wire

      Refers to the recipient.capabilities.bank_accounts.wire capability.

      cards

      Refers to the recipient.capabilities.cards capability.

      stripe.transfers

      DEPRECATED: use RECIPIENT_CONFIG__STRIPE_TRANSFERS_CAPABILITY instead – Refers to the recipient.capabilities.stripe.transfers capability.

      stripe_balance.payouts

      Refers to the recipient.capabilities.stripe_balance.payouts capability.

      stripe_balance.stripe_transfers

      Refers to the recipient.capabilities.stripe_balance.stripe_transfers capability.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[configuration.recipient].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[defaults].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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

v2.core.account[future_requirements].updated

Occurs when an Account's future 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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[future_requirements].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

Event handler
# 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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[identity].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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

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.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

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

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.account[requirements].updated"

    The type of the event.

Fetched attributes

  • changesnullable object

    Before and after changes for the primary related object.

  • dataobject

    Additional data about the event.

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