v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB

Events

Retrieve an event

Retrieves an event object.

get/v1/event/{event_id}

Path parameters

event_idstring required

Example:event_xyz001

ID of the Event object you want to retrieve.

Response

An Event object.

idstring

ID of the Event object.

event'ach.processing' | 'ach.submitted' | 'ach.posted' | 'ach.under_review' | 'ach.approved' | 'ach.rejected' | 'ach.pending_return' | 'ach.returned' | 'ach.corrected' | 'ach.canceled' | 'ach.scheduled' | 'ach.return_dishonored' | 'ach.return_contested' | 'account_number.created' | 'internal_transfer.succeeded' | 'internal_transfer.failed' | 'internal_transfer.posted' | 'internal_transfer.rejected' | 'lending.disbursement.processing' | 'lending.disbursement.succeeded' | 'lending.disbursement.failed' | 'lending.disbursement.ach_correction' | 'wire.created' | 'wire.under_review' | 'wire.scheduled' | 'wire.processing' | 'wire.posted' | 'wire.rejected' | 'wire.canceled' | 'wire.cancel_pending' | 'instant_payment.posted' | 'instant_payment.rejected' | 'instant_payment.under_review' | 'instant_payment.counterparty_status_updated' | 'instant_payment.return_request_response_needed' | 'instant_payment.return_request_status_updated' | 'funding.posted' | 'funding.rejected'

The type of event.

created_atstring

Timestamp at which the Event object was created.

objectobject

The object associated with this event.