Types of events v2

Core Resources
Events
Types of events

This is a list of all public thin events we currently send for /v1 and /v2 resources, 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
Related object
Account
and 11 more

v1.billing.meter.error_report_triggered

Occurs when a Meter has invalid async usage events.

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 "v1.billing.meter.error_report_triggered"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.developer_message_summarystring

      Extra field included in the event’s data when fetched from /v2/events.

    • data.reasonobject

      This contains information about why meter error happens.

      • data.reason.error_countinteger

        The total error count within this window.

      • data.reason.error_typesarray of objects

        The error details.

        • data.reason.error_types.codeenum

          Possible enum values
          archived_meter

          Enum value: archived_meter.

          meter_event_customer_not_found

          Enum value: meter_event_customer_not_found.

          meter_event_dimension_count_too_high

          Enum value: meter_event_dimension_count_too_high.

          meter_event_invalid_value

          Enum value: meter_event_invalid_value.

          meter_event_no_customer_defined

          Enum value: meter_event_no_customer_defined.

          missing_dimension_payload_keys

          Enum value: missing_dimension_payload_keys.

          no_meter

          Enum value: no_meter.

          timestamp_in_future

          Enum value: timestamp_in_future.

          timestamp_too_far_in_past

          Enum value: timestamp_too_far_in_past.

        • data.reason.error_types.error_countinteger

          The number of errors of this type.

        • data.reason.error_types.sample_errorsarray of objects

          A list of sample errors of this type.

          • data.reason.error_types.sample_errors.error_messagestring

            The error message.

          • data.reason.error_types.sample_errors.requestobject

            The request causes the error.

            • data.reason.error_types.sample_errors.request.identifierstring

              The request idempotency key.

    • data.validation_endtimestamp

      The end of the window that is encapsulated by this summary.

    • data.validation_starttimestamp

      The start of the window that is encapsulated by this summary.

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

v1.billing.meter.no_meter_found

Occurs when a Meter's id is missing or invalid in async usage events.

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 "v1.billing.meter.no_meter_found"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.developer_message_summarystring

      Extra field included in the event’s data when fetched from /v2/events.

    • data.reasonobject

      This contains information about why meter error happens.

      • data.reason.error_countinteger

        The total error count within this window.

      • data.reason.error_typesarray of objects

        The error details.

        • data.reason.error_types.codeenum

          Possible enum values
          archived_meter

          Enum value: archived_meter.

          meter_event_customer_not_found

          Enum value: meter_event_customer_not_found.

          meter_event_dimension_count_too_high

          Enum value: meter_event_dimension_count_too_high.

          meter_event_invalid_value

          Enum value: meter_event_invalid_value.

          meter_event_no_customer_defined

          Enum value: meter_event_no_customer_defined.

          missing_dimension_payload_keys

          Enum value: missing_dimension_payload_keys.

          no_meter

          Enum value: no_meter.

          timestamp_in_future

          Enum value: timestamp_in_future.

          timestamp_too_far_in_past

          Enum value: timestamp_too_far_in_past.

        • data.reason.error_types.error_countinteger

          The number of errors of this type.

        • data.reason.error_types.sample_errorsarray of objects

          A list of sample errors of this type.

          • data.reason.error_types.sample_errors.error_messagestring

            The error message.

          • data.reason.error_types.sample_errors.requestobject

            The request causes the error.

            • data.reason.error_types.sample_errors.request.identifierstring

              The request idempotency key.

    • data.validation_endtimestamp

      The end of the window that is encapsulated by this summary.

    • data.validation_starttimestamp

      The start of the window that is encapsulated by this summary.

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

v2.core.account_link.completed

Occurs when the generated AccountLink is completed.

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_link.completed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.account_idstring

      The ID of the v2 account.

    • data.configurationsarray of enums

      Configurations on the Account that was onboarded via the account link.

      Possible enum values
      recipient

      The Account can be used as a recipient.

    • data.use_caseenum

      The use case type of the account link that has been completed.

      Possible enum values
      account_onboarding

      Refers to the account_onboarding use case.

      account_update

      Refers to the account_update use case.

Event payload
{
"created": "2025-04-28T22:56:48.451Z",
"id": "evt_test_61SSOYqHs6rpAOqQS16SICEMKPSQ7pkffh0c4qJNANTk",
"object": "v2.core.event",
"type": "v2.core.account_link.completed",
"livemode": false
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"created": "2025-04-28T22:56:48.451Z",
"id": "evt_test_61SSOYqHs6rpAOqQS16SICEMKPSQ7pkffh0c4qJNANTk",
"object": "v2.core.event",
"type": "v2.core.account_link.completed",
"data": {
"account_id": "acct_1RIyMKPt46znscxj",
"configurations": [
"recipient"
],
"use_case": "account_onboarding"
},
"livemode": false,
"reason": null,
"related_object": {},
"changes": null
}

v2.core.account_person.created

