# Lithic Developer Documentation Documentation ## Guides - [3DS Authentication Rules](https://docs.lithic.com/docs/3ds-authentication-rules.md): Learn how to customize 3DS decisioning logic using Lithic 3DS Auth Rules - [Customer Orchestration - 3DS Challenges](https://docs.lithic.com/docs/3ds-challenge-flow.md): Learn about how you can expand your 3DS authentication flow to include challenges - [Lithic Orchestration - 3DS Challenges](https://docs.lithic.com/docs/challenge-flow-lithic-decisioning.md): Learn about how you can expand your 3DS authentication flow to include challenges orchestrated by Lithic. - [3DS Challenge Flows](https://docs.lithic.com/docs/3ds-challenges.md): Configure challenge flow orchestration to verify cardholder identity for high-risk transactions. - [3DS Customer Decisioning](https://docs.lithic.com/docs/3ds-customer-decisioning.md) - [3DS Lithic Decisioning](https://docs.lithic.com/docs/3ds-decisioning.md): Learn about leveraging Lithic's 3DS decisioning model to participate in 3DS. - [3DS Decisioning Models](https://docs.lithic.com/docs/3ds-decisioning-models.md): Choose the 3DS decisioning model that is right for your program - [About 3DS](https://docs.lithic.com/docs/about-3ds.md): Learn about how 3DS works and how it is relevant to your card program. - [Account Holders (Businesses/KYB)](https://docs.lithic.com/docs/account-holders-kyb.md): Learn how to create an account holder object for businesses. - [Account Holders (Individuals)](https://docs.lithic.com/docs/account-holders-kyc.md): Learn how to create an account holder object for individual end-users. - [Card Accounts](https://docs.lithic.com/docs/accounts.md): Learn how to configure accounts in your card program to manage spend. - [Editing Account Holder Details](https://docs.lithic.com/docs/editing-account-holder-details.md) - [KYC/KYB Status](https://docs.lithic.com/docs/kyckyb-status.md): Learn how to check the status of a KYC or KYB evaluation. - [ACH Auth Rules](https://docs.lithic.com/docs/ach-auth-rules.md): Set configurable rules to control how you receive ACH Payments using ACH Auth Rules endpoints. - [ACH at Lithic](https://docs.lithic.com/docs/ach-overview.md): How Lithic offers ACH to our clients - [ACH Payments Lifecycle](https://docs.lithic.com/docs/ach-payments-lifecycle.md): Learn about the ACH payment event lifecycle permutations you can expect to see on the Lithic platform. - [External Bank Accounts](https://docs.lithic.com/docs/external-accounts-api.md): Add and verify external bank accounts to process ACH - [Intro to ACH](https://docs.lithic.com/docs/intro-to-ach.md): ACH 101 - [ACH Payment API](https://docs.lithic.com/docs/payments-api.md): Originate ACH transactions to External Bank Accounts - [Quick Start - ACH Funding in Sandbox](https://docs.lithic.com/docs/quick-start-ach-funding-in-sandbox.md): How to fund your Lithic instance in sandbox - [Quick Start - ACH Originations](https://docs.lithic.com/docs/quick-start-ach-originations.md) - [About Authorization Intelligence](https://docs.lithic.com/docs/about-authorization-intelligence.md): An overview of Lithic's Authorization Intelligence framework for programmable, context-aware decisioning across every stage of the payment lifecycle. - [Auth Stream Access (ASA)](https://docs.lithic.com/docs/auth-stream-access-asa.md): Learn about providing your own authorization rules by registering an endpoint. - [Partial Approval](https://docs.lithic.com/docs/partial-approval.md): Learn how partial approval works for authorization from balance and ASA responders - [Analytics and Observability](https://docs.lithic.com/docs/analytics-and-observability.md): Test rules in shadow mode, measure their impact with performance reports and backtesting, and interpret decline results. - [Authorization Rule Lifecycle](https://docs.lithic.com/docs/auth-rule-lifecycle.md): Draft, test in shadow mode, promote, disable, and delete Authorization Rules, plus list, fetch, and version history. - [Conditional Action Rules](https://docs.lithic.com/docs/conditional-action-rules.md): Take action on transactions that match a set of attribute conditions, the most common Authorization Rule type. - [Hold Adjustment Rules](https://docs.lithic.com/docs/hold-adjustment-rules.md): Adjust the authorization hold on transactions that match a set of conditions, reserving enough balance to cover expected clearing overages like tips and fuel. - [Authorization Rules](https://docs.lithic.com/docs/authorization-rules-v2.md): Learn how to create, update and apply customizable Lithic-hosted authorization decisioning to card transactions, 3DS authentication, tokenization, and ACH payments. - [Velocity Limit Rules](https://docs.lithic.com/docs/velocity-limit-rules.md): Restrict the number or value of transactions allowed within a time period to control spend and manage fraud risk. - [Authorization Challenges](https://docs.lithic.com/docs/authorization-challenges.md): Learn how to escalate risky authorizations to step-up authentication - [Backtesting Authorization Rules](https://docs.lithic.com/docs/backtesting-authorization-rules.md): Simulate rule impacts on historical transactions to optimize performance and refine configurations - [Contextual Rule Features](https://docs.lithic.com/docs/contextual-rule-features.md): Enrich authorization rules with card and account behavioral history to detect anomalies, flag first-time activity, and tailor fraud logic per cardholder. - [Custom Code Rules](https://docs.lithic.com/docs/custom-code-rules.md): Write TypeScript authorization logic that compiles to WebAssembly and runs in Lithic's Rules Engine with deterministic execution for backtesting. - [Fraud Command](https://docs.lithic.com/docs/fraud-command.md): A complete suite of configurable fraud controls: real-time authorization challenges, tokenization rules, backtesting, custom code rules, and contextual risk signals. - [Tokenization Rules](https://docs.lithic.com/docs/tokenization-auth-rules.md): Control how digital wallet tokenization requests are decisioned using Lithic-hosted rules. - [Spend Limits](https://docs.lithic.com/docs/spend-limits.md) - [Transaction Monitoring](https://docs.lithic.com/docs/transaction-monitoring.md): Detect, investigate, and resolve suspicious card activity directly inside Lithic. Configure rules that tag transactions or open cases, then work those cases to resolution from the API or the Lithic Dashboard. - [Case Management](https://docs.lithic.com/docs/transaction-monitoring-cases.md): Investigate and resolve cases opened by monitoring rules. Cases aggregate flagged transactions, cards, accounts, comments, files, and a full audit trail through a defined lifecycle. - [Transaction Monitoring Rules](https://docs.lithic.com/docs/transaction-monitoring-rules.md): Author tagging and case creation rules that evaluate transactions after authorization. Tag transactions with risk context or open investigation cases when activity warrants human review. - [Enhanced Commercial Data (L2/L3)](https://docs.lithic.com/docs/enhanced-commercial-data.md) - [Expiring authorizations](https://docs.lithic.com/docs/expiring-authorizations.md): How Lithic automatically expires authorization holds, and how to manually expire one early. - [Transaction Flow](https://docs.lithic.com/docs/transaction-flow.md): Learn about the most common transaction sequences you can expect to see on the Lithic platform. - [Transaction Object](https://docs.lithic.com/docs/transactions.md): Learn more about how the Lithic platform uses transactions to inform you about activity taking place on your cards. - [Bulk Shipping Physical Cards](https://docs.lithic.com/docs/bulk-shipping-physical-cards.md): Learn how to group cards together to be bulk shipped to a single location. - [Cards](https://docs.lithic.com/docs/cards.md): Learn how to create, update cards. - [Managing Cards](https://docs.lithic.com/docs/managing-cards.md): Learn how to renew, replace, and reissue cards or update a virtual card to a physical card. - [Managing Offline PIN Cards](https://docs.lithic.com/docs/offline-pin-cards.md): This article describes card management specific to offline PIN cards. - [Managing Online PIN Cards](https://docs.lithic.com/docs/pin-management.md): This article describes card management specific to online PIN cards. - [Embedded Card UI - React Frontend](https://docs.lithic.com/docs/embedded-card-ui-react.md): A minimal example for clients using React front end - [Embedded Card UI](https://docs.lithic.com/docs/embedded-card-ui.md): Learn how to embed card PANs and CVV codes. - [View Card PANs & CVVs - Quick Start Guide](https://docs.lithic.com/docs/quick-start-card-ui.md) - [Physical Cards Setup](https://docs.lithic.com/docs/physical-cards-setup-guide.md): Learn how to set up a physical card program. - [Charge Card](https://docs.lithic.com/docs/commercial-charge-card-overview.md): The flexibility of credit-based spend with the discipline of periodic full payment - [Quick Start - Commercial Charge Card](https://docs.lithic.com/docs/quick-start-commercial-charge-card.md) - [Quick Start - Secured Charge Card](https://docs.lithic.com/docs/quick-start-secured-charge-card.md) - [Revolving Credit Cards](https://docs.lithic.com/docs/commercial-revolving-credit-cards.md): Provide lines of credit to your business customers - [Quick Start - Commercial Revolving Credit](https://docs.lithic.com/docs/quick-start-commercial-revolving-credit.md) - [Quick Start - Consumer Revolving Credit](https://docs.lithic.com/docs/quick-start-consumer-revolving-credit.md) - [Credit Configurations](https://docs.lithic.com/docs/credit-products.md): Configure Your Revolving or Charge Card Program - [Credit Statements](https://docs.lithic.com/docs/credit-statements.md): Learn how to retrieve data to generate statements for your credit programs - [API Basics](https://docs.lithic.com/docs/api-basics.md): Learn our API's fundamentals, including authentication, request structure, error handling, and core functionalities like card issuance and transaction management. - [Environments](https://docs.lithic.com/docs/enviornments.md): Lithic API Enviorments - [Idempotent Requests](https://docs.lithic.com/docs/idempotent-requests.md): Learn how to make idempotent POST requests - [Rate Limits](https://docs.lithic.com/docs/rate-limits.md): Learn about API rate limits. - [Chargebacks](https://docs.lithic.com/docs/disputes-api.md): Learn how to use Lithic's Chargebacks offering to simplify your dispute process. - [Accounting & Ledger Impact](https://docs.lithic.com/docs/accounting-ledger-impact.md): Learn how to track dispute-related funds flows based on your program type. - [Cardholder Communications](https://docs.lithic.com/docs/cardholder-communications.md): Learn how to manage communications to your customers. - [Dispute Lifecycle](https://docs.lithic.com/docs/dispute-lifecycle.md): Learn how disputes progress from initial filing to resolution. - [Managed Disputes](https://docs.lithic.com/docs/managed-disputes.md) - [Liability and Money Movement](https://docs.lithic.com/docs/liability-and-money-movement.md): Understand how liability moves and when money changes hands throughout the dispute lifecycle. - [Managed Disputes Overview](https://docs.lithic.com/docs/managed-disputes-overview.md): Understand what disputes are, why they matter, and how Lithic's managed disputes solution can serve you. - [Modifying Dispute Configurations](https://docs.lithic.com/docs/modifying-dispute-configurations.md): Understand how to change your dispute configurations. - [Overview](https://docs.lithic.com/docs/overview-1.md): Understand what disputes are, why they matter, and how Lithic's managed disputes solution can serve you. - [Regulatory Requirements](https://docs.lithic.com/docs/regulatory-requirements.md): Determine which regulations apply to your program and how they impact your dispute process. - [Tracking Disputes](https://docs.lithic.com/docs/tracking-disputes.md): Track dispute progress through the dashboard, API, and webhooks to provide timely cardholder updates and maintain accurate records. - [The Dispute Object](https://docs.lithic.com/docs/understanding-the-api.md): Explore the dispute object returned by our API and webhooks. - [Filing Disputes](https://docs.lithic.com/docs/working-with-disputes.md): Learn how to file disputes in Lithic's dashboard. - [Financial Transactions](https://docs.lithic.com/docs/financial-transactions.md): Learn more about financial transactions - [Funding Events](https://docs.lithic.com/docs/funding-events-1.md): Learn how Lithic collects from your program for customer spend - [Generate an API Key](https://docs.lithic.com/docs/get-api-key.md) - [MCP Server](https://docs.lithic.com/docs/mcp.md): Connect AI code editors to the Lithic API. Search docs, explore endpoints, and execute requests without leaving your editor. - [Postman](https://docs.lithic.com/docs/postman.md) - [1. Create a Card](https://docs.lithic.com/docs/create-card.md) - [2. Authorize a Transaction](https://docs.lithic.com/docs/simulate-auth.md) - [4. Simulate Clearing](https://docs.lithic.com/docs/simulate-clearing.md) - [Balances](https://docs.lithic.com/docs/balances.md): Learn how Lithic tracks balances in different kinds of accounts - [Financial Account Status Lifecycle](https://docs.lithic.com/docs/financial-account-status-lifecycle.md): Learn how to manage your Financial Accounts throughout the lifecycle of your customers - [Financial Account Closures [BETA]](https://docs.lithic.com/docs/financial-account-closures-beta.md) - [Financial Accounts](https://docs.lithic.com/docs/financial-accounts.md): Learn how Lithic's Financial Accounts are created, and what they store - [Ledger Overview](https://docs.lithic.com/docs/ledger-overview.md): Use Lithic's native Financial Accounts to track balances - [Ledger Principles](https://docs.lithic.com/docs/ledger-principles.md): Lithic enforces the following principles to ensure accuracy and scalability in how you track funds. - [Ledger Use Cases and Funds Flows](https://docs.lithic.com/docs/ledger-use-cases.md): Combine Financial Accounts and Payments to move money at scale - [Legal Templates](https://docs.lithic.com/docs/legal-templates.md) - [Marketing Guidelines](https://docs.lithic.com/docs/marketing-guidelines.md) - [Dashboard Overview](https://docs.lithic.com/docs/managing-your-program-with-lithic-dashboard.md) - [Lithic Reporting Suite](https://docs.lithic.com/docs/bank-reporting.md) - [Quarterly Network Reporting](https://docs.lithic.com/docs/quarterly-network-reporting.md) - [Reporting Overview](https://docs.lithic.com/docs/reporting-overview.md) - [Settlement API](https://docs.lithic.com/docs/settlement-reporting.md): Learn about Lithic's settlement reporting suite - [Digital Banking](https://docs.lithic.com/docs/digital-banking.md): Build modern digital banking experiences with checking accounts, debit cards, and real-time balance management powered by Lithic's ledger infrastructure. - [Disbursements](https://docs.lithic.com/docs/disbursements.md): Disburse funds instantly to individuals and businesses using virtual and physical cards, ACH, or instant book transfers. - [Expense Management](https://docs.lithic.com/docs/expense-management.md): Build corporate expense management solutions with employee cards, spend controls, real-time visibility, and automated expense tracking. - [Revolving Credit](https://docs.lithic.com/docs/revolving-credit.md): Launch credit card programs with flexible interest rates, billing cycles, and payment terms using Lithic's credit infrastructure. - [Simulating Card Transactions](https://docs.lithic.com/docs/simulating-transactions.md): Simulate card transactions in Sandbox. - [2FA for Tokenization](https://docs.lithic.com/docs/2fa-for-tokenization.md) - [About Digital Wallets](https://docs.lithic.com/docs/about-digital-wallets.md): Learn about how digital wallets and tokenized cards work, and how they might be a fit for your card program. - [About Merchant Tokenization](https://docs.lithic.com/docs/about-merchant-tokens.md) - [In-App Push Provisioning](https://docs.lithic.com/docs/push-provisioning.md): Learn how to add cards to digital wallets with in-app push provisioning. - [Tokenization Management](https://docs.lithic.com/docs/token-management.md) - [Tokenization Decisioning](https://docs.lithic.com/docs/tokenization-control.md): Learn how to decision tokenizations with Lithic. - [Web Push Provisioning](https://docs.lithic.com/docs/web-push-provisioning.md): Allow users to push provision their card from a website to the mobile wallet. - [Book Transfers](https://docs.lithic.com/docs/book-transfers.md): Learn how to move funds between your financial accounts for various purposes - [Events API and Webhooks](https://docs.lithic.com/docs/events-api.md): Learn how to receive and query events. - [Migrate from Legacy Transaction Webhooks to our Events API](https://docs.lithic.com/docs/migrate-from-legacy-transaction-webhooks-to-our-events-api.md) - [Types of Events](https://docs.lithic.com/docs/types-of-events.md) - [Processing vs. Program Managed](https://docs.lithic.com/docs/po-vs-pm.md) - [Sign Up](https://docs.lithic.com/docs/sign-up.md): Sign up for the Lithic Dashboard - [Lithic Developer Documentation ](https://docs.lithic.com/docs/welcome.md) - [Wires Overview](https://docs.lithic.com/docs/wires-overview.md) ## API Reference - [Get 3DS authentication](https://docs.lithic.com/reference/getthreedsauthenticationbytoken.md): Get 3DS Authentication by token - [Retrieve the 3DS Decisioning HMAC secret key](https://docs.lithic.com/reference/getthreedsdecisioningsecret.md): Retrieve the 3DS Decisioning HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify 3DS Decisioning requests) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/3ds-decisioning#3ds-decisioning-hmac-secrets) for more detail about verifying 3DS Decisioning requests. - [3DS Decisioning Request](https://docs.lithic.com/reference/post_three-ds-authentication-approval-request.md): Webhook for Card Programs to decision on 3DS Authentication Request. See https://docs.lithic.com/docs/3ds-decisioning for more details. - [Respond to a Challenge Request](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response.md): Card program's response to a 3DS Challenge Request. Challenge Request is emitted as a webhook [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge) and your Card Program needs to be configured with Out of Band (OOB) Challenges in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for more information). - [Simulate entering OTP into 3DS Challenge UI](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-simulate-enter-otp.md): Endpoint for simulating entering OTP into 3DS Challenge UI. A call to [/v1/three_ds_authentication/simulate](https://docs.lithic.com/reference/postsimulateauthentication) that resulted in triggered SMS-OTP challenge must precede. Only a single attempt is supported; upon entering OTP, the challenge is either approved or declined. - [Simulate 3DS authentication](https://docs.lithic.com/reference/postsimulateauthentication.md): Simulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating authentications requires your customer decisioning endpoint to be set up properly (respond with a valid JSON). If the authentication decision is to challenge, ensure that the account holder associated with the card transaction has a valid phone number configured to receive the OTP code via SMS. - [Rotate the 3DS Decisioning HMAC secret key](https://docs.lithic.com/reference/rotatethreedsdecisioningsecret.md): Generate a new 3DS Decisioning HMAC secret key. The old secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /three_ds_decisioning/secret`](https://docs.lithic.com/reference/getthreedsdecisioningsecret) request to retrieve the new secret key. - [Deactivate a beneficial owner individual](https://docs.lithic.com/reference/deleteaccountholderentity.md): Deactivate a beneficial owner individual on an existing KYB account holder. Only beneficial owner individuals can be deactivated. - [Get an individual or business account holder](https://docs.lithic.com/reference/getaccountholder.md): Get an Individual or Business Account Holder and/or their KYC or KYB evaluation status. - [Get account holder document upload status](https://docs.lithic.com/reference/getaccountholderdocumentbytoken.md): Check the status of an account holder document upload, or retrieve the upload URLs to process your image uploads. Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass). In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload. When a new account holder document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` array in a `PENDING` state for the corresponding `image_type`. - [Get account holder document uploads](https://docs.lithic.com/reference/getaccountholderdocuments.md): Retrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads. Note that this is not equivalent to checking the status of the KYC evaluation overall (a document may be successfully uploaded but not be sufficient for KYC to pass). In the event your upload URLs have expired, calling this endpoint will refresh them. Similarly, in the event a previous account holder document upload has failed, you can use this endpoint to get a new upload URL for the failed image upload. When a new document upload is generated for a failed attempt, the response will show an additional entry in the `required_document_uploads` list in a `PENDING` state for the corresponding `image_type`. - [Get a list of individual or business account holders](https://docs.lithic.com/reference/getaccountholders.md): Get a list of individual or business account holders and their KYC or KYB evaluation status. - [Update account holder information and possibly resubmit for evaluation](https://docs.lithic.com/reference/patchaccountholder.md): Update the information associated with a particular account holder (including business owners and control persons associated to a business account). If Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required). All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on existing accounts that are part of the program that the calling API key manages. - [Initiate account holder document upload](https://docs.lithic.com/reference/postaccountholderdocuments.md): Use this endpoint to identify which type of supported government-issued documentation you will upload for further verification. It will return two URLs to upload your document images to - one for the front image and one for the back image. This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state. Supported file types include `jpg`, `png`, and `pdf`. Each file must be less than 15 MiB. Once both required uploads have been successfully completed, your document will be run through KYC verification. If you have registered a webhook, you will receive evaluation updates for any document submission evaluations, as well as for any failed document uploads. Two document submission attempts are permitted via this endpoint before a `REJECTED` status is returned and the account creation process is ended. Currently only one type of account holder document is supported per KYC verification. - [Create a new beneficial owner individual or replace the existing control person entity](https://docs.lithic.com/reference/postaccountholderentities.md): Create a new beneficial owner individual or replace the control person entity on an existing KYB account holder. This endpoint is only applicable for account holders enrolled through a KYB workflow with the Persona KYB provider. A new control person can only replace the existing one. A maximum of 4 beneficial owners can be associated with an account holder. - [Create an individual or business account holder](https://docs.lithic.com/reference/postaccountholders.md): Create an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is successfully created an associated account is also created. All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on accounts that are part of the program that the calling API key manages. - [Simulate an account holder document upload's review](https://docs.lithic.com/reference/simulateaccountholderenrollmentdocumentreview.md): Simulates a review for an account holder document upload. - [Simulate an account holder's enrollment review](https://docs.lithic.com/reference/simulateaccountholderenrollmentreview.md): Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as `KYB_BASIC`. - [Get account](https://docs.lithic.com/reference/getaccountbytoken.md): Get account configuration such as spend limits. - [List accounts](https://docs.lithic.com/reference/getaccounts.md): List account configurations. - [Fetch account signals](https://docs.lithic.com/reference/getaccountsignals.md): Returns behavioral feature state derived from an account's transaction history. These signals expose the same data used by behavioral rule attributes (e.g. `AMOUNT_Z_SCORE` with `scope: ACCOUNT`, `IS_NEW_COUNTRY` with `scope: ACCOUNT`) and custom code `TRANSACTION_HISTORY_SIGNALS` features, allowing clients to inspect feature values before writing rules and debug rule behavior. Note: 3DS fields are not available at the account scope and will be null. - [Get account's available spend limits](https://docs.lithic.com/reference/getaccountspendlimits.md): Get an Account's available spend limits, which is based on the spend limit configured on the Account and the amount already spent over the spend limit's duration. For example, if the Account has a daily spend limit of $1000 configured, and has spent $600 in the last 24 hours, the available spend limit returned would be $400. - [Update account](https://docs.lithic.com/reference/patchaccountbytoken.md): Update account configuration such as state or spend limits. Can only be run on accounts that are part of the program managed by this API key. Accounts that are in the `PAUSED` state will not be able to transact or create new cards. - [Delete a rule](https://docs.lithic.com/reference/delete_v2-auth-rules-auth-rule-token.md): Deletes a V2 Auth rule - [Retrieve backtest results](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token-backtests-auth-rule-backtest-token.md): Returns the backtest results of an Auth rule (if available). Backtesting is an asynchronous process that requires time to complete. If a customer retrieves the backtest results using this endpoint before the report is fully generated, the response will return null for `results.current_version` and `results.draft_version`. Customers are advised to wait for the backtest creation process to complete (as indicated by the webhook event auth_rules.backtest_report.created) before retrieving results from this endpoint. Backtesting is an asynchronous process, while the backtest is being processed, results will not be available which will cause `results.current_version` and `results.draft_version` objects to contain `null`. The entries in `results` will also always represent the configuration of the rule at the time requests are made to this endpoint. For example, the results for `current_version` in the served backtest report will be consistent with which version of the rule is currently activated in the respective event stream, regardless of which version of the rule was active in the event stream at the time a backtest is requested. - [List backtests](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token-backtests.md): Lists backtests for an Auth Rule - [Calculated Feature values](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token-features.md): Fetches the current calculated Feature values for the given Auth Rule This only calculates the features for the active version. - VelocityLimit Rules calculates the current Velocity Feature data. This requires a `card_token` or `account_token` matching what the rule is Scoped to. - ConditionalBlock Rules calculates the CARD_TRANSACTION_COUNT_* attributes on the rule. This requires a `card_token` - [Retrieve a performance report](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token-report.md): Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes. **Time Range Limitations:** - Reports are supported for the past 3 months only - Maximum interval length is 1 month - Report data is available only through the previous day in UTC (current day data is not available) The report provides daily statistics for both current and draft versions of the Auth rule, including approval, decline, and challenge counts along with sample events. - [List rule versions](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token-versions.md): Returns all versions of an auth rule, sorted by version number descending (newest first). - [Fetch a rule](https://docs.lithic.com/reference/get_v2-auth-rules-auth-rule-token.md): Fetches a V2 Auth rule by its token - [List rule evaluation results](https://docs.lithic.com/reference/get_v2-auth-rules-results.md): Lists Auth Rule evaluation results. **Limitations:** - Results are available for the past 3 months only - At least one filter (`event_token` or `auth_rule_token`) must be provided - When filtering by `event_token`, pagination is not supported - [List rules](https://docs.lithic.com/reference/get_v2-auth-rules.md): Lists V2 Auth rules - [Update a rule](https://docs.lithic.com/reference/patch_v2-auth-rules-auth-rule-token.md): Updates a V2 Auth rule's properties If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`, `excluded_account_tokens`, or `excluded_business_account_tokens` is provided, this will replace existing associations with the provided list of entities. - [Request a backtest](https://docs.lithic.com/reference/post_v2-auth-rules-auth-rule-token-backtests.md): Initiates a request to asynchronously generate a backtest for an Auth rule. During backtesting, both the active version (if one exists) and the draft version of the Auth Rule are evaluated by replaying historical transaction data against the rule's conditions. This process allows customers to simulate and understand the effects of proposed rule changes before deployment. The generated backtest report provides detailed results showing whether the draft version of the Auth Rule would have approved or declined historical transactions which were processed during the backtest period. These reports help evaluate how changes to rule configurations might affect overall transaction approval rates. The generated backtest report will be delivered asynchronously through a webhook with `event_type` = `auth_rules.backtest_report.created`. See the docs on setting up [webhook subscriptions](https://docs.lithic.com/docs/events-api). It is also possible to request backtest reports on-demand through the `/v2/auth_rules/{auth_rule_token}/backtests/{auth_rule_backtest_token}` endpoint. Lithic currently supports backtesting for `CONDITIONAL_BLOCK` / `CONDITIONAL_ACTION` rules. Backtesting for `VELOCITY_LIMIT` rules is generally not supported. In specific cases (i.e. where Lithic has pre-calculated the requested velocity metrics for historical transactions), a backtest may be feasible. However, such cases are uncommon and customers should not anticipate support for velocity backtests under most configurations. If a historical transaction does not feature the required inputs to evaluate the rule, then it will not be included in the final backtest report. - [Draft a new rule version](https://docs.lithic.com/reference/post_v2-auth-rules-auth-rule-token-draft.md): Creates a new draft version of a rule that will be ran in shadow mode. This can also be utilized to reset the draft parameters, causing a draft version to no longer be ran in shadow mode. - [Promote a rule version](https://docs.lithic.com/reference/post_v2-auth-rules-auth-rule-token-promote.md): Promotes the draft version of an Auth rule to the currently active version such that it is enforced in the respective stream. - [Create a new rule](https://docs.lithic.com/reference/post_v2-auth-rules.md): Creates a new V2 Auth rule in draft mode - [Retrieve the ASA HMAC secret key](https://docs.lithic.com/reference/getauthstreamsecret.md): Retrieve the ASA HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify webhooks) will begin appearing shortly after calling this endpoint for the first time. See [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification) for more detail about verifying ASA webhooks. - [Auth Stream Access Request](https://docs.lithic.com/reference/post_card-authorization-approval-request.md): Auth Stream Access Request - [Rotate the ASA HMAC secret key](https://docs.lithic.com/reference/rotateauthstreamsecret.md): Generate a new ASA HMAC secret key. The old ASA HMAC secret key will be deactivated 24 hours after a successful request to this endpoint. Make a [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret) request to retrieve the new secret key. - [Get balances](https://docs.lithic.com/reference/getbalance.md): Get the balances for a given financial account. - [List balances](https://docs.lithic.com/reference/getbalances.md): Get the balances for a program, business, or a given end-user account - [Get book transfer by token](https://docs.lithic.com/reference/getbooktransfer.md): Get book transfer by token - [List book transfers](https://docs.lithic.com/reference/getbooktransfers.md): List book transfers - [Create book transfer](https://docs.lithic.com/reference/postbooktransfers.md): Book transfer funds between two financial accounts or between a financial account and card - [Transfer funds within Lithic](https://docs.lithic.com/reference/posttransfer.md): Transfer funds between two financial accounts or between a financial account and card - [Retry book transfer](https://docs.lithic.com/reference/retrybooktransfer.md): Retry a book transfer that has been declined - [Reverse book transfer](https://docs.lithic.com/reference/reversebooktransfer.md): Reverse a book transfer - [Respond to Authorization Challenge](https://docs.lithic.com/reference/respondtoauthorizationchallenge.md): Card program's response to Authorization Challenge. Programs that have Authorization Challenges configured as Out of Band receive a [card_authorization.challenge](https://docs.lithic.com/reference/post_card-authorization-challenge) webhook when an authorization attempt triggers a challenge. The card program should respond using this endpoint after the cardholder completes the challenge. - [Get bulk order](https://docs.lithic.com/reference/getcardbulkorder.md): Retrieve a specific bulk order by token - [List bulk orders](https://docs.lithic.com/reference/getcardbulkorders.md): List bulk orders for physical card shipments - [Update bulk order](https://docs.lithic.com/reference/patchcardbulkorder.md): Update a bulk order. Primarily used to lock the order, preventing additional cards from being added - [Create bulk order](https://docs.lithic.com/reference/postcardbulkorder.md): Create a new bulk order for physical card shipments. Cards can be added to the order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work with your Customer Success Manager and card personalization bureau to ensure bulk shipping is supported for your program. - [Get card balances](https://docs.lithic.com/reference/getcardbalance.md): Get the balances for a given card. - [Get card](https://docs.lithic.com/reference/getcardbytoken.md): Get card configuration such as spend limit and state. - [Get card financial transaction](https://docs.lithic.com/reference/getcardfinancialtransactionbytoken.md): Get the card financial transaction for the provided token. - [List card financial transactions](https://docs.lithic.com/reference/getcardfinancialtransactions.md): List the financial transactions for a given card. - [Get card program](https://docs.lithic.com/reference/getcardprogram.md): Get card program. - [List card programs](https://docs.lithic.com/reference/getcardprograms.md): List card programs. - [List cards](https://docs.lithic.com/reference/getcards.md): List cards. - [Fetch card signals](https://docs.lithic.com/reference/getcardsignals.md): Returns behavioral feature state derived from a card's transaction history. These signals expose the same data used by behavioral rule attributes (e.g. `AMOUNT_Z_SCORE` with `scope: CARD`, `IS_NEW_COUNTRY` with `scope: CARD`) and custom code `TRANSACTION_HISTORY_SIGNALS` features, allowing clients to inspect feature values before writing rules and debug rule behavior. - [Get card's available spend limit](https://docs.lithic.com/reference/getcardspendlimits.md): Get a Card's available spend limit, which is based on the spend limit configured on the Card and the amount already spent over the spend limit's duration. For example, if the Card has a monthly spend limit of $1000 configured, and has spent $600 in the last month, the available spend limit returned would be $400. - [Embedded card UI](https://docs.lithic.com/reference/getembedcard.md): Handling full card PANs and CVV codes requires that you comply with the Payment Card Industry Data Security Standards (PCI DSS). Some clients choose to reduce their compliance obligations by leveraging our embedded card UI solution documented below. In this setup, PANs and CVV codes are presented to the end-user via a card UI that we provide, optionally styled in the customer's branding using a specified css stylesheet. A user's browser makes the request directly to api.lithic.com, so card PANs and CVVs never touch the API customer's servers while full card data is displayed to their end-users. The response contains an HTML document (see Embedded Card UI or Changelog for upcoming changes in January). This means that the url for the request can be inserted straight into the `src` attribute of an iframe. ```html ``` You should compute the request payload on the server side. You can render it (or the whole iframe) on the server or make an ajax call from your front end code, but **do not ever embed your API key into front end code, as doing so introduces a serious security vulnerability**. - [Update card](https://docs.lithic.com/reference/patchcardbytoken.md): Update the specified properties of the card. Unsupplied properties will remain unchanged. *Note: setting a card to a `CLOSED` state is a final action that cannot be undone.* - [Provision card (Digital Wallet)](https://docs.lithic.com/reference/postcardprovision.md): Allow your cardholders to directly add payment cards to the device's digital wallet (e.g. Apple Pay) with one touch from your app. This requires some additional setup and configuration. Please [Contact Us](https://lithic.com/contact) or your Customer Success representative for more information. - [Reissue physical card](https://docs.lithic.com/reference/postcardreissue.md): Initiate print and shipment of a duplicate physical card (e.g. card is physically damaged). The PAN, expiry, and CVC2 will remain the same and the original card can continue to be used until the new card is activated. Only applies to cards of type `PHYSICAL`. A card can be reissued or renewed a total of 8 times. - [Renew a card](https://docs.lithic.com/reference/postcardrenew.md): Applies to card types `PHYSICAL` and `VIRTUAL`. For `PHYSICAL`, creates a new card with the same card token and PAN, but updated expiry and CVC2 code. The original card will keep working for card-present transactions until the new card is activated. For card-not-present transactions, the original card details (expiry, CVC2) will also keep working until the new card is activated. A `PHYSICAL` card can be reissued or renewed a total of 8 times. For `VIRTUAL`, the card will retain the same card token and PAN and receive an updated expiry and CVC2 code. `product_id`, `shipping_method`, `shipping_address`, `carrier` are only relevant for renewing `PHYSICAL` cards. - [Create card](https://docs.lithic.com/reference/postcards.md): Create a new virtual or physical card. Parameters `shipping_address` and `product_id` only apply to physical cards. - [Web Push Provision card (Digital Wallet)](https://docs.lithic.com/reference/postcardwebprovision.md): Allow your cardholders to directly add payment cards to the device's digital wallet from a browser on the web. This requires some additional setup and configuration. Please [Contact Us](https://lithic.com/contact) or your Customer Success representative for more information. - [Convert virtual to physical card](https://docs.lithic.com/reference/postconvertphysical.md): Convert a virtual card into a physical card and manufacture it. Customer must supply relevant fields for physical card creation including `product_id`, `carrier`, `shipping_method`, and `shipping_address`. The card token will be unchanged. The card's type will be altered to `PHYSICAL`. The card will be set to state `PENDING_FULFILLMENT` and fulfilled at next fulfillment cycle. Virtual cards created on card programs which do not support physical cards cannot be converted. The card program cannot be changed as part of the conversion. Cards must be in an `OPEN` state to be converted. Only applies to cards of type `VIRTUAL` (or existing cards with deprecated types of `DIGITAL_WALLET` and `UNLOCKED`). - [Search for card by PAN](https://docs.lithic.com/reference/searchcardbypan.md): Get card configuration such as spend limit and state. Customers must be PCI compliant to use this endpoint. Please contact [support.lithic.com](https://support.lithic.com/) for questions. *Note: this is a `POST` endpoint because it is more secure to send sensitive data in a request body than in a URL.* - [Withdraw chargeback request](https://docs.lithic.com/reference/deletedisputebytoken.md): Withdraw chargeback request. - [Delete evidence](https://docs.lithic.com/reference/deletedisputeevidencebytoken.md): Soft delete evidence for a chargeback request. Evidence will not be reviewed or submitted by Lithic after it is withdrawn. - [Get chargeback request](https://docs.lithic.com/reference/getdisputebytoken.md): Get chargeback request. - [Get evidence](https://docs.lithic.com/reference/getdisputeevidencebytoken.md): Get evidence for a chargeback request. - [List evidence](https://docs.lithic.com/reference/getdisputeevidences.md): List evidence for a chargeback request. - [List chargeback requests](https://docs.lithic.com/reference/getdisputes.md): List chargeback requests. - [Request chargeback](https://docs.lithic.com/reference/postdisputes.md): Request a chargeback. - [Upload evidence](https://docs.lithic.com/reference/postevidencedocument.md): Use this endpoint to upload evidence for a chargeback request. It will return a URL to upload your documents to. The URL will expire in 30 minutes. Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be less than 5 GiB. - [Update chargeback request](https://docs.lithic.com/reference/updatedisputebytoken.md): Update chargeback request. Can only be modified if status is `NEW`. - [Post Credit Product Prime Rate](https://docs.lithic.com/reference/createprimerates.md) - [Get extended credit](https://docs.lithic.com/reference/getextendedcredit.md): Get the extended credit for a given credit product under a program - [Get Credit Product Prime Rates](https://docs.lithic.com/reference/getprimerates.md) - [account_holder.created](https://docs.lithic.com/reference/post_account-holder-created.md): Occurs when a new account_holder is created. - [account_holder_document.updated](https://docs.lithic.com/reference/post_account-holder-document-updated.md): Occurs when an account holder's document upload status has been updated - [account_holder.updated](https://docs.lithic.com/reference/post_account-holder-updated.md): Occurs when an account_holder is updated. - [account_holder.verification](https://docs.lithic.com/reference/post_account-holder-verification.md): Occurs when an asynchronous account_holder's verification is completed. - [auth_rules.backtest_report.created](https://docs.lithic.com/reference/post_auth-rules-backtest-report-created.md): Auth Rules backtest report created. - [balance.updated](https://docs.lithic.com/reference/post_balance-updated.md): Financial Account Balance Update - [book_transfer_transaction.created](https://docs.lithic.com/reference/post_book-transfer-transaction-created.md): Occurs when a book transfer transaction is created. - [book_transfer_transaction.updated](https://docs.lithic.com/reference/post_book-transfer-transaction-updated.md): Occurs when a book transfer transaction is updated. - [card_authorization.challenge_response](https://docs.lithic.com/reference/post_card-authorization-challenge-response.md): Occurs when a cardholder responds to a challenge during card authorization. - [card_authorization.challenge](https://docs.lithic.com/reference/post_card-authorization-challenge.md): Occurs when an Out of Band challenge is issued during card authorization. The card program should issue its own challenge to the cardholder and then respond via [/v1/card_authorizations/{event_token}/challenge_response](https://docs.lithic.com/reference/respondtoauthorizationchallenge). - [card.converted](https://docs.lithic.com/reference/post_card-converted.md): Occurs when a card is converted from virtual to physical cards. - [card.created](https://docs.lithic.com/reference/post_card-created.md): Occurs when a new card is created. - [card.reissued](https://docs.lithic.com/reference/post_card-reissued.md): Occurs when a card is reissued. - [card.renewed](https://docs.lithic.com/reference/post_card-renewed.md): Occurs when a card is renewed. - [card.shipped](https://docs.lithic.com/reference/post_card-shipped.md): Occurs when a card is shipped. - [card_transaction.enhanced_data.created](https://docs.lithic.com/reference/post_card-transaction-enhanced-data-created.md): Occurs when L2/L3 enhanced commercial data is processed for a transaction event. - [card_transaction.enhanced_data.updated](https://docs.lithic.com/reference/post_card-transaction-enhanced-data-updated.md): Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event. - [card_transaction.updated](https://docs.lithic.com/reference/post_card-transaction-updated.md): Occurs when a card transaction happens. - [card.updated](https://docs.lithic.com/reference/post_card-updated.md): Occurs when a card is updated. - [Tokenization Decisioning Request](https://docs.lithic.com/reference/post_digital-wallet-tokenization-approval-request.md): Tokenization Customer Decisioning Request. Use `tokenization.approval_request` for notification webhooks. - [digital_wallet.tokenization_result](https://docs.lithic.com/reference/post_digital-wallet-tokenization-result.md): 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_sent](https://docs.lithic.com/reference/post_digital-wallet-tokenization-two-factor-authentication-code-sent.md): 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_two_factor_authentication_code](https://docs.lithic.com/reference/post_digital-wallet-tokenization-two-factor-authentication-code.md): 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_updated](https://docs.lithic.com/reference/post_digital-wallet-tokenization-updated.md): 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](https://docs.lithic.com/reference/post_dispute-evidence-upload-failed.md): Occurs when a dispute evidence upload fails. - [dispute_transaction.created](https://docs.lithic.com/reference/post_dispute-transaction-created.md): Occurs when a new dispute transaction is created - [dispute_transaction.updated](https://docs.lithic.com/reference/post_dispute-transaction-updated.md): Occurs when a dispute transaction is updated - [dispute.updated](https://docs.lithic.com/reference/post_dispute-updated.md): Occurs when a dispute is updated. - [external_bank_account.created](https://docs.lithic.com/reference/post_external-bank-account-created.md): Occurs when an external bank account is created. - [external_bank_account.updated](https://docs.lithic.com/reference/post_external-bank-account-updated.md): Occurs when an external bank account is updated. - [external_payment.created](https://docs.lithic.com/reference/post_external-payment-created.md): Occurs when an external payment is created. - [external_payment.updated](https://docs.lithic.com/reference/post_external-payment-updated.md): Occurs when an external payment is updated. - [financial_account.created](https://docs.lithic.com/reference/post_financial-account-created.md): Occurs when a financial account is created. - [financial_account.updated](https://docs.lithic.com/reference/post_financial-account-updated.md): Occurs when a financial account is updated. - [funding_event.created](https://docs.lithic.com/reference/post_funding-event-created.md): Occurs when a funding event is created. - [internal_transaction.created](https://docs.lithic.com/reference/post_internal-transaction-created.md): Occurs when an internal adjustment is created. - [internal_transaction.updated](https://docs.lithic.com/reference/post_internal-transaction-updated.md): Occurs when an internal adjustment is updated. - [loan_tape.created](https://docs.lithic.com/reference/post_loan-tape-created.md): Occurs when a loan tape is created. - [loan_tape.updated](https://docs.lithic.com/reference/post_loan-tape-updated.md): Occurs when a loan tape is updated. - [management_operation.created](https://docs.lithic.com/reference/post_management-operation-created.md): Occurs when an management operation is created. - [management_operation.updated](https://docs.lithic.com/reference/post_management-operation-updated.md): Occurs when an management operation is updated. - [network_total.created](https://docs.lithic.com/reference/post_network-total-created.md): Occurs when a network total is created. - [network_total.updated](https://docs.lithic.com/reference/post_network-total-updated.md): Occurs when a network total is updated. - [payment_transaction.created](https://docs.lithic.com/reference/post_payment-transaction-created.md): Occurs when a payment transaction is created. - [payment_transaction.updated](https://docs.lithic.com/reference/post_payment-transaction-updated.md): Occurs when a payment transaction is updated. - [settlement_report.updated](https://docs.lithic.com/reference/post_settlement-report-updated.md): Occurs when a settlement report is created or updated. - [statements.created](https://docs.lithic.com/reference/post_statements-created.md): Occurs when a statement has been created - [three_ds_authentication.challenge](https://docs.lithic.com/reference/post_three-ds-authentication-challenge.md): 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](https://docs.lithic.com/reference/post_three-ds-authentication-created.md): Occurs when a 3DS authentication is created. - [three_ds_authentication.updated](https://docs.lithic.com/reference/post_three-ds-authentication-updated.md): Occurs when a 3DS authentication is updated (eg. challenge is completed). - [tokenization.approval_request](https://docs.lithic.com/reference/post_tokenization-approval-request.md): Occurs when a tokenization approval request is made. - [tokenization.result](https://docs.lithic.com/reference/post_tokenization-result.md): Occurs when a tokenization request succeeded or failed. - [tokenization.two_factor_authentication_code_sent](https://docs.lithic.com/reference/post_tokenization-two-factor-authentication-code-sent.md): Occurs when a tokenization request 2FA code is sent to our downstream messaging providers for delivery. - [tokenization.two_factor_authentication_code](https://docs.lithic.com/reference/post_tokenization-two-factor-authentication-code.md): Occurs when a tokenization request 2FA code is sent to the Lithic customer for self serve delivery. - [tokenization.updated](https://docs.lithic.com/reference/post_tokenization-updated.md): Occurs when a tokenization's status has changed. - [Create event subscription](https://docs.lithic.com/reference/createeventsubscription.md): Create a new event subscription. - [Delete event subscription](https://docs.lithic.com/reference/deleteeventsubscription.md): Delete an event subscription. - [Get event](https://docs.lithic.com/reference/getevent.md): Get an event. - [List events](https://docs.lithic.com/reference/getevents.md): List all events. - [Get event subscription](https://docs.lithic.com/reference/geteventsubscription.md): Get an event subscription. - [List event subscriptions](https://docs.lithic.com/reference/geteventsubscriptions.md): List all the event subscriptions. - [Get event subscription secret](https://docs.lithic.com/reference/geteventsubscriptionsecret.md): Get the secret for an event subscription. - [List message attempts for an event](https://docs.lithic.com/reference/getmessageattemptsforevent.md): List all the message attempts for a given event. - [List message attempts for an event subscription](https://docs.lithic.com/reference/getmessageattemptsforeventsubscription.md): List all the message attempts for a given event subscription. - [Resend failed messages](https://docs.lithic.com/reference/recovereventsubscription.md): Resend all failed messages since a given time. - [Replay missing messages](https://docs.lithic.com/reference/replaymissingeventsubscription.md): 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](https://docs.lithic.com/docs/events-api#retry-schedule) for details. - [Resend event](https://docs.lithic.com/reference/resendevent.md): Resend an event to an event subscription. - [Rotate event subscription secret](https://docs.lithic.com/reference/rotateeventsubscriptionsecret.md): Rotate the secret for an event subscription. The previous secret will be valid for the next 24 hours. - [Send event type example message](https://docs.lithic.com/reference/sendeventsubscriptionexample.md): Send an example message for event. - [Update event subscription](https://docs.lithic.com/reference/updateeventsubscription.md): Update an event subscription. - [Create external bank account](https://docs.lithic.com/reference/createexternalbankaccount.md): Creates an external bank account within a program or Lithic account. - [Get external bank account by token](https://docs.lithic.com/reference/getexternalbankaccountbytoken.md): Get the external bank account by token. - [Update external bank account](https://docs.lithic.com/reference/patchexternalbankaccountbytoken.md): Update the external bank account by token. - [Pause external bank account](https://docs.lithic.com/reference/pauseexternalbankaccount.md): Pause an external bank account - [Retry external bank account via micro deposit](https://docs.lithic.com/reference/retrymicrodeposit.md): Retry external bank account micro deposit verification. - [Retry external bank account via prenote](https://docs.lithic.com/reference/retryprenote.md): Retry external bank account prenote verification. - [List external bank accounts](https://docs.lithic.com/reference/searchexternalbankaccounts.md): List all the external bank accounts for the provided search criteria. - [Set verification method](https://docs.lithic.com/reference/setverificationmethod.md): Update the verification method for an external bank account. Verification method can only be updated if the `verification_state` is `PENDING`. - [Unpause external bank account](https://docs.lithic.com/reference/unpauseexternalbankaccount.md): Unpause an external bank account - [Verify external bank account via micro deposit amounts](https://docs.lithic.com/reference/verifyexternalbankaccountbymicrodeposits.md): Verify the external bank account by providing the micro deposit amounts. - [Cancel external payment](https://docs.lithic.com/reference/cancelexternalpayment.md): Cancel external payment - [Get external payment](https://docs.lithic.com/reference/getexternalpayment.md): Get external payment - [List external payments](https://docs.lithic.com/reference/getexternalpayments.md): List external payments - [Create external payment](https://docs.lithic.com/reference/postexternalpayments.md): Create external payment - [Release external payment](https://docs.lithic.com/reference/releaseexternalpayment.md): Release external payment - [Reverse external payment](https://docs.lithic.com/reference/reverseexternalpayment.md): Reverse external payment - [Settle external payment](https://docs.lithic.com/reference/settleexternalpayment.md): Settle external payment - [Create financial account](https://docs.lithic.com/reference/createfinancialaccount.md): Create a new financial account - [Get Single Transaction from Account Activity](https://docs.lithic.com/reference/getaccountactivity.md): Retrieve a single transaction - [Get account credit configuration](https://docs.lithic.com/reference/getaccountcreditconfiguration.md): Get an Account's credit configuration - [Get financial account](https://docs.lithic.com/reference/getfinancialaccountbytoken.md): Get a financial account - [List financial accounts](https://docs.lithic.com/reference/getfinancialaccounts.md): Retrieve information on your financial accounts including routing and account number. - [Get financial transaction](https://docs.lithic.com/reference/getfinancialtransactionbytoken.md): Get the financial transaction for the provided token. - [List financial transactions](https://docs.lithic.com/reference/getfinancialtransactions.md): List the financial transactions for a given financial account. - [List Account Activity](https://docs.lithic.com/reference/listaccountactivity.md): Retrieve a list of transactions across all public accounts. - [Update account credit configuration](https://docs.lithic.com/reference/patchaccountcreditconfiguration.md): Update an account's credit configuration - [Register Account Number](https://docs.lithic.com/reference/registeraccountnumber.md): Register account number - [Update financial account](https://docs.lithic.com/reference/updatefinancialaccountbytoken.md): Update a financial account - [Update financial account status](https://docs.lithic.com/reference/updatefinancialaccountstatus.md): Update financial account status - [Create or update a fraud report for a transaction](https://docs.lithic.com/reference/createupdatefraudreport.md): Report fraud for a specific transaction token by providing details such as fraud type, fraud status, and any additional comments. - [Get a fraud report for a transaction](https://docs.lithic.com/reference/getfraudreport.md): Retrieve a fraud report for a specific transaction identified by its unique transaction token. - [Get funding event by ID](https://docs.lithic.com/reference/getfundingeventbyid.md): Get funding event for program by id - [Get funding event details](https://docs.lithic.com/reference/getfundingeventdetailsbyid.md): Get funding event details by id - [List funding events](https://docs.lithic.com/reference/getfundingevents.md): Get all funding events for program - [Create hold](https://docs.lithic.com/reference/createhold.md): Create a hold on a financial account. Holds reserve funds by moving them from available to pending balance. They can be resolved via settlement (linked to a payment or book transfer), voiding, or expiration. - [List holds](https://docs.lithic.com/reference/getfinancialaccountholds.md): List holds for a financial account. - [Get hold](https://docs.lithic.com/reference/gethold.md): Get hold by token. - [Void hold](https://docs.lithic.com/reference/voidhold.md): Void an active hold. This returns the held funds from pending back to available balance. Only holds in PENDING status can be voided. - [Retrieve a dispute](https://docs.lithic.com/reference/getdisputebytokenv2.md): Retrieves a specific dispute by its token. - [List disputes](https://docs.lithic.com/reference/getdisputesv2.md): Returns a paginated list of disputes. - [Get management operation](https://docs.lithic.com/reference/getmanagementoperation.md): Get management operation - [List management operations](https://docs.lithic.com/reference/getmanagementoperations.md): List management operations - [Create management operation](https://docs.lithic.com/reference/postmanagementoperations.md): Create management operation - [Reverse management operation](https://docs.lithic.com/reference/reversemanagementoperation.md): Reverse a management operation - [Get network program](https://docs.lithic.com/reference/getnetworkprogram.md): Get network program. - [List network programs](https://docs.lithic.com/reference/getnetworkprograms.md): List network programs. - [Create payment](https://docs.lithic.com/reference/createpayment.md): Initiates a payment between a financial account and an external bank account. - [Get payment by token](https://docs.lithic.com/reference/getpaymentbytoken.md): Get the payment by token. - [Retry payment](https://docs.lithic.com/reference/retrypayment.md): Retry an origination which has been returned. - [Return payment](https://docs.lithic.com/reference/returnpayment.md): Return an ACH payment with a specified return reason code. Returns must be initiated within the time window specified by NACHA rules for each return code (typically 2 banking days for most codes, 60 calendar days for unauthorized debits). For a complete list of return codes and their meanings, see the [ACH Return Reasons documentation](https://docs.lithic.com/docs/ach-overview#ach-return-reasons). Note: * This endpoint does not modify the state of the financial account associated with the payment. If you would like to change the account state, use the [Update financial account status](https://docs.lithic.com/reference/updatefinancialaccountstatus) endpoint. * By default this endpoint is not enabled for your account. Please contact your implementations manager to enable this feature. - [List payments](https://docs.lithic.com/reference/searchpayments.md): List all the payments for the provided search criteria. - [Simulate payment lifecycle event](https://docs.lithic.com/reference/simulatepaymentaction.md): Simulate payment lifecycle event - [Simulate receipt](https://docs.lithic.com/reference/simulatepaymentsreceipt.md): Simulates a receipt of a Payment. - [Simulate release payment](https://docs.lithic.com/reference/simulatepaymentsrelease.md): Simulates a release of a Payment. - [Simulate return payment](https://docs.lithic.com/reference/simulatepaymentsreturn.md): Simulates a return of a Payment. - [Disenroll a responder endpoint](https://docs.lithic.com/reference/deleteresponderendpoint.md) - [Check the status of a responder endpoint](https://docs.lithic.com/reference/getresponderendpoints.md) - [Enroll a responder endpoint](https://docs.lithic.com/reference/postresponderendpoints.md) - [Get network total](https://docs.lithic.com/reference/getnetworktotal.md): Retrieve a specific network total record by token. Not available in sandbox. - [List settlement details](https://docs.lithic.com/reference/getsettlementdetails.md): List details. - [Get settlement summary](https://docs.lithic.com/reference/getsummary.md): Get the settlement report for a specified report date. Not available in sandbox. - [List network totals](https://docs.lithic.com/reference/listnetworktotals.md): List network total records with optional filters. Not available in sandbox. - [Create interest tier schedule](https://docs.lithic.com/reference/createinteresttierschedule.md): Create a new interest tier schedule entry for a supported financial account - [Delete interest tier schedule](https://docs.lithic.com/reference/deleteinteresttierschedule.md): Delete an interest tier schedule entry. Returns: - 400 Bad Request: Invalid effective_date format OR attempting to delete the earliest tier schedule entry for a non-PENDING account - 404 Not Found: Tier schedule entry not found for the given effective_date OR ledger account not found Note: PENDING accounts can delete the earliest tier schedule entry (account hasn't opened yet). Active/non-PENDING accounts cannot delete the earliest entry to prevent orphaning the account. If the deleted tier schedule has a past effective_date and the account is ACTIVE, the loan tape rebuild configuration will be updated to trigger rebuilds from that date. - [Get interest tier schedule](https://docs.lithic.com/reference/getinteresttierschedule.md): Get a specific interest tier schedule by effective date - [Get loan tape by token](https://docs.lithic.com/reference/getloantape.md): Get a specific loan tape for a given financial account. - [Get loan tape configuration](https://docs.lithic.com/reference/getloantapeconfiguration.md): Get the loan tape configuration for a given financial account. - [List loan tapes](https://docs.lithic.com/reference/getloantapes.md): List the loan tapes for a given financial account. - [Get statement by token](https://docs.lithic.com/reference/getstatement.md): Get a specific statement for a given financial account. - [List line items for a statement](https://docs.lithic.com/reference/getstatementlineitems.md): List the line items for a given statement within a given financial account. - [List statements](https://docs.lithic.com/reference/getstatements.md): List the statements for a given financial account. - [List interest tier schedules](https://docs.lithic.com/reference/listinteresttierschedules.md): List interest tier schedules for a financial account with optional date filtering. If no date parameters are provided, returns all tier schedules. If date parameters are provided, uses filtering to return matching schedules (max 100). - for_date: Returns exact match (takes precedence over other dates) - before_date: Returns schedules with effective_date <= before_date - after_date: Returns schedules with effective_date >= after_date - Both before_date and after_date: Returns schedules in range - [Update interest tier schedule](https://docs.lithic.com/reference/updateinteresttierschedule.md): Update an existing interest tier schedule - [API status check](https://docs.lithic.com/reference/getstatus.md): Status of api - [Activate a card tokenization](https://docs.lithic.com/reference/activatetokenization.md): This endpoint is used to ask the card network to activate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network activates the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`. This will put the tokenization in an active state, and transactions will be allowed. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [Deactivate a card tokenization](https://docs.lithic.com/reference/deactivatetokenization.md): This endpoint is used to ask the card network to deactivate a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network deactivates the tokenization, the state will be updated and a tokenization.updated event will be sent. Authorizations attempted with a deactivated tokenization will be blocked and will not be forwarded to Lithic from the network. Deactivating the token is a permanent operation. If the target is a digital wallet tokenization, it will be removed from its device. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [List digital card art](https://docs.lithic.com/reference/getdigitalcardart.md): List digital card art. - [Get digital card art by token](https://docs.lithic.com/reference/getdigitalcardartbytoken.md): Get digital card art by token. - [Get a single card tokenization](https://docs.lithic.com/reference/gettokenization.md): Get tokenization - [Retrieve the Tokenization Decisioning HMAC secret key](https://docs.lithic.com/reference/gettokenizationdecisioningsecret.md): Retrieve the Tokenization Decisioning secret key. If one does not exist your program yet, calling this endpoint will create one for you. The headers of the Tokenization Decisioning request will contain a hmac signature which you can use to verify requests originate from Lithic. See [this page](https://docs.lithic.com/docs/events-api#verifying-webhooks) for more detail about verifying Tokenization Decisioning requests. - [Get a card's tokenizations](https://docs.lithic.com/reference/gettokenizations.md): List card tokenizations - [Pause a card tokenization](https://docs.lithic.com/reference/pausetokenization.md): This endpoint is used to ask the card network to pause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network pauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `ACTIVE`. A paused token will prevent merchants from sending authorizations, and is a temporary status that can be changed. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [Simulate a card's tokenization](https://docs.lithic.com/reference/postsimulatetokenizations.md): This endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem. - [Resend activation code for a card tokenization](https://docs.lithic.com/reference/resendactivationcodefortokenization.md): This endpoint is used to ask the card network to send another activation code to a cardholder that has already tried tokenizing a card. A successful response indicates that the request was successfully delivered to the card network. The endpoint may only be used on Mastercard digital wallet tokenizations with status `INACTIVE`, `PENDING_ACTIVATION`, or `PENDING_2FA`. The network will send a new activation code to the one of the contact methods provided in the initial tokenization flow. If a user fails to enter the code correctly 3 times, the contact method will not be eligible for resending the activation code, and the cardholder must restart the provision process. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [Rotate the Tokenization Decisioning HMAC secret key](https://docs.lithic.com/reference/rotatetokenizationdecisioningsecret.md): Generate a new Tokenization Decisioning secret key. The old Tokenization Decisioning secret key will be deactivated 24 hours after a successful request to this endpoint. - [Unpause a card tokenization](https://docs.lithic.com/reference/unpausetokenization.md): This endpoint is used to ask the card network to unpause a tokenization. A successful response indicates that the request was successfully delivered to the card network. When the card network unpauses the tokenization, the state will be updated and a tokenization.updated event will be sent. The endpoint may only be used on tokenizations with status `PAUSED`. This will put the tokenization in an active state, and transactions may resume. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [Update digital card art for a card tokenization](https://docs.lithic.com/reference/updatedigitalcardartfortokenization.md): This endpoint is used update the digital card art for a digital wallet tokenization. A successful response indicates that the card network has updated the tokenization's art, and the tokenization's `digital_cart_art_token` field was updated. The endpoint may not be used on tokenizations with status `DEACTIVATED`. Note that this updates the art for one specific tokenization, not all tokenizations for a card. New tokenizations for a card will be created with the art referenced in the card object's `digital_card_art_token` field. Reach out at [lithic.com/contact](https://lithic.com/contact) for more information. - [Add case comment](https://docs.lithic.com/reference/createtransactionmonitoringcasecomment.md): Adds a comment to a case. - [Create case file](https://docs.lithic.com/reference/createtransactionmonitoringcasefile.md): Creates a file record and returns a presigned URL for uploading the file to the case. - [Create queue](https://docs.lithic.com/reference/createtransactionmonitoringqueue.md): Creates a new queue for grouping transaction monitoring cases. - [Delete case comment](https://docs.lithic.com/reference/deletetransactionmonitoringcasecomment.md): Deletes a comment from a case. - [Delete case file](https://docs.lithic.com/reference/deletetransactionmonitoringcasefile.md): Deletes a file from a case. - [Delete queue](https://docs.lithic.com/reference/deletetransactionmonitoringqueue.md): Deletes a transaction monitoring queue. - [Get case](https://docs.lithic.com/reference/gettransactionmonitoringcase.md): Retrieves a single transaction monitoring case. - [Get case file](https://docs.lithic.com/reference/gettransactionmonitoringcasefile.md): Retrieves a single file attached to a case, including a presigned download URL when the file is ready. - [Get queue](https://docs.lithic.com/reference/gettransactionmonitoringqueue.md): Retrieves a single transaction monitoring queue. - [List case activity](https://docs.lithic.com/reference/listtransactionmonitoringcaseactivity.md): Lists the activity feed for a case. - [List case cards](https://docs.lithic.com/reference/listtransactionmonitoringcasecards.md): Lists the cards involved in a case, with per-card transaction counts. - [List case files](https://docs.lithic.com/reference/listtransactionmonitoringcasefiles.md): Lists the files attached to a case. - [List cases](https://docs.lithic.com/reference/listtransactionmonitoringcases.md): Lists transaction monitoring cases, optionally filtered. - [List case transactions](https://docs.lithic.com/reference/listtransactionmonitoringcasetransactions.md): Lists the transactions associated with a case. - [List queues](https://docs.lithic.com/reference/listtransactionmonitoringqueues.md): Lists transaction monitoring queues. - [Update case](https://docs.lithic.com/reference/updatetransactionmonitoringcase.md): Updates a transaction monitoring case. - [Update case comment](https://docs.lithic.com/reference/updatetransactionmonitoringcasecomment.md): Edits an existing comment on a case. - [Update queue](https://docs.lithic.com/reference/updatetransactionmonitoringqueue.md): Updates a transaction monitoring queue. - [Expire an authorization](https://docs.lithic.com/reference/expireauthorization.md): Expire authorization - [Get enhanced commercial data](https://docs.lithic.com/reference/getenhancedtransactiondata.md): Get L2/L3 enhanced commercial data associated with a transaction event. Not available in sandbox. - [Get card transaction](https://docs.lithic.com/reference/gettransactionbytoken.md): Get a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD). - [List card transactions](https://docs.lithic.com/reference/gettransactions.md): List card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees. - [Transaction](https://docs.lithic.com/reference/transaction.md) - [List enhanced commercial data](https://docs.lithic.com/reference/listenhancedtransactiondata.md): Get all L2/L3 enhanced commercial data associated with a transaction. Not available in sandbox. - [Simulate authorization advice](https://docs.lithic.com/reference/postsimulateauthorizationadvice.md): Simulates an authorization advice from the card network as if it came from a merchant acquirer. An authorization advice changes the pending amount of the transaction. - [Simulate authorization](https://docs.lithic.com/reference/postsimulateauthorize.md): Simulates an authorization request from the card network as if it came from a merchant acquirer. If you are configured for ASA, simulating authorizations requires your ASA client to be set up properly, i.e. be able to respond to the ASA request with a valid JSON. For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. You can update this limit via the [update account](https://docs.lithic.com/reference/patchaccountbytoken) endpoint. - [Simulate clearing](https://docs.lithic.com/reference/postsimulateclearing.md): Clears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status. If `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint. - [Simulate credit authorization advice](https://docs.lithic.com/reference/postsimulatecreditauthorizationadvice.md): Simulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf. - [Simulate return](https://docs.lithic.com/reference/postsimulatereturn.md): Returns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a `SETTLED` transaction status. - [Simulate return reversal](https://docs.lithic.com/reference/postsimulatereturnreversal.md): Reverses a return, i.e. a credit transaction with a `SETTLED` status. Returns can be financial credit authorizations, or credit authorizations that have cleared. - [Simulate void](https://docs.lithic.com/reference/postsimulatevoid.md): Voids a pending authorization. If `amount` is not set, the full amount will be voided. Can be used on partially voided transactions but not partially cleared transactions. _Simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon._ - [Route a transaction](https://docs.lithic.com/reference/routetransaction.md): Route a card transaction to a financial account. Only available for select use cases and programs. - [Get transfer limits](https://docs.lithic.com/reference/gettransferlimits.md): Get transfer limits for a specified date - [Lithic MCP](https://docs.lithic.com/reference/mcp.md): Connect AI code editors to the Lithic API. Search docs, explore endpoints, and execute requests without leaving your editor. ## Changelog - [New Transaction Routing Endpoint Added](https://docs.lithic.com/changelog/new-transaction-routing-endpoint-added.md) - [Resuming automatic transitions for financial account states](https://docs.lithic.com/changelog/resuming-automatic-transitions-for-financial-account-states.md) - [Added new endpoint to Pause External Bank Account](https://docs.lithic.com/changelog/added-new-endpoint-to-pause-external-bank-account.md) - [New Hold Adjustment Rule Type Available in the Auth Rules API](https://docs.lithic.com/changelog/hold-adjustment-auth-rules.md) - [New Name Validation Fields Available in ASA](https://docs.lithic.com/changelog/asa-name-validation.md)