Sign in
Events

Get event

Get an event

get/events/{eventId}

Path parameters

eventIdstring required

Event ID (evt_*).

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.

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 11 of the 50 revisions of this API.4916

  • 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

  • 6e52d1bd00549See 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

  • 1132c9ddb7bd16See 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

  • 226131258c125See 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

  • 3d0bfe344af24See 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

  • 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

  • a77f94c2883a11See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

  • c309952835b58See 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