Events

Retrieve an event

Changed on

Retrieves an event object.

get/v1/event/{event_id}

Request

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

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' | 'account_number.activated' | 'account_number.deactivated' | 'account_number.canceled' | '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' | 'receivable_sale.created' | 'receivable_sale.no_receivables_for_sale' | 'receivable_sale.settled' | 'receivable_sale.failed' | 'blockchain_payment.payment_created' | 'blockchain_payment.payment_under_review' | 'blockchain_payment.payment_submitted' | 'blockchain_payment.payment_posted' | 'blockchain_payment.payment_rejected' | 'blockchain_payment.payment_canceled'

The type of event.

created_atstring

Timestamp at which the Event object was created.

object_versionstring

Version of the resource object included in the event.

objectobject

The object associated with this event.

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 optional property to the response with the status