Lithic · Schema

event_type

The type of event that occurred. Possible values: - account_holder_document.updated: Occurs when an account holder's document upload status has been updated - account_holder.created: Occurs when a new account_holder is created. - account_holder.updated: Occurs when an account_holder is updated. - account_holder.verification: Occurs when an asynchronous account_holder's verification is completed. - auth_rules.backtest_report.created: Auth Rules backtest report created. - balance.updated: Financial Account Balance Update - book_transfer_transaction.created: Occurs when a book transfer transaction is created. - book_transfer_transaction.updated: Occurs when a book transfer transaction is updated. - card_authorization.challenge_response: Occurs when a cardholder responds to an SMS challenge during card authorization. - card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event. - card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event. - card_transaction.updated: Occurs when a card transaction happens. - card.converted: Occurs when a card is converted from virtual to physical cards. - card.created: Occurs when a new card is created. - card.reissued: Occurs when a card is reissued. - card.renewed: Occurs when a card is renewed. - card.shipped: Occurs when a card is shipped. - card.updated: Occurs when a card is updated. - digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed. This event will be deprecated in the future. We recommend using `tokenization.result` instead. - digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery. This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead. - digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery. This event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead. - digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed. This event will be deprecated in the future. We recommend using `tokenization.updated` instead. - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails. - dispute_transaction.created: Occurs when a new dispute transaction is created - dispute_transaction.updated: Occurs when a dispute transaction is updated - dispute.updated: Occurs when a dispute is updated. - external_bank_account.created: Occurs when an external bank account is created. - external_bank_account.updated: Occurs when an external bank account is updated. - external_payment.created: Occurs when an external payment is created. - external_payment.updated: Occurs when an external payment is updated. - financial_account.created: Occurs when a financial account is created. - financial_account.updated: Occurs when a financial account is updated. - funding_event.created: Occurs when a funding event is created. - internal_transaction.created: Occurs when an internal adjustment is created. - internal_transaction.updated: Occurs when an internal adjustment is updated. - loan_tape.created: Occurs when a loan tape is created. - loan_tape.updated: Occurs when a loan tape is updated. - management_operation.created: Occurs when an management operation is created. - management_operation.updated: Occurs when an management operation is updated. - network_total.created: Occurs when a network total is created. - network_total.updated: Occurs when a network total is updated. - payment_transaction.created: Occurs when a payment transaction is created. - payment_transaction.updated: Occurs when a payment transaction is updated. - settlement_report.updated: Occurs when a settlement report is created or updated. - statements.created: Occurs when a statement has been created - three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge. - three_ds_authentication.created: Occurs when a 3DS authentication is created. - three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed). - tokenization.approval_request: Occurs when a tokenization approval request is made. - tokenization.result: Occurs when a tokenization request succeeded or failed. - tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery. - tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery. - tokenization.updated: Occurs when a tokenization's status has changed.

FinTechBaaSCard IssuingPaymentsEmbedded Finance
View JSON Schema on GitHub

JSON Schema

lithic-event-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/event_type",
  "title": "event_type",
  "type": "string",
  "enum": [
    "account_holder_document.updated",
    "account_holder.created",
    "account_holder.updated",
    "account_holder.verification",
    "auth_rules.backtest_report.created",
    "balance.updated",
    "book_transfer_transaction.created",
    "book_transfer_transaction.updated",
    "card_authorization.challenge_response",
    "card_transaction.enhanced_data.created",
    "card_transaction.enhanced_data.updated",
    "card_transaction.updated",
    "card.converted",
    "card.created",
    "card.reissued",
    "card.renewed",
    "card.shipped",
    "card.updated",
    "digital_wallet.tokenization_result",
    "digital_wallet.tokenization_two_factor_authentication_code",
    "digital_wallet.tokenization_two_factor_authentication_code_sent",
    "digital_wallet.tokenization_updated",
    "dispute_evidence.upload_failed",
    "dispute_transaction.created",
    "dispute_transaction.updated",
    "dispute.updated",
    "external_bank_account.created",
    "external_bank_account.updated",
    "external_payment.created",
    "external_payment.updated",
    "financial_account.created",
    "financial_account.updated",
    "funding_event.created",
    "internal_transaction.created",
    "internal_transaction.updated",
    "loan_tape.created",
    "loan_tape.updated",
    "management_operation.created",
    "management_operation.updated",
    "network_total.created",
    "network_total.updated",
    "payment_transaction.created",
    "payment_transaction.updated",
    "settlement_report.updated",
    "statements.created",
    "three_ds_authentication.challenge",
    "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"
  ],
  "description": "The type of event that occurred. Possible values:\n\n- account_holder_document.updated: Occurs when an account holder's document upload status has been updated\n- account_holder.created: Occurs when a new account_holder is created.\n- account_holder.updated: Occurs when an account_holder is updated.\n- account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.\n- auth_rules.backtest_report.created: Auth Rules backtest report created.\n- balance.updated: Financial Account Balance Update\n- book_transfer_transaction.created: Occurs when a book transfer transaction is created.\n- book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.\n- card_authorization.challenge_response: Occurs when a cardholder responds to an SMS challenge during card authorization.\n- card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.\n- card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.\n- card_transaction.updated: Occurs when a card transaction happens.\n- card.converted: Occurs when a card is converted from virtual to physical cards.\n- card.created: Occurs when a new card is created.\n- card.reissued: Occurs when a card is reissued.\n- card.renewed: Occurs when a card is renewed.\n- card.shipped: Occurs when a card is shipped.\n- card.updated: Occurs when a card is updated.\n- digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed.\n\nThis event will be deprecated in the future. We recommend using `tokenization.result` instead.\n- digital_wallet.tokenization_two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.\n\nThis event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code` instead.\n- digital_wallet.tokenization_two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.\n\nThis event will be deprecated in the future. We recommend using `tokenization.two_factor_authentication_code_sent` instead.\n- digital_wallet.tokenization_updated: Occurs when a tokenization's status has changed.\n\nThis event will be deprecated in the future. We recommend using `tokenization.updated` instead.\n- dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.\n- dispute_transaction.created: Occurs when a new dispute transaction is created\n- dispute_transaction.updated: Occurs when a dispute transaction is updated\n- dispute.updated: Occurs when a dispute is updated.\n- external_bank_account.created: Occurs when an external bank account is created.\n- external_bank_account.updated: Occurs when an external bank account is updated.\n- external_payment.created: Occurs when an external payment is created.\n- external_payment.updated: Occurs when an external payment is updated.\n- financial_account.created: Occurs when a financial account is created.\n- financial_account.updated: Occurs when a financial account is updated.\n- funding_event.created: Occurs when a funding event is created.\n- internal_transaction.created: Occurs when an internal adjustment is created.\n- internal_transaction.updated: Occurs when an internal adjustment is updated.\n- loan_tape.created: Occurs when a loan tape is created.\n- loan_tape.updated: Occurs when a loan tape is updated.\n- management_operation.created: Occurs when an management operation is created.\n- management_operation.updated: Occurs when an management operation is updated.\n- network_total.created: Occurs when a network total is created.\n- network_total.updated: Occurs when a network total is updated.\n- payment_transaction.created: Occurs when a payment transaction is created.\n- payment_transaction.updated: Occurs when a payment transaction is updated.\n- settlement_report.updated: Occurs when a settlement report is created or updated.\n- statements.created: Occurs when a statement has been created\n- three_ds_authentication.challenge: The `three_ds_authentication.challenge` event. Upon receiving this request, the Card Program should issue its own challenge to the cardholder. After a cardholder challenge is successfully completed, the Card Program needs to respond back to Lithic by call to [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response). Then the cardholder must navigate back to the merchant checkout flow to complete the transaction. Some merchants will include an `app_requestor_url` for app-based purchases; Lithic recommends triggering a redirect to that URL after the cardholder completes an app-based challenge.\n- three_ds_authentication.created: Occurs when a 3DS authentication is created.\n- three_ds_authentication.updated: Occurs when a 3DS authentication is updated (eg. challenge is completed).\n- tokenization.approval_request: Occurs when a tokenization approval request is made.\n- tokenization.result: Occurs when a tokenization request succeeded or failed.\n- tokenization.two_factor_authentication_code: Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery.\n- tokenization.two_factor_authentication_code_sent: Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery.\n- tokenization.updated: Occurs when a tokenization's status has changed.\n"
}