Skip to content
Stainless Stainless Stainless SDKs

Events

Events

Last updated: (timestamp)

Events

events
Methods
Get event
get/v1/events/{event_token}

Get an event.

List events
get/v1/events

List all events.

List message attempts for an event
get/v1/events/{event_token}/attempts

List all the message attempts for a given event.

Domain Types
Event
Eventobject

A single event that affects the transaction state and lifecycle.

ShowShow
tokenstring

Globally unique identifier.

createdstring

An RFC 3339 timestamp for when the event was created. UTC time zone.

If no timezone is specified, UTC will be used.

formatdate-time
event_typeenum
Accepts one of the following: "account_holder.created", "account_holder.updated", "account_holder.verification", 40 more

Event types:

  • account_holder.created - Notification that a new account holder has been created and was not rejected.
  • account_holder.updated - Notification that an account holder was updated.
  • account_holder.verification - Notification than an account holder's identity verification is complete.
  • card.created - Notification that a card has been created.
  • card.renewed - Notification that a card has been renewed.
  • card.reissued - Notification that a card has been reissued.
  • card.shipped - Physical card shipment notification. See https://docs.lithic.com/docs/cards#physical-card-shipped-webhook.
  • card.converted - Notification that a virtual card has been converted to a physical card.
  • card_transaction.updated - Transaction Lifecycle webhook. See https://docs.lithic.com/docs/transaction-webhooks.
  • dispute.updated - A dispute has been updated.
  • digital_wallet.tokenization_approval_request - Card network's request to Lithic to activate a digital wallet token.
  • digital_wallet.tokenization_result - Notification of the end result of a tokenization, whether successful or failed.
  • digital_wallet.tokenization_two_factor_authentication_code - A code to be passed to an end user to complete digital wallet authentication. See https://docs.lithic.com/docs/tokenization-control#digital-wallet-tokenization-auth-code.
  • digital_wallet.tokenization_two_factor_authentication_code_sent - Notification that a two factor authentication code for activating a digital wallet has been sent to the end user.
  • digital_wallet.tokenization_updated - Notification that a digital wallet tokenization's status has changed.
Hide ParametersShow Parameters
"account_holder.created"
"account_holder.updated"
"account_holder.verification"
"auth_rules.performance_report.created"
"balance.updated"
"book_transfer_transaction.created"
"card.created"
"card.renewed"
"card.reissued"
"card.converted"
"card.shipped"
"card_transaction.updated"
"digital_wallet.tokenization_approval_request"
"digital_wallet.tokenization_result"
"digital_wallet.tokenization_two_factor_authentication_code"
"digital_wallet.tokenization_two_factor_authentication_code_sent"
"digital_wallet.tokenization_updated"
"dispute.updated"
"dispute_evidence.upload_failed"
"external_bank_account.created"
"external_bank_account.updated"
"external_payment.created"
"external_payment.updated"
"financial_account.created"
"financial_account.updated"
"funding_event.created"
"loan_tape.created"
"loan_tape.updated"
"management_operation.created"
"management_operation.updated"
"payment_transaction.created"
"payment_transaction.updated"
"internal_transaction.created"
"internal_transaction.updated"
"settlement_report.updated"
"statements.created"
"three_ds_authentication.created"
"three_ds_authentication.updated"
"tokenization.approval_request"
"tokenization.result"
"tokenization.two_factor_authentication_code"
"tokenization.two_factor_authentication_code_sent"
"tokenization.updated"
payloadRecord<string, unknown>
Event Subscription
EventSubscriptionobject

A subscription to specific event types.

ShowShow
tokenstring

Globally unique identifier.

descriptionstring

A description of the subscription.

disabledboolean

Whether the subscription is disabled.

urlstring
formaturi
event_typesarray of enum
optional
Hide ParametersShow Parameters
"account_holder.created"
"account_holder.updated"
"account_holder.verification"
"auth_rules.performance_report.created"
"balance.updated"
"book_transfer_transaction.created"
"card.created"
"card.renewed"
"card.reissued"
"card.converted"
"card.shipped"
"card_transaction.updated"
"digital_wallet.tokenization_approval_request"
"digital_wallet.tokenization_result"
"digital_wallet.tokenization_two_factor_authentication_code"
"digital_wallet.tokenization_two_factor_authentication_code_sent"
"digital_wallet.tokenization_updated"
"dispute.updated"
"dispute_evidence.upload_failed"
"external_bank_account.created"
"external_bank_account.updated"
"external_payment.created"
"external_payment.updated"
"financial_account.created"
"financial_account.updated"
"funding_event.created"
"loan_tape.created"
"loan_tape.updated"
"management_operation.created"
"management_operation.updated"
"payment_transaction.created"
"payment_transaction.updated"
"internal_transaction.created"
"internal_transaction.updated"
"settlement_report.updated"
"statements.created"
"three_ds_authentication.created"
"three_ds_authentication.updated"
"tokenization.approval_request"
"tokenization.result"
"tokenization.two_factor_authentication_code"
"tokenization.two_factor_authentication_code_sent"
"tokenization.updated"
Message Attempt
MessageAttemptobject

A subscription to specific event types.

ShowShow
tokenstring

Globally unique identifier.

createdstring

An RFC 3339 timestamp for when the event was created. UTC time zone.

If no timezone is specified, UTC will be used.

formatdate-time
event_subscription_tokenstring

Globally unique identifier.

event_tokenstring

Globally unique identifier.

responsestring

The response body from the event subscription's URL.

response_status_codenumber

The response status code from the event subscription's URL.

statusenum
Accepts one of the following: "FAILED", "PENDING", "SENDING", "SUCCESS"

The status of the event attempt.

Hide ParametersShow Parameters
"FAILED"
"PENDING"
"SENDING"
"SUCCESS"
urlstring
formaturi

EventsEvent Subscriptions

events.event_subscriptions
Methods
Resend event
post/v1/events/{event_token}/event_subscriptions/{event_subscription_token}/resend

Resend an event to an event subscription.

EventsSubscriptions

events.subscriptions
Methods
Create event subscription
post/v1/event_subscriptions

Create a new event subscription.

Get event subscription
get/v1/event_subscriptions/{event_subscription_token}

Get an event subscription.

Update event subscription
patch/v1/event_subscriptions/{event_subscription_token}

Update an event subscription.

List event subscriptions
get/v1/event_subscriptions

List all the event subscriptions.

Delete event subscription
delete/v1/event_subscriptions/{event_subscription_token}

Delete an event subscription.

List message attempts for an event subscription
get/v1/event_subscriptions/{event_subscription_token}/attempts

List all the message attempts for a given event subscription.

Resend failed messages
post/v1/event_subscriptions/{event_subscription_token}/recover

Resend all failed messages since a given time.

Replay missing messages
post/v1/event_subscriptions/{event_subscription_token}/replay_missing

Replays messages to the endpoint. Only messages that were created after begin will be sent. Messages that were previously sent to the endpoint are not resent. Message will be retried if endpoint responds with a non-2xx status code. See Retry Schedule for details.

Get event subscription secret
get/v1/event_subscriptions/{event_subscription_token}/secret

Get the secret for an event subscription.

Rotate event subscription secret
post/v1/event_subscriptions/{event_subscription_token}/secret/rotate

Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours.

Send event type example message
post/v1/simulate/event_subscriptions/{event_subscription_token}/send_example

Send an example message for event.