Lithic Developer API
The Lithic Developer API is designed to provide a predictable programmatic interface for accessing your Lithic account through an API and transaction…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Lithic Developer API is designed to provide a predictable programmatic interface for accessing your Lithic account through an API and transaction webhooks.
Note that your API key is a secret and should be treated as such. Don't share it with anyone, including us. We will never ask you for it.
Endpoints 232
3DS
- POSTSimulate 3DS authentication
/v1/three_ds_authentication/simulateSimulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating… - POSTSimulate entering OTP into 3DS Challenge UI
/v1/three_ds_decisioning/simulate/enter_otpEndpoint for simulating entering OTP into 3DS Challenge UI. A call to /v1/three_ds_authentication/simulate that resulted in triggered SMS-OTP challenge must… - GETGet 3DS authentication
/v1/three_ds_authentication/:three_ds_authentication_tokenGet 3DS Authentication by token - GETRetrieve the 3DS Decisioning HMAC secret key
/v1/three_ds_decisioning/secretRetrieve 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… - POSTRotate the 3DS Decisioning HMAC secret key
/v1/three_ds_decisioning/secret/rotateGenerate 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… - POSTRespond to a Challenge Request
/v1/three_ds_decisioning/challenge_responseCard program's response to a 3DS Challenge Request. Challenge Request is emitted as a webhook three_ds_authentication.challenge and your Card Program needs to…
Account
- GETList accounts
/v1/accounts?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList account configurations. - GETGet account
/v1/accounts/:account_tokenGet account configuration such as spend limits. - PATCHUpdate account
/v1/accounts/:account_tokenUpdate 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… - GETGet account's available spend limits
/v1/accounts/:account_token/spend_limitsGet 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… - GETFetch account signals
/v1/accounts/:account_token/signalsReturns behavioral feature state derived from an account's transaction history. These signals expose the same data used by behavioral rule attributes (e.g.…
Account Holder
- GETGet a list of individual or business account holders
/v1/account_holders?external_id=00000000-0000-0000-0000-000000000001&limit=10&first_name=John&last_name=Appleseed&legal_business_name=Busy Business, Inc.&phone_number=+15555555555&email=example@domain.com&ending_before=string&starting_after=string&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00ZGet a list of individual or business account holders and their KYC or KYB evaluation status. - POSTCreate an individual or business account holder
/v1/account_holdersCreate an account holder and initiate the appropriate onboarding workflow. Account holders and accounts have a 1:1 relationship. When an account holder is… - GETGet an individual or business account holder
/v1/account_holders/:account_holder_tokenGet an Individual or Business Account Holder and/or their KYC or KYB evaluation status. - PATCHUpdate account holder information and possibly resubmit for evaluation
/v1/account_holders/:account_holder_tokenUpdate the information associated with a particular account holder (including business owners and control persons associated to a business account). If Lithic… - GETGet account holder document uploads
/v1/account_holders/:account_holder_token/documentsRetrieve the status of account holder document uploads, or retrieve the upload URLs to process your image uploads. Note that this is not equivalent to… - POSTInitiate account holder document upload
/v1/account_holders/:account_holder_token/documentsUse this endpoint to identify which type of supported government-issued documentation you will upload for further verification. It will return two URLs to… - GETGet account holder document upload status
/v1/account_holders/:account_holder_token/documents/:document_tokenCheck 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… - POSTCreate a new beneficial owner individual or replace the existing control person entity
/v1/account_holders/:account_holder_token/entitiesCreate a new beneficial owner individual or replace the control person entity on an existing KYB account holder. This endpoint is only applicable for account… - DELETEDeactivate a beneficial owner individual
/v1/account_holders/:account_holder_token/entities/:entity_tokenDeactivate a beneficial owner individual on an existing KYB account holder. Only beneficial owner individuals can be deactivated. - POSTSimulate an account holder's enrollment review
/v1/simulate/account_holders/enrollment_reviewSimulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as KYB_BASIC. - POSTSimulate an account holder document upload's review
/v1/simulate/account_holders/enrollment_document_reviewSimulates a review for an account holder document upload.
Auth Stream Access (ASA)
- GETRetrieve the ASA HMAC secret key
/v1/auth_stream/secretRetrieve 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… - POSTRotate the ASA HMAC secret key
/v1/auth_stream/secret/rotateGenerate 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 Rules
- GETList rules
/v2/auth_rules?ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50&starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&scope=PROGRAM&event_stream=AUTHORIZATION&event_streams=AUTHORIZATIONLists V2 Auth rules - POSTCreate a new rule
/v2/auth_rulesCreates a new V2 Auth rule in draft mode - GETFetch a rule
/v2/auth_rules/:auth_rule_tokenFetches a V2 Auth rule by its token - DELETEDelete a rule
/v2/auth_rules/:auth_rule_tokenDeletes a V2 Auth rule - PATCHUpdate a rule
/v2/auth_rules/:auth_rule_tokenUpdates a V2 Auth rule's properties If entities is provided, this will replace the rule's existing entities with the provided include and exclude lists. To… - PATCHUpdate rule entities
/v2/auth_rules/:auth_rule_token/entitiesAdds entities to and removes entities from a V2 Auth rule's include and exclude lists To replace all of the rule's entities at once, provide entities to PATCH… - POSTDraft a new rule version
/v2/auth_rules/:auth_rule_token/draftCreates 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… - GETCalculated Feature values
/v2/auth_rules/:auth_rule_token/features?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6Fetches the current calculated Feature values for the given Auth Rule This only calculates the features for the active version. VelocityLimit Rules calculates… - POSTPromote a rule version
/v2/auth_rules/:auth_rule_token/promotePromotes the draft version of an Auth rule to the currently active version such that it is enforced in the respective stream. - GETList rule versions
/v2/auth_rules/:auth_rule_token/versionsReturns all versions of an auth rule, sorted by version number descending (newest first). - GETRetrieve a performance report
/v2/auth_rules/:auth_rule_token/report?begin=2024-01-01&end=2024-01-01Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes. Time Range Limitations: Reports are supported for the… - GETList backtests
/v2/auth_rules/:auth_rule_token/backtests?ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50&starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6Lists backtests for an Auth Rule - POSTRequest a backtest
/v2/auth_rules/:auth_rule_token/backtestsInitiates a request to asynchronously generate a backtest for an Auth rule. During backtesting, both the active version (if one exists) and the draft version… - GETRetrieve backtest results
/v2/auth_rules/:auth_rule_token/backtests/:auth_rule_backtest_tokenReturns the backtest results of an Auth rule (if available). Backtesting is an asynchronous process that requires time to complete. If a customer retrieves… - GETList rule evaluation results
/v2/auth_rules/results?ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50&starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&event_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&auth_rule_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&has_actions=trueLists 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…
Balance
- GETList balances
/v1/balances?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&balance_date=2024-01-01T00:00:00Z&financial_account_type=ISSUINGGet the balances for a program, business, or a given end-user account - GETGet balances
/v1/financial_accounts/:financial_account_token/balances?balance_date=2024-01-01T00:00:00Z&last_transaction_event_token=3fa85f64-5717-4562-b3fc-2c963f66afa6Get the balances for a given financial account. - GETGet open to buy
/v1/financial_accounts/:financial_account_token/open_to_buyGet the funds available for card spend backed by a given Security Account, along with the balances that amount is derived from. Open to buy is the amount…
Blockchain Recipient
- POSTCreate blockchain recipient
/v1/blockchain_recipientsRegister a blockchain address as a withdrawal destination for a financial account The recipient is created with a PENDING verification state and cannot… - GETGet blockchain recipient
/v1/blockchain_recipients/:blockchain_recipient_tokenGet a blockchain recipient by token Use this to poll the verification_state after registering an address: a recipient cannot receive a payout until screening…
Book Transfer
- POSTTransfer funds within Lithic
/v1/transferDeprecated. Transfer funds between two financial accounts or between a financial account and card - GETList book transfers
/v1/book_transfers?category=ADJUSTMENT&financial_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&result=APPROVED&status=DECLINED&begin=2024-01-01T00:00:00Z&ending_before=string&end=2024-01-01T00:00:00Z&page_size=50&starting_after=stringList book transfers - POSTCreate book transfer
/v1/book_transfersBook transfer funds between two financial accounts or between a financial account and card - GETGet book transfer by token
/v1/book_transfers/:book_transfer_tokenGet book transfer by token - POSTRetry book transfer
/v1/book_transfers/:book_transfer_token/retryRetry a book transfer that has been declined - POSTReverse book transfer
/v1/book_transfers/:book_transfer_token/reverseReverse a book transfer
Card
- GETFetch card signals
/v1/cards/:card_token/signalsReturns behavioral feature state derived from a card's transaction history. These signals expose the same data used by behavioral rule attributes (e.g.… - GETList card programs
/v1/card_programs?ending_before=string&page_size=50&starting_after=stringList card programs. - GETGet card program
/v1/card_programs/:card_program_tokenGet card program. - GETList cards
/v1/cards?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&state=CLOSED&memo=string&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList cards. - POSTCreate card
/v1/cardsCreate a new virtual or physical card. Parameters shipping_address and product_id only apply to physical cards. - POSTSearch for card by PAN
/v1/cards/search_by_panGet card configuration such as spend limit and state. Customers must be PCI compliant to use this endpoint. Please contact support.lithic.com for questions.… - GETGet card
/v1/cards/:card_tokenGet card configuration such as spend limit and state. - PATCHUpdate card
/v1/cards/:card_tokenUpdate the specified properties of the card. Unsupplied properties will remain unchanged. *Note: setting a card to a CLOSED state is a final action that… - GETGet card balances
/v1/cards/:card_token/balances?balance_date=2024-01-01T00:00:00Z&last_transaction_event_token=3fa85f64-5717-4562-b3fc-2c963f66afa6Get the balances for a given card. - GETList card financial transactions
/v1/cards/:card_token/financial_transactions?category=CARD&result=APPROVED&status=DECLINED&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList the financial transactions for a given card. - GETGet card financial transaction
/v1/cards/:card_token/financial_transactions/:financial_transaction_tokenGet the card financial transaction for the provided token. - POSTProvision card (Digital Wallet)
/v1/cards/:card_token/provisionAllow 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… - POSTWeb Push Provision card (Digital Wallet)
/v1/cards/:card_token/web_provisionAllow 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… - POSTReissue physical card
/v1/cards/:card_token/reissueInitiate 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… - POSTRenew a card
/v1/cards/:card_token/renewApplies 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… - POSTReassign a card to another account
/v1/cards/:card_token/reassign_accountReassigns a card to another account. The card must be in an OPEN or PAUSED state, and the destination account must be in an ACTIVE state. Clients must contact… - POSTConvert virtual to physical card
/v1/cards/:card_token/convert_physicalConvert a virtual card into a physical card and manufacture it. Customer must supply relevant fields for physical card creation including product_id, carrier,… - GETGet card's available spend limit
/v1/cards/:card_token/spend_limitsGet 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… - POSTCreate card embed session
/v1/cards/:card_token/embedCreates a short-lived session for displaying card details or setting a card PIN in Lithic-hosted iframes. Create the session on your backend to not expose… - GETEmbedded card UI
/v1/embed/card?embed_request=string&hmac=stringDeprecated. Deprecated. Use the modern embedded card flow instead: create a session with POST /v1/cards/{card_token}/embed and render it via GET /v1/embed.… - GETGet card embed iframe
/v1/embed?session=eyJhb...&type=PAN&styles=eyJjb2xvciI6ImJsYWNrIiwiOmhvdmVyIjp7ImNvbG9yIjoiYmx1ZSJ9fQ==&configuration=eyJwaW5fc2V0dGluZyI6eyJsYXlvdXQiOiJNVUxUSV9JTlBVVCJ9fQ==Returns a Lithic-hosted HTML document for a single card detail or PIN setting control. Use the URL, including its query parameters, as the src of an iframe.…
Card Authorizations
- POSTRespond to Authorization Challenge
/v1/card_authorizations/:event_token/challenge_responseCard program's response to Authorization Challenge. Programs that have Authorization Challenges configured as Out of Band receive a…
Card Bulk Orders
- GETList bulk orders
/v1/card_bulk_orders?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList bulk orders for physical card shipments - POSTCreate bulk order
/v1/card_bulk_ordersCreate 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… - GETGet bulk order
/v1/card_bulk_orders/:bulk_order_tokenRetrieve a specific bulk order by token - PATCHUpdate bulk order
/v1/card_bulk_orders/:bulk_order_tokenUpdate a bulk order. Primarily used to lock the order, preventing additional cards from being added
Credit Product
- GETGet extended credit
/v1/credit_products/:credit_product_token/extended_creditGet the extended credit for a given credit product under a program - GETGet Credit Product Prime Rates
/v1/credit_products/:credit_product_token/prime_rates?starting_after=2024-01-01&ending_before=2024-01-01 - POSTPost Credit Product Prime Rate
/v1/credit_products/:credit_product_token/prime_rates
Chargeback
- GETList chargeback requests
/v1/disputes?status=ARBITRATION&transaction_tokens=3fa85f64-5717-4562-b3fc-2c963f66afa6&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList chargeback requests. - POSTRequest chargeback
/v1/disputesRequest a chargeback. - GETGet chargeback request
/v1/disputes/:dispute_tokenGet chargeback request. - DELETEWithdraw chargeback request
/v1/disputes/:dispute_tokenWithdraw chargeback request. - PATCHUpdate chargeback request
/v1/disputes/:dispute_tokenUpdate chargeback request. Can only be modified if status is NEW. - GETList evidence
/v1/disputes/:dispute_token/evidences?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList evidence for a chargeback request. - POSTUpload evidence
/v1/disputes/:dispute_token/evidencesUse 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… - GETGet evidence
/v1/disputes/:dispute_token/evidences/:evidence_tokenGet evidence for a chargeback request. - DELETEDelete evidence
/v1/disputes/:dispute_token/evidences/:evidence_tokenSoft delete evidence for a chargeback request. Evidence will not be reviewed or submitted by Lithic after it is withdrawn.
Event
- GETList event subscriptions
/v1/event_subscriptions?ending_before=string&page_size=50&starting_after=stringList all the event subscriptions. - POSTCreate event subscription
/v1/event_subscriptionsCreate a new event subscription. - GETGet event subscription
/v1/event_subscriptions/:event_subscription_tokenGet an event subscription. - DELETEDelete event subscription
/v1/event_subscriptions/:event_subscription_tokenDelete an event subscription. - PATCHUpdate event subscription
/v1/event_subscriptions/:event_subscription_tokenUpdate an event subscription. - GETList message attempts for an event subscription
/v1/event_subscriptions/:event_subscription_token/attempts?status=FAILED&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList all the message attempts for a given event subscription. - POSTResend failed messages
/v1/event_subscriptions/:event_subscription_token/recover?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00ZResend all failed messages since a given time. - POSTReplay missing messages
/v1/event_subscriptions/:event_subscription_token/replay_missing?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00ZReplays messages to the endpoint. Only messages that were created on or after begin will be sent. Messages that were previously sent to the endpoint are not… - GETGet event subscription secret
/v1/event_subscriptions/:event_subscription_token/secretGet the secret for an event subscription. - POSTRotate event subscription secret
/v1/event_subscriptions/:event_subscription_token/secret/rotateRotate the secret for an event subscription. The previous secret will be valid for the next 24 hours. - GETList events
/v1/events?event_types=account_holder_document.updated&with_content=true&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList all events. - GETGet event
/v1/events/:event_tokenGet an event. - GETList message attempts for an event
/v1/events/:event_token/attempts?status=FAILED&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList all the message attempts for a given event. - POSTResend event
/v1/events/:event_token/event_subscriptions/:event_subscription_token/resendResend an event to an event subscription. - POSTSend event type example message
/v1/simulate/event_subscriptions/:event_subscription_token/send_exampleSend an example message for event.
External Bank Account
- GETList external bank accounts
/v1/external_bank_accounts?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_types=CHECKING&countries=string&owner_types=INDIVIDUAL&states=ENABLED&verification_states=PENDING&ending_before=string&page_size=50&starting_after=stringList all the external bank accounts for the provided search criteria. - POSTCreate external bank account
/v1/external_bank_accountsCreates an external bank account within a program or Lithic account. - GETGet external bank account by token
/v1/external_bank_accounts/:external_bank_account_tokenGet the external bank account by token. - PATCHUpdate external bank account
/v1/external_bank_accounts/:external_bank_account_tokenUpdate the external bank account by token. - POSTVerify external bank account via micro deposit amounts
/v1/external_bank_accounts/:external_bank_account_token/micro_depositsVerify the external bank account by providing the micro deposit amounts. - POSTPause external bank account
/v1/external_bank_accounts/:external_bank_account_token/pausePause an external bank account - POSTRetry external bank account via micro deposit
/v1/external_bank_accounts/:external_bank_account_token/retry_micro_depositsRetry external bank account micro deposit verification. - POSTRetry external bank account via prenote
/v1/external_bank_accounts/:external_bank_account_token/retry_prenoteRetry external bank account prenote verification. - POSTSet verification method
/v1/external_bank_accounts/:external_bank_account_token/set_verification_methodUpdate the verification method for an external bank account. Verification method can only be updated if the verification_state is PENDING. - POSTUnpause external bank account
/v1/external_bank_accounts/:external_bank_account_token/unpauseUnpause an external bank account
External Payments
- GETList external payments
/v1/external_payments?category=EXTERNAL_WIRE&financial_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&result=APPROVED&status=PENDING&begin=2024-01-01T00:00:00Z&ending_before=string&end=2024-01-01T00:00:00Z&page_size=50&starting_after=stringList external payments - POSTCreate external payment
/v1/external_paymentsCreate external payment - GETGet external payment
/v1/external_payments/:external_payment_tokenGet external payment - POSTSettle external payment
/v1/external_payments/:external_payment_token/settleSettle external payment - POSTRelease external payment
/v1/external_payments/:external_payment_token/releaseRelease external payment - POSTCancel external payment
/v1/external_payments/:external_payment_token/cancelCancel external payment - POSTReverse external payment
/v1/external_payments/:external_payment_token/reverseReverse external payment
Financial Account
- GETList financial accounts
/v1/financial_accounts?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&type=ISSUINGRetrieve information on your financial accounts including routing and account number. - POSTCreate financial account
/v1/financial_accountsCreate a new financial account - GETGet financial account
/v1/financial_accounts/:financial_account_tokenGet a financial account - PATCHUpdate financial account
/v1/financial_accounts/:financial_account_tokenUpdate a financial account - GETGet account credit configuration
/v1/financial_accounts/:financial_account_token/credit_configurationGet an Account's credit configuration - PATCHUpdate account credit configuration
/v1/financial_accounts/:financial_account_token/credit_configurationUpdate an account's credit configuration. A credit product can only be attached while the financial account is in the PENDING state; once a credit product has… - GETList financial transactions
/v1/financial_accounts/:financial_account_token/financial_transactions?category=ACH&result=APPROVED&status=DECLINED&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList the financial transactions for a given financial account. - GETGet financial transaction
/v1/financial_accounts/:financial_account_token/financial_transactions/:financial_transaction_tokenGet the financial transaction for the provided token. - POSTRegister Account Number
/v1/financial_accounts/:financial_account_token/register_account_numberRegister account number - POSTUpdate financial account status
/v1/financial_accounts/:financial_account_token/update_statusUpdate financial account status - GETList Account Activity
/v1/account_activity?status=DECLINED&result=APPROVED&financial_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&category=ACH&begin=2024-01-01T00:00:00Z&ending_before=string&end=2024-01-01T00:00:00Z&page_size=50&starting_after=stringRetrieve a list of transactions across all public accounts. - GETGet Single Transaction from Account Activity
/v1/account_activity/:transaction_tokenRetrieve a single transaction
Fraud Report
- GETGet a fraud report for a transaction
/v1/fraud/transactions/:transaction_tokenRetrieve a fraud report for a specific transaction identified by its unique transaction token. - POSTCreate or update a fraud report for a transaction
/v1/fraud/transactions/:transaction_tokenReport fraud for a specific transaction token by providing details such as fraud type, fraud status, and any additional comments.
Funding Events
- GETList funding events
/v1/funding_events?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&network_settlement_date=2024-01-01&page_size=50&starting_after=stringGet all funding events for program - GETGet funding event by ID
/v1/funding_events/:funding_event_tokenGet funding event for program by id - GETGet funding event details
/v1/funding_events/:funding_event_token/detailsGet funding event details by id
Hold
- GETList holds
/v1/financial_accounts/:financial_account_token/holds?status=PENDING&begin=2024-01-01T00:00:00Z&ending_before=string&end=2024-01-01T00:00:00Z&page_size=50&starting_after=stringList holds for a financial account. - POSTCreate hold
/v1/financial_accounts/:financial_account_token/holdsCreate 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… - GETGet hold
/v1/holds/:hold_tokenGet hold by token. - POSTVoid hold
/v1/holds/:hold_token/voidVoid an active hold. This returns the held funds from pending back to available balance. Only holds in PENDING status can be voided.
Managed Disputes
- GETList disputes
/v2/disputes?begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&page_size=50&starting_after=string&ending_before=string&disputed_transaction_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&claim_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6Returns a paginated list of disputes. - GETRetrieve a dispute
/v2/disputes/:dispute_tokenRetrieves a specific dispute by its token.
Management Operations
- GETList management operations
/v1/management_operations?category=MANAGEMENT_FEE&financial_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&status=PENDING&begin=2024-01-01T00:00:00Z&ending_before=string&end=2024-01-01T00:00:00Z&page_size=50&starting_after=stringList management operations - POSTCreate management operation
/v1/management_operationsCreate management operation - GETGet management operation
/v1/management_operations/:management_operation_tokenGet management operation - POSTReverse management operation
/v1/management_operations/:management_operation_token/reverseReverse a management operation
Network Program
- GETList network programs
/v1/network_programs?page_size=50&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00ZList network programs. - GETGet network program
/v1/network_programs/:network_program_tokenGet network program.
Payment
- GETList payments
/v1/payments?financial_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&business_account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&result=APPROVED&status=DECLINED&category=ACH&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList all the payments for the provided search criteria. - POSTCreate payment
/v1/paymentsInitiates an ACH payment between a financial account and an external bank account. This endpoint originates on the ACH rail only. To send a stablecoin payout,… - POSTCreate stablecoin payment
/v1/payments/stablecoinInitiates a stablecoin payout from a financial account to a registered blockchain recipient. The recipient must have been registered with Create blockchain… - GETGet payment by token
/v1/payments/:payment_tokenGet the payment by token. - POSTRetry payment
/v1/payments/:payment_token/retryRetry an origination which has been returned. - POSTReturn payment
/v1/payments/:payment_token/returnReturn 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… - POSTSimulate receipt
/v1/simulate/payments/receiptSimulates a receipt of a Payment. - POSTSimulate release payment
/v1/simulate/payments/releaseSimulates a release of a Payment. - POSTSimulate return payment
/v1/simulate/payments/returnSimulates a return of a Payment. - POSTSimulate payment lifecycle event
/v1/simulate/payments/:payment_token/actionSimulate payment lifecycle event
Responder Endpoints
- GETCheck the status of a responder endpoint
/v1/responder_endpoints?type=AUTH_STREAM_ACCESS - POSTEnroll a responder endpoint
/v1/responder_endpoints - DELETEDisenroll a responder endpoint
/v1/responder_endpoints?type=AUTH_STREAM_ACCESS - GETList Lithic IP ranges
/v1/ip_rangesReturns the IP addresses Lithic sends responder requests from (Auth Stream Access, 3DS decisioning, and tokenization decisioning), so you can allowlist them…
Settlement Report
- GETList settlement details
/v1/reports/settlement/details/:report_date?ending_before=string&page_size=50&starting_after=stringList details. - GETGet settlement summary
/v1/reports/settlement/summary/:report_dateGet the settlement report for a specified report date. Not available in sandbox. - GETList network totals
/v1/reports/settlement/network_totals?report_date=2024-01-01&report_date_begin=2024-01-01&report_date_end=2024-01-01&network=ALLPOINT&institution_id=string&settlement_institution_id=string&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&page_size=50&starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6List network total records with optional filters. Not available in sandbox. - GETGet network total
/v1/reports/settlement/network_totals/:tokenRetrieve a specific network total record by token. Not available in sandbox.
Statements
- GETList statements
/v1/financial_accounts/:financial_account_token/statements?begin=2024-01-01&end=2024-01-01&ending_before=string&page_size=50&starting_after=string&include_initial_statements=falseList the statements for a given financial account. - GETGet statement by token
/v1/financial_accounts/:financial_account_token/statements/:statement_tokenGet a specific statement for a given financial account. - GETList line items for a statement
/v1/financial_accounts/:financial_account_token/statements/:statement_token/line_items?ending_before=string&page_size=50&starting_after=stringList the line items for a given statement within a given financial account. - GETList loan tapes
/v1/financial_accounts/:financial_account_token/loan_tapes?begin=2024-01-01&end=2024-01-01&ending_before=string&page_size=50&starting_after=stringList the loan tapes for a given financial account. - GETGet loan tape by token
/v1/financial_accounts/:financial_account_token/loan_tapes/:loan_tape_tokenGet a specific loan tape for a given financial account. - GETGet loan tape configuration
/v1/financial_accounts/:financial_account_token/loan_tape_configurationGet the loan tape configuration for a given financial account. - GETList installment plans
/v1/financial_accounts/:financial_account_token/installment_plans?ending_before=string&page_size=50&state=PENDING&starting_after=stringList the installment plans for a given financial account. - GETGet installment plan by token
/v1/financial_accounts/:financial_account_token/installment_plans/:installment_plan_tokenGet a specific installment plan for a given financial account. - GETList installment plan statements
/v1/financial_accounts/:financial_account_token/installment_plans/:installment_plan_token/statements?begin=2024-01-01&end=2024-01-01&ending_before=string&page_size=50&state=PENDING&starting_after=stringList the statement snapshots for a given installment plan. - GETGet installment plan statement by token
/v1/financial_accounts/:financial_account_token/installment_plans/:installment_plan_token/statements/:statement_tokenGet a specific statement snapshot for a given installment plan. - GETList interest tier schedules
/v1/financial_accounts/:financial_account_token/interest_tier_schedule?after_date=2024-01-01&before_date=2024-01-01&for_date=2024-01-01List interest tier schedules for a financial account with optional date filtering. If no date parameters are provided, returns all tier schedules. If date… - POSTCreate interest tier schedule
/v1/financial_accounts/:financial_account_token/interest_tier_scheduleCreate a new interest tier schedule entry for a supported financial account - GETGet interest tier schedule
/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_dateGet a specific interest tier schedule by effective date - PUTUpdate interest tier schedule
/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_dateUpdate an existing interest tier schedule - DELETEDelete interest tier schedule
/v1/financial_accounts/:financial_account_token/interest_tier_schedule/:effective_dateDelete an interest tier schedule entry. Returns: 400 Bad Request: Invalid effective_date format OR attempting to delete the earliest tier schedule entry for a…
Status
- GETAPI status check
/v1/statusStatus of api
Tokenization
- GETList digital card art
/v1/digital_card_art?ending_before=string&page_size=50&starting_after=stringList digital card art. - GETGet digital card art by token
/v1/digital_card_art/:digital_card_art_tokenGet digital card art by token. - POSTSimulate a card's tokenization
/v1/simulate/tokenizationsThis endpoint is used to simulate a card's tokenization in the Digital Wallet and merchant tokenization ecosystem. - GETRetrieve the Tokenization Decisioning HMAC secret key
/v1/tokenization_decisioning/secretRetrieve 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… - POSTRotate the Tokenization Decisioning HMAC secret key
/v1/tokenization_decisioning/secret/rotateGenerate a new Tokenization Decisioning secret key. The old Tokenization Decisioning secret key will be deactivated 24 hours after a successful request to… - POSTCreate a tokenization
/v1/cards/:card_token/tokenizations> 🚧 Beta API > > This endpoint is in beta and subject to change. Create a tokenization for an OPEN card. Contact your Lithic representative to configure… - POSTSelect a tokenization authentication method
/v1/tokenizations/:tokenization_token/select_tfa_method> 🚧 Beta API > > This endpoint is in beta and subject to change. Select an available SMS or EMAIL authentication method for a tokenization with status… - POSTSubmit a tokenization authentication code
/v1/tokenizations/:tokenization_token/submit_tfa> 🚧 Beta API > > This endpoint is in beta and subject to change. Submit the cardholder's one-time authentication code for a tokenization with status… - POSTCreate payment credentials
/v1/tokenizations/:tokenization_token/payment_credentials> 🚧 Beta API > > This endpoint is in beta and subject to change. Create payment credentials and a purchase mandate for an ACTIVE tokenization. The credential… - GETGet a card's tokenizations
/v1/tokenizations?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&begin=2024-01-01&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&end=2024-01-01&tokenization_channel=DIGITAL_WALLET&ending_before=string&page_size=50&starting_after=stringList card tokenizations - GETGet a single card tokenization
/v1/tokenizations/:tokenization_tokenGet tokenization - POSTPause a card tokenization
/v1/tokenizations/:tokenization_token/pauseThis 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… - POSTUnpause a card tokenization
/v1/tokenizations/:tokenization_token/unpauseThis endpoint is used to ask the card network to unpause a tokenization. A successful response indicates that the request was successfully delivered to the… - POSTDeactivate a card tokenization
/v1/tokenizations/:tokenization_token/deactivateThis endpoint is used to ask the card network to deactivate a tokenization. A successful response indicates that the request was successfully delivered to the… - POSTActivate a card tokenization
/v1/tokenizations/:tokenization_token/activateThis endpoint is used to ask the card network to activate a tokenization. A successful response indicates that the request was successfully delivered to the… - POSTResend activation code for a card tokenization
/v1/tokenizations/:tokenization_token/resend_activation_codeThis 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… - POSTUpdate digital card art for a card tokenization
/v1/tokenizations/:tokenization_token/update_digital_card_artThis endpoint is used update the digital card art for a digital wallet tokenization. A successful response indicates that the card network has updated the…
Transaction
- GETList enhanced commercial data
/v1/transactions/:transaction_token/enhanced_commercial_dataGet all L2/L3 enhanced commercial data associated with a transaction. Not available in sandbox. - POSTExpire an authorization
/v1/transactions/:transaction_token/expire_authorizationExpire authorization - POSTRoute a transaction
/v1/transactions/:transaction_token/routeRoute a card transaction to a financial account. Only available for select use cases and programs. - GETGet enhanced commercial data
/v1/transactions/events/:event_token/enhanced_commercial_dataGet L2/L3 enhanced commercial data associated with a transaction event. Not available in sandbox. - POSTSimulate authorization advice
/v1/simulate/authorization_adviceSimulates an authorization advice from the card network as if it came from a merchant acquirer. An authorization advice changes the pending amount of the… - POSTSimulate authorization
/v1/simulate/authorizeSimulates an authorization request from the card network as if it came from a merchant acquirer. If you are configured for ASA, simulating authorizations… - POSTSimulate clearing
/v1/simulate/clearingClears an existing authorization, either debit or credit. After this event, the transaction transitions from PENDING to SETTLED status. If amount is not set,… - POSTSimulate credit authorization advice
/v1/simulate/credit_authorization_adviceSimulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf. - POSTSimulate return
/v1/simulate/returnReturns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a SETTLED… - POSTSimulate return reversal
/v1/simulate/return_reversalReverses a return, i.e. a credit transaction with a SETTLED status. Returns can be financial credit authorizations, or credit authorizations that have cleared. - POSTSimulate void
/v1/simulate/voidVoids 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… - GETList card transactions
/v1/transactions?account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&result=APPROVED&status=PENDING&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&ending_before=string&page_size=50&starting_after=stringList card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees. - GETGet card transaction
/v1/transactions/:transaction_tokenGet a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD).
Transaction Monitoring
- GETList cases
/v1/transaction_monitoring/cases?queue_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&status=OPEN&assignee=string&rule_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&transaction_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&card_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&account_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&entity_token=3fa85f64-5717-4562-b3fc-2c963f66afa6&sort_by=CREATED_ASC&begin=2024-01-01T00:00:00Z&end=2024-01-01T00:00:00Z&starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50Lists transaction monitoring cases, optionally filtered. - GETGet case
/v1/transaction_monitoring/cases/:case_tokenRetrieves a single transaction monitoring case. - PATCHUpdate case
/v1/transaction_monitoring/cases/:case_tokenUpdates a transaction monitoring case. - GETList case activity
/v1/transaction_monitoring/cases/:case_token/activity?starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50Lists the activity feed for a case. - GETList case transactions
/v1/transaction_monitoring/cases/:case_token/transactions?starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50Lists the transactions associated with a case. - GETList case cards
/v1/transaction_monitoring/cases/:case_token/cardsLists the cards involved in a case, with per-card transaction counts. - POSTAdd case comment
/v1/transaction_monitoring/cases/:case_token/commentsAdds a comment to a case. - DELETEDelete case comment
/v1/transaction_monitoring/cases/:case_token/comments/:comment_tokenDeletes a comment from a case. - PATCHUpdate case comment
/v1/transaction_monitoring/cases/:case_token/comments/:comment_tokenEdits an existing comment on a case. - GETList case files
/v1/transaction_monitoring/cases/:case_token/files?starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50Lists the files attached to a case. - POSTCreate case file
/v1/transaction_monitoring/cases/:case_token/filesCreates a file record and returns a presigned URL for uploading the file to the case. - GETGet case file
/v1/transaction_monitoring/cases/:case_token/files/:file_tokenRetrieves a single file attached to a case, including a presigned download URL when the file is ready. - DELETEDelete case file
/v1/transaction_monitoring/cases/:case_token/files/:file_tokenDeletes a file from a case. - GETList queues
/v1/transaction_monitoring/queues?starting_after=3fa85f64-5717-4562-b3fc-2c963f66afa6&ending_before=3fa85f64-5717-4562-b3fc-2c963f66afa6&page_size=50Lists transaction monitoring queues. - POSTCreate queue
/v1/transaction_monitoring/queuesCreates a new queue for grouping transaction monitoring cases. - GETGet queue
/v1/transaction_monitoring/queues/:queue_tokenRetrieves a single transaction monitoring queue. - DELETEDelete queue
/v1/transaction_monitoring/queues/:queue_tokenDeletes a transaction monitoring queue. - PATCHUpdate queue
/v1/transaction_monitoring/queues/:queue_tokenUpdates a transaction monitoring queue.
Transfer Limits
- GETGet transfer limits
/v1/transfer_limits?date=2025-11-10Get transfer limits for a specified date
API details
- Base URL
https://sandbox.lithic.com- Authentication
- An API key in the Authorization header
- Operations
- 232 operations on 188 pathsGET 114POST 93PATCH 14DELETE 10PUT 1
2 marked deprecated - Main resources
- Card 21Transaction Monitoring 18Tokenization 17Auth Rules 15Event 15Statements 15Transaction 13Financial Account 12Account Holder 11External Bank Account 10
- Response formats
application/jsontext/html- Webhooks
- 65 described
- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Lithic's published OpenAPI description (lithic-com/lithic-openapi) (Apache-2.0)
How to test the Lithic Developer API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Lithic Developer API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Simulate 3DS authentication” (POST /v1/three_ds_authentication/simulate), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Lithic Developer API?
The Lithic Developer API is designed to provide a predictable programmatic interface for accessing your Lithic account through an API and transaction… It is listed under Finance & banking and has 232 endpoints.
Who publishes the Lithic Developer API?
It is listed from Lithic's public API description (an OpenAPI document), not published by Lithic on Swastik Codes. Anyone who controls lithic.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Lithic Developer API?
Requests go to https://sandbox.lithic.com. Endpoint paths are added to this base URL.
How do I authenticate with the Lithic Developer API?
With an API key in the Authorization header.
How many endpoints does the Lithic Developer API have?
232 operations on 188 paths (114 GET, 93 POST, 14 PATCH, 10 DELETE, 1 PUT). The largest groups are Card, Transaction Monitoring, Tokenization, Auth Rules.
Is forking the Lithic Developer API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.