Sign in
Events

List events

List events

get/events

Query parameters

customerPartyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

eventType'party.updated' | 'compliance_case.updated' | 'wallet.created' | 'external_account.connected' | 'agent_delegation_invitation.created' | 'agent_delegation_invitation.accepted' | 'agent_delegation_invitation.declined' | 'agent_delegation_invitation.canceled' | 'agent_delegation.revoked' | 'delegation.activated' | 'delegation.revoked' | 'invitation_link.created' | 'invitation_link.revoked' | 'invitation_link.agent_added' | 'invitation_link.agent_removed' | 'invitation_link.redeemed' | 'deposit.created' | 'deposit.completed' | 'deposit.failed' | 'deposit.returned' | 'deposit.canceled' | 'deposit.approval_denied' | 'withdrawal.created' | 'withdrawal.completed' | 'withdrawal.failed' | 'withdrawal.returned' | 'withdrawal.canceled' | 'withdrawal.approval_denied' | 'payment.created' | 'payment.completed' | 'payment.failed' | 'payment.returned' | 'payment.canceled' | 'payment.approval_denied' | 'ach.created' | 'ach.processing' | 'ach.settled' | 'ach.failed' | 'ach.returned' | 'realtime.created' | 'realtime.processing' | 'realtime.settled' | 'realtime.failed' | 'wire.created' | 'wire.processing' | 'wire.completed' | 'wire.rejected' | 'wire.failed' | 'check.created' | 'check.processing' | 'check.completed' | 'check.returned' | 'check.canceled' | 'check.expired' | 'check.rejected' | 'check.failed' | 'check.returned_to_sender' | 'external_party_account.validated' | 'approval.required' | 'approval.approved' | 'approval.denied' | 'approval.canceled' | 'payment_request.created' | 'payment_request.completed' | 'payment_request.canceled' | 'payment_request.declined' | 'payment_request.incoming' | 'paymentIntent.completed' | 'cardPayment.succeeded' | 'cardPayment.failed' | 'paymentIntent.canceled' | 'cardPayment.created' | 'refund.created' | 'refund.succeeded' | 'refund.failed' | 'chargeback.created' | 'chargeback.updated' | 'chargeback.closed' | 'enrollment.applied' | 'enrollment.activated' | 'enrollment.rejected' | 'enrollment.offboarded' | 'mandate.created' | 'mandate.updated' | 'mandate.revoked'

Filter by event type. Required when customerPartyId names another party.

createdAfterstring date-time

Only events created after this RFC 3339 timestamp (exclusive).

createdBeforestring date-time

Only events created before this RFC 3339 timestamp (exclusive).

cursorstring

Cursor from the previous page.

limitinteger

Maximum results per page.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

Changed in 12 of the 50 revisions of this API.15264

  • bcf3b028c3e511See the full diff
    • ●

      deleted the query request parameter partyId

      request-parameter-removed

    • ○

      added the new optional query request parameter customerPartyId

      new-optional-request-parameter

  • 6e52d1bd005499See the full diff
    • ●

      added the new check.canceled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.expired enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.returned enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new check.returned_to_sender enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value check.canceled to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.completed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.expired to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.processing to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.rejected to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.returned to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value check.returned_to_sender to the query request parameter eventType

      request-parameter-enum-value-added

  • 1132c9ddb7bd1616See the full diff
    • ●

      added the new cardPayment.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cardPayment.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new cardPayment.succeeded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.closed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new chargeback.updated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.activated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.applied enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.offboarded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new enrollment.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.updated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new paymentIntent.canceled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new paymentIntent.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new refund.succeeded enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value cardPayment.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value cardPayment.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value cardPayment.succeeded to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value chargeback.closed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value chargeback.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value chargeback.updated to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value enrollment.activated to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value enrollment.applied to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value enrollment.offboarded to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value enrollment.rejected to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value mandate.updated to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value paymentIntent.canceled to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value paymentIntent.completed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value refund.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value refund.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value refund.succeeded to the query request parameter eventType

      request-parameter-enum-value-added

  • 226131258c1255See the full diff
    • ●

      added the new wire.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wire.rejected enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value wire.completed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value wire.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value wire.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value wire.processing to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value wire.rejected to the query request parameter eventType

      request-parameter-enum-value-added

  • 3d0bfe344af244See the full diff
    • ●

      added the new realtime.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new realtime.settled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value realtime.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value realtime.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value realtime.processing to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value realtime.settled to the query request parameter eventType

      request-parameter-enum-value-added

  • c7c12da5915f12See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • a77f94c2883a112See the full diff
    • ▲

      removed the enum value ach.completed from the query request parameter eventType

      request-parameter-enum-value-removed

    • ●

      added the new ach.settled enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value ach.settled to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      removed the ach.completed enum value from the /// response property for the response status

      response-property-enum-value-removed

  • c309952835b588See the full diff
    • ●

      added the new ach.completed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ach.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ach.failed enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ach.processing enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new ach.returned enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new external_party_account.validated enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.created enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new mandate.revoked enum value to the /// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value ach.completed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.processing to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.returned to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value external_party_account.validated to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value mandate.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value mandate.revoked to the query request parameter eventType

      request-parameter-enum-value-added