Occurs when a Person 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_person.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.account_idstring

      The ID of the v2 account.

Event payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.created",
"livemode": false,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
}
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.created",
"data": {
"account_id": "acct_1RIyMKPt46znscxj"
},
"livemode": false,
"reason": null,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
},
"changes": null
}

v2.core.account_person.deleted

Occurs when a Person is deleted.

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_person.deleted"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.account_idstring

      The ID of the v2 account.

Event payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.deleted",
"livemode": false,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
}
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.deleted",
"data": {
"account_id": "acct_1RIyMKPt46znscxj"
},
"livemode": false,
"reason": null,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
},
"changes": null
}

v2.core.account_person.updated

Occurs when a Person 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_person.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.account_idstring

      The ID of the v2 account.

Event payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.updated",
"livemode": false,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
}
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"created": "2025-04-28T20:48:39.804Z",
"id": "evt_test_65SSMYpFXcSU1Rkwzk416RXPD96YSQQWRFoysHSB2ueEEy",
"object": "v2.core.event",
"type": "v2.core.account_person.updated",
"data": {
"account_id": "acct_1RIyMKPt46znscxj"
},
"livemode": false,
"reason": null,
"related_object": {
"id": "person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs",
"type": "v2.core.account_person",
"url": "/v2/core/accounts/acct_1RIyMKPt46znscxj/persons/person_test_61SSMYofvI9uiWN8k16SSMYJ6vSQjlx0WXeVr2P44Acs"
},
"changes": null
}

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

  • 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

  • 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

  • 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

  • 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 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
# 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.

    • 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

  • 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
# 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.

    • 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

  • 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 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
# 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.

    • 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

  • 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
# 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.

    • 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

  • 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 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
# 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.

    • 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

  • 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
# 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[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

  • 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

  • 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
# 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.

    • 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

  • 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
# 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
}

v2.core.event_destination.ping

A ping event used to test the connection to an event destination.

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.event_destination.ping"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.core.event_destination",
"url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.core.event_destination.ping",
"livemode": true
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.core.event_destination",
"url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.core.event_destination.ping",
"livemode": true,
"changes": {},
"data": {}
}

v2.money_management.adjustment.created

Occurs when an Adjustment 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.money_management.adjustment.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.adjustment",
"url": "/v2/money_management/adjustments/adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.adjustment.created",
"livemode": true
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.adjustment",
"url": "/v2/money_management/adjustments/adj_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.adjustment.created",
"livemode": true,
"changes": {},
"data": {}
}

v2.money_management.financial_account.created

Occurs when a FinancialAccount 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.money_management.financial_account.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_account",
"url": "/v2/money_management/financial_accounts/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_account.created"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_account",
"url": "/v2/money_management/financial_accounts/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_account.created",
"changes": {},
"data": {}
}

v2.money_management.financial_account.updated

Occurs when a FinancialAccount 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.money_management.financial_account.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_12RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v12sAB2aV6o01RdTN",
"idempotency_key": "fe21992d-e123-3f8c-bc90-abc93712bcb2"
}
},
"related_object": {
"id": "fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcSabc",
"type": "v2.money_management.financial_account",
"url": "/v2/money_management/financial_accounts/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcSabc"
},
"type": "v2.money_management.financial_account.updated",
"livemode": true
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_12RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v12sAB2aV6o01RdTN",
"idempotency_key": "fe21992d-e123-3f8c-bc90-abc93712bcb2"
}
},
"related_object": {
"id": "fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcSabc",
"type": "v2.money_management.financial_account",
"url": "/v2/money_management/financial_accounts/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcSabc"
},
"type": "v2.money_management.financial_account.updated",
"livemode": true,
"changes": {},
"data": {}
}

v2.money_management.financial_address.activated

Occurs when a FinancialAddress is activated and is ready to receive funds.

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.money_management.financial_address.activated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "finaddr_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_address",
"url": "/v2/money_management/financial_addresses/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_address.activated"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "finaddr_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_address",
"url": "/v2/money_management/financial_addresses/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_address.activated",
"changes": {},
"data": {}
}

v2.money_management.financial_address.failed

Occurs when a FinancialAddress fails to activate and can not receive funds.

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.money_management.financial_address.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "finaddr_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_address",
"url": "/v2/money_management/financial_addresses/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_address.failed"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "finaddr_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.financial_address",
"url": "/v2/money_management/financial_addresses/fa_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.financial_address.failed",
"changes": {},
"data": {}
}

v2.money_management.inbound_transfer.available

Occurs when an InboundTransfer's funds are made available.

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.money_management.inbound_transfer.available"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.transaction_idstring

      The transaction ID of the received credit.

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

v2.money_management.inbound_transfer.bank_debit_failed

Occurs when an InboundTransfer fails.

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.money_management.inbound_transfer.bank_debit_failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.inbound_transfer.bank_debit_processing

Occurs when an InboundTransfer starts processing.

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.money_management.inbound_transfer.bank_debit_processing"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.inbound_transfer.bank_debit_queued

Occurs when an InboundTransfer is queued.

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.money_management.inbound_transfer.bank_debit_queued"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.inbound_transfer.bank_debit_returned

Occurs when an InboundTransfer is returned.

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.money_management.inbound_transfer.bank_debit_returned"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.inbound_transfer.bank_debit_succeeded

Occurs when an InboundTransfer succeeds.

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.money_management.inbound_transfer.bank_debit_succeeded"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.inbound_transfer",
"url": "/v2/money_management/inbound_transfers/ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.inbound_transfer.bank_debit_succeeded"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.inbound_transfer",
"url": "/v2/money_management/inbound_transfers/ibt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.inbound_transfer.bank_debit_succeeded",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.canceled

Occurs when an OutboundPayment transitions into the canceled state.

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.money_management.outbound_payment.canceled"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.canceled"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.canceled",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.created

Occurs when an OutboundPayment 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.money_management.outbound_payment.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.created"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.created",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.failed

Occurs when an OutboundPayment transitions into the failed state.

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.money_management.outbound_payment.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.failed"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.failed",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.posted

Occurs when an OutboundPayment transitions into the posted state.

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.money_management.outbound_payment.posted"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.posted"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.posted",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.returned

Occurs when an OutboundPayment transitions into the returned state.

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.money_management.outbound_payment.returned"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.returned"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_payment",
"url": "/v2/money_management/outbound_payments/obp_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_payment.returned",
"changes": {},
"data": {}
}

v2.money_management.outbound_payment.updated

Occurs when an OutboundPayment 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.money_management.outbound_payment.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.outbound_transfer.canceled

Occurs when an OutboundTransfer transitions into the canceled state.

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.money_management.outbound_transfer.canceled"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.canceled"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.canceled",
"changes": {},
"data": {}
}

v2.money_management.outbound_transfer.created

Occurs when an OutboundTransfer 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.money_management.outbound_transfer.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.created"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.created",
"changes": {},
"data": {}
}

v2.money_management.outbound_transfer.failed

Occurs when an OutboundTransfer transitions into the failed state.

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.money_management.outbound_transfer.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.failed"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.failed",
"changes": {},
"data": {}
}

v2.money_management.outbound_transfer.posted

Occurs when an OutboundTransfer transitions into the posted state.

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.money_management.outbound_transfer.posted"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.posted"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.posted",
"changes": {},
"data": {}
}

v2.money_management.outbound_transfer.returned

Occurs when an OutboundTransfer transitions into the returned state.

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.money_management.outbound_transfer.returned"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.returned"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.outbound_transfer",
"url": "/v2/money_management/outbound_transfers/obt_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.outbound_transfer.returned",
"changes": {},
"data": {}
}

v2.money_management.outbound_transfer.updated

Event that is emitted every time an Outbound Transfer 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.money_management.outbound_transfer.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.received_credit.available

Occurs when a ReceivedCredit's funds are received and are available in your balance.

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.money_management.received_credit.available"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.transaction_idstring

      The transaction ID of the received credit.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.available"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.available",
"changes": {},
"data": {
"transaction_id": "trxn_65SIg2l4L4cgf1QMQle13Ns7tI51SQD5CcHYMPnDCEaBfE"
}
}

v2.money_management.received_credit.failed

Occurs when a ReceivedCredit is attempted to your balance and fails. See the status_details for more information.

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.money_management.received_credit.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.failed"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.failed",
"changes": {},
"data": {}
}

v2.money_management.received_credit.returned

Occurs when a ReceivedCredit is reversed, returned to the originator, and deducted from your balance.

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.money_management.received_credit.returned"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.returned"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.returned",
"changes": {},
"data": {}
}

v2.money_management.received_credit.succeeded

Occurs when a ReceivedCredit succeeds.

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.money_management.received_credit.succeeded"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.succeeded"
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"livemode": true,
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.money_management.received_credit",
"url": "/v2/money_management/received_credits/rc_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.money_management.received_credit.succeeded",
"changes": {},
"data": {}
}

v2.money_management.received_debit.canceled

Occurs when a ReceivedDebit is canceled.

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.money_management.received_debit.canceled"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.received_debit.failed

Occurs when a ReceivedDebit fails.

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.money_management.received_debit.failed"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.received_debit.pending

Occurs when a ReceivedDebit is set to pending.

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.money_management.received_debit.pending"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.received_debit.succeeded

Occurs when a ReceivedDebit succeeds.

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.money_management.received_debit.succeeded"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.received_debit.updated

Occurs when a ReceivedDebit 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.money_management.received_debit.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.transaction.created

Occurs when a Transaction 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.money_management.transaction.created"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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

v2.money_management.transaction.updated

Occurs when a Transaction 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.money_management.transaction.updated"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

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