Skip to main content
GET
/
v1
/
event
List all events
curl --request GET \
  --url https://api.sandbox.lead.bank/v1/event \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "<string>",
      "event": "ach.processing",
      "created_at": "<string>",
      "object": {}
    }
  ],
  "has_more": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
events
enum<string>[]

ID of the Event object you want to retrieve. Return events of these type.

The type of event.

Available options:
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,
wire.return_request.received,
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_changed
​
created_at
object

A set of filters on the list using the object’s field created_at.

​
limit
integer<int32>
default:10

Maximum number of objects to be returned.

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for use in pagination; this is an Event ID that defines your place in the list.

Pattern: ^event_\w+$
​
ending_before
string

A cursor for use in pagination; this is an Event ID that defines your place in the list.

Pattern: ^event_\w+$
​
object_id
string

Filter events by the ID of the associated object (e.g., wire_12345). If the object_id doesn't match the event filter's object type, returns empty results.

Pattern: ^(ach|wire|account_number|internal_transfer|disbursement)_\w+$
Example:

"wire_12345"

Response

A list of events

​
objects
object[]
required
​
has_more
boolean
required

Indicates whether more results are available.