Events

List all events

Changed on

List all event objects.

get/v1/event

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v1/event
  • Auth
    HTTP bearer

Query parameters

eventsEventType[]

Return events of these type.

ID of the Event object you want to retrieve.

afterstring date-time

Return objects where the created_at timestamp is after the entered timestamp.

on_or_afterstring date-time

Return objects where the created_at timestamp is the same as or after the entered timestamp.

beforestring date-time

Return objects where the created_at timestamp is before the entered timestamp.

on_or_beforestring date-time

Return objects where the created_at timestamp is the same as or before the entered timestamp.

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

limitinteger

Maximum number of objects to be returned.

starting_afterstring

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

ending_beforestring

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

object_idstring
Example:wire_12345

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.

Response

A list of events

has_moreboolean required

Indicates whether more results are available.

Changes

    • warning

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

    • warning

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

    • warning

      added the new account_number.deactivated enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_canceled enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_created enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_posted enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_rejected enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_submitted enum value to the // response property for the response status

    • warning

      added the new blockchain_payment.payment_under_review enum value to the // response property for the response status

    • warning

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

    • warning

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

    • warning

      added the new receivable_sale.no_receivables_for_sale enum value to the // response property for the response status

    • warning

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

    • info

      added the enum value account_number.activated to the property items/ of the query request parameter events

    • info

      added the enum value account_number.canceled to the property items/ of the query request parameter events

    • info

      added the enum value account_number.deactivated to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_canceled to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_created to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_posted to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_rejected to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_submitted to the property items/ of the query request parameter events

    • info

      added the enum value blockchain_payment.payment_under_review to the property items/ of the query request parameter events

    • info

      added the enum value receivable_sale.created to the property items/ of the query request parameter events

    • info

      added the enum value receivable_sale.failed to the property items/ of the query request parameter events

    • info

      added the enum value receivable_sale.no_receivables_for_sale to the property items/ of the query request parameter events

    • info

      added the enum value receivable_sale.settled to the property items/ of the query request parameter events

    • info

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