api.md

Shared Types

from lithic.types import (
    AccountFinancialAccountType,
    Address,
    AuthRule,
    Carrier,
    Currency,
    Document,
    InstanceFinancialAccountType,
    ShippingAddress,
    VelocityLimitParams,
    VelocityLimitParamsPeriodWindow,
)

Lithic

Types:

from lithic.types import APIStatus

Methods:

• client.api_status() -> APIStatus

Accounts

Types:

from lithic.types import Account, AccountSpendLimits

Methods:

• client.accounts.retrieve(account_token) -> Account
• client.accounts.update(account_token, **params) -> Account
• client.accounts.list(**params) -> SyncCursorPage[Account]
• client.accounts.retrieve_spend_limits(account_token) -> AccountSpendLimits

AccountHolders

Types:

from lithic.types import (
    AccountHolder,
    KYB,
    KYC,
    KYCExempt,
    RequiredDocument,
    AccountHolderCreateResponse,
    AccountHolderUpdateResponse,
    AccountHolderListDocumentsResponse,
    AccountHolderSimulateEnrollmentReviewResponse,
)

Methods:

• client.account_holders.create(**params) -> AccountHolderCreateResponse
• client.account_holders.retrieve(account_holder_token) -> AccountHolder
• client.account_holders.update(account_holder_token, **params) -> AccountHolderUpdateResponse
• client.account_holders.list(**params) -> SyncSinglePage[AccountHolder]
• client.account_holders.list_documents(account_holder_token) -> AccountHolderListDocumentsResponse
• client.account_holders.resubmit(account_holder_token, **params) -> AccountHolder
• client.account_holders.retrieve_document(document_token, *, account_holder_token) -> Document
• client.account_holders.simulate_enrollment_document_review(**params) -> Document
• client.account_holders.simulate_enrollment_review(**params) -> AccountHolderSimulateEnrollmentReviewResponse
• client.account_holders.upload_document(account_holder_token, **params) -> Document

AuthRules

V2

Types:

from lithic.types.auth_rules import (
    V2CreateResponse,
    V2RetrieveResponse,
    V2UpdateResponse,
    V2ListResponse,
    V2ApplyResponse,
    V2DraftResponse,
    V2PromoteResponse,
    V2ReportResponse,
)

Methods:

• client.auth_rules.v2.create(**params) -> V2CreateResponse
• client.auth_rules.v2.retrieve(auth_rule_token) -> V2RetrieveResponse
• client.auth_rules.v2.update(auth_rule_token, **params) -> V2UpdateResponse
• client.auth_rules.v2.list(**params) -> SyncCursorPage[V2ListResponse]
• client.auth_rules.v2.apply(auth_rule_token, **params) -> V2ApplyResponse
• client.auth_rules.v2.draft(auth_rule_token, **params) -> V2DraftResponse
• client.auth_rules.v2.promote(auth_rule_token) -> V2PromoteResponse
• client.auth_rules.v2.report(auth_rule_token) -> V2ReportResponse

Backtests

Types:

from lithic.types.auth_rules.v2 import BacktestResults, BacktestCreateResponse

Methods:

• client.auth_rules.v2.backtests.create(auth_rule_token, **params) -> BacktestCreateResponse
• client.auth_rules.v2.backtests.retrieve(auth_rule_backtest_token, *, auth_rule_token) -> BacktestResults

AuthStreamEnrollment

Types:

from lithic.types import AuthStreamSecret

Methods:

• client.auth_stream_enrollment.retrieve_secret() -> AuthStreamSecret
• client.auth_stream_enrollment.rotate_secret() -> None

TokenizationDecisioning

Types:

from lithic.types import TokenizationSecret, TokenizationDecisioningRotateSecretResponse

Methods:

• client.tokenization_decisioning.retrieve_secret() -> TokenizationSecret
• client.tokenization_decisioning.rotate_secret() -> TokenizationDecisioningRotateSecretResponse

Tokenizations

Types:

from lithic.types import (
    Tokenization,
    TokenizationRetrieveResponse,
    TokenizationSimulateResponse,
    TokenizationUpdateDigitalCardArtResponse,
)

Methods:

• client.tokenizations.retrieve(tokenization_token) -> TokenizationRetrieveResponse
• client.tokenizations.list(**params) -> SyncCursorPage[Tokenization]
• client.tokenizations.activate(tokenization_token) -> None
• client.tokenizations.deactivate(tokenization_token) -> None
• client.tokenizations.pause(tokenization_token) -> None
• client.tokenizations.resend_activation_code(tokenization_token, **params) -> None
• client.tokenizations.simulate(**params) -> TokenizationSimulateResponse
• client.tokenizations.unpause(tokenization_token) -> None
• client.tokenizations.update_digital_card_art(tokenization_token, **params) -> TokenizationUpdateDigitalCardArtResponse

Cards

Types:

from lithic.types import (
    Card,
    CardSpendLimits,
    SpendLimitDuration,
    CardEmbedResponse,
    CardProvisionResponse,
)

Methods:

• client.cards.create(**params) -> Card
• client.cards.retrieve(card_token) -> Card
• client.cards.update(card_token, **params) -> Card
• client.cards.list(**params) -> SyncCursorPage[Card]
• client.cards.embed(**params) -> str
• client.cards.provision(card_token, **params) -> CardProvisionResponse
• client.cards.reissue(card_token, **params) -> Card
• client.cards.renew(card_token, **params) -> Card
• client.cards.retrieve_spend_limits(card_token) -> CardSpendLimits
• client.cards.search_by_pan(**params) -> Card
• client.cards.get_embed_html(*args) -> str
• client.cards.get_embed_url(*args) -> URL

AggregateBalances

Types:

from lithic.types.cards import AggregateBalanceListResponse

Methods:

• client.cards.aggregate_balances.list(**params) -> SyncSinglePage[AggregateBalanceListResponse]

Balances

Types:

from lithic.types.cards import BalanceListResponse

Methods:

• client.cards.balances.list(card_token, **params) -> SyncSinglePage[BalanceListResponse]

FinancialTransactions

Methods:

• client.cards.financial_transactions.retrieve(financial_transaction_token, *, card_token) -> FinancialTransaction
• client.cards.financial_transactions.list(card_token, **params) -> SyncSinglePage[FinancialTransaction]

Balances

Types:

from lithic.types import Balance

Methods:

• client.balances.list(**params) -> SyncSinglePage[Balance]

AggregateBalances

Types:

from lithic.types import AggregateBalance

Methods:

• client.aggregate_balances.list(**params) -> SyncSinglePage[AggregateBalance]

Disputes

Types:

from lithic.types import Dispute, DisputeEvidence

Methods:

• client.disputes.create(**params) -> Dispute
• client.disputes.retrieve(dispute_token) -> Dispute
• client.disputes.update(dispute_token, **params) -> Dispute
• client.disputes.list(**params) -> SyncCursorPage[Dispute]
• client.disputes.delete(dispute_token) -> Dispute
• client.disputes.delete_evidence(evidence_token, *, dispute_token) -> DisputeEvidence
• client.disputes.initiate_evidence_upload(dispute_token, **params) -> DisputeEvidence
• client.disputes.list_evidences(dispute_token, **params) -> SyncCursorPage[DisputeEvidence]
• client.disputes.retrieve_evidence(evidence_token, *, dispute_token) -> DisputeEvidence
• client.disputes.upload_evidence(*args) -> None

Events

Types:

from lithic.types import Event, EventSubscription, MessageAttempt

Methods:

• client.events.retrieve(event_token) -> Event
• client.events.list(**params) -> SyncCursorPage[Event]
• client.events.list_attempts(event_token, **params) -> SyncCursorPage[MessageAttempt]
• client.events.resend(*args) -> None

Subscriptions

Types:

from lithic.types.events import SubscriptionRetrieveSecretResponse

Methods:

• client.events.subscriptions.create(**params) -> EventSubscription
• client.events.subscriptions.retrieve(event_subscription_token) -> EventSubscription
• client.events.subscriptions.update(event_subscription_token, **params) -> EventSubscription
• client.events.subscriptions.list(**params) -> SyncCursorPage[EventSubscription]
• client.events.subscriptions.delete(event_subscription_token) -> None
• client.events.subscriptions.list_attempts(event_subscription_token, **params) -> SyncCursorPage[MessageAttempt]
• client.events.subscriptions.recover(event_subscription_token, **params) -> None
• client.events.subscriptions.replay_missing(event_subscription_token, **params) -> None
• client.events.subscriptions.retrieve_secret(event_subscription_token) -> SubscriptionRetrieveSecretResponse
• client.events.subscriptions.rotate_secret(event_subscription_token) -> None
• client.events.subscriptions.send_simulated_example(event_subscription_token, **params) -> None

FinancialAccounts

Types:

from lithic.types import FinancialAccount, FinancialTransaction

Methods:

• client.financial_accounts.create(**params) -> FinancialAccount
• client.financial_accounts.retrieve(financial_account_token) -> FinancialAccount
• client.financial_accounts.update(financial_account_token, **params) -> FinancialAccount
• client.financial_accounts.list(**params) -> SyncSinglePage[FinancialAccount]
• client.financial_accounts.charge_off(financial_account_token, **params) -> FinancialAccountCreditConfig

Balances

Types:

from lithic.types.financial_accounts import BalanceListResponse

Methods:

• client.financial_accounts.balances.list(financial_account_token, **params) -> SyncSinglePage[BalanceListResponse]

FinancialTransactions

Methods:

• client.financial_accounts.financial_transactions.retrieve(financial_transaction_token, *, financial_account_token) -> FinancialTransaction
• client.financial_accounts.financial_transactions.list(financial_account_token, **params) -> SyncSinglePage[FinancialTransaction]

CreditConfiguration

Types:

from lithic.types.financial_accounts import FinancialAccountCreditConfig

Methods:

• client.financial_accounts.credit_configuration.retrieve(financial_account_token) -> FinancialAccountCreditConfig
• client.financial_accounts.credit_configuration.update(financial_account_token, **params) -> FinancialAccountCreditConfig

Statements

Types:

from lithic.types.financial_accounts import Statement, Statements

Methods:

• client.financial_accounts.statements.retrieve(statement_token, *, financial_account_token) -> Statement
• client.financial_accounts.statements.list(financial_account_token, **params) -> SyncCursorPage[Statement]

LineItems

Types:

from lithic.types.financial_accounts.statements import StatementLineItems, LineItemListResponse

Methods:

• client.financial_accounts.statements.line_items.list(statement_token, *, financial_account_token, **params) -> SyncCursorPage[LineItemListResponse]

LoanTapes

Types:

from lithic.types.financial_accounts import LoanTape

Methods:

• client.financial_accounts.loan_tapes.retrieve(loan_tape_token, *, financial_account_token) -> LoanTape
• client.financial_accounts.loan_tapes.list(financial_account_token, **params) -> SyncCursorPage[LoanTape]

Transactions

Types:

from lithic.types import (
    Transaction,
    TransactionSimulateAuthorizationResponse,
    TransactionSimulateAuthorizationAdviceResponse,
    TransactionSimulateClearingResponse,
    TransactionSimulateCreditAuthorizationResponse,
    TransactionSimulateReturnResponse,
    TransactionSimulateReturnReversalResponse,
    TransactionSimulateVoidResponse,
)

Methods:

• client.transactions.retrieve(transaction_token) -> Transaction
• client.transactions.list(**params) -> SyncCursorPage[Transaction]
• client.transactions.simulate_authorization(**params) -> TransactionSimulateAuthorizationResponse
• client.transactions.simulate_authorization_advice(**params) -> TransactionSimulateAuthorizationAdviceResponse
• client.transactions.simulate_clearing(**params) -> TransactionSimulateClearingResponse
• client.transactions.simulate_credit_authorization(**params) -> TransactionSimulateCreditAuthorizationResponse
• client.transactions.simulate_return(**params) -> TransactionSimulateReturnResponse
• client.transactions.simulate_return_reversal(**params) -> TransactionSimulateReturnReversalResponse
• client.transactions.simulate_void(**params) -> TransactionSimulateVoidResponse

EnhancedCommercialData

Types:

from lithic.types.transactions import EnhancedCommercialDataRetrieveResponse

Methods:

• client.transactions.enhanced_commercial_data.retrieve(transaction_token) -> EnhancedCommercialDataRetrieveResponse

Events

EnhancedCommercialData

Types:

from lithic.types.transactions.events import EnhancedData

Methods:

• client.transactions.events.enhanced_commercial_data.retrieve(event_token) -> EnhancedData

ResponderEndpoints

Types:

from lithic.types import ResponderEndpointStatus, ResponderEndpointCreateResponse

Methods:

• client.responder_endpoints.create(**params) -> ResponderEndpointCreateResponse
• client.responder_endpoints.delete(**params) -> None
• client.responder_endpoints.check_status(**params) -> ResponderEndpointStatus

Webhooks

Methods:

• client.webhooks.unwrap(*args) -> object
• client.webhooks.verify_signature(*args) -> None

ExternalBankAccounts

Types:

from lithic.types import (
    ExternalBankAccountAddress,
    OwnerType,
    VerificationMethod,
    ExternalBankAccountCreateResponse,
    ExternalBankAccountRetrieveResponse,
    ExternalBankAccountUpdateResponse,
    ExternalBankAccountListResponse,
    ExternalBankAccountRetryMicroDepositsResponse,
    ExternalBankAccountRetryPrenoteResponse,
)

Methods:

• client.external_bank_accounts.create(**params) -> ExternalBankAccountCreateResponse
• client.external_bank_accounts.retrieve(external_bank_account_token) -> ExternalBankAccountRetrieveResponse
• client.external_bank_accounts.update(external_bank_account_token, **params) -> ExternalBankAccountUpdateResponse
• client.external_bank_accounts.list(**params) -> SyncCursorPage[ExternalBankAccountListResponse]
• client.external_bank_accounts.retry_micro_deposits(external_bank_account_token, **params) -> ExternalBankAccountRetryMicroDepositsResponse
• client.external_bank_accounts.retry_prenote(external_bank_account_token, **params) -> ExternalBankAccountRetryPrenoteResponse

MicroDeposits

Types:

from lithic.types.external_bank_accounts import MicroDepositCreateResponse

Methods:

• client.external_bank_accounts.micro_deposits.create(external_bank_account_token, **params) -> MicroDepositCreateResponse

Payments

Types:

from lithic.types import (
    Payment,
    PaymentCreateResponse,
    PaymentRetryResponse,
    PaymentSimulateActionResponse,
    PaymentSimulateReceiptResponse,
    PaymentSimulateReleaseResponse,
    PaymentSimulateReturnResponse,
)

Methods:

• client.payments.create(**params) -> PaymentCreateResponse
• client.payments.retrieve(payment_token) -> Payment
• client.payments.list(**params) -> SyncCursorPage[Payment]
• client.payments.retry(payment_token) -> PaymentRetryResponse
• client.payments.simulate_action(payment_token, **params) -> PaymentSimulateActionResponse
• client.payments.simulate_receipt(**params) -> PaymentSimulateReceiptResponse
• client.payments.simulate_release(**params) -> PaymentSimulateReleaseResponse
• client.payments.simulate_return(**params) -> PaymentSimulateReturnResponse

ThreeDS

Authentication

Types:

from lithic.types.three_ds import AuthenticationRetrieveResponse, AuthenticationSimulateResponse

Methods:

• client.three_ds.authentication.retrieve(three_ds_authentication_token) -> AuthenticationRetrieveResponse
• client.three_ds.authentication.simulate(**params) -> AuthenticationSimulateResponse

Decisioning

Types:

from lithic.types.three_ds import (
    ChallengeResponse,
    ChallengeResult,
    DecisioningRetrieveSecretResponse,
    DecisioningSimulateChallengeResponse,
)

Methods:

• client.three_ds.decisioning.challenge_response(**params) -> None
• client.three_ds.decisioning.retrieve_secret() -> DecisioningRetrieveSecretResponse
• client.three_ds.decisioning.rotate_secret() -> None
• client.three_ds.decisioning.simulate_challenge(**params) -> DecisioningSimulateChallengeResponse
• client.three_ds.decisioning.simulate_challenge_response(**params) -> None

Reports

Types:

from lithic.types import SettlementDetail, SettlementReport, SettlementSummaryDetails

Settlement

Methods:

• client.reports.settlement.list_details(report_date, **params) -> SyncCursorPage[SettlementDetail]
• client.reports.settlement.summary(report_date) -> SettlementReport

CardPrograms

Types:

from lithic.types import CardProgram

Methods:

• client.card_programs.retrieve(card_program_token) -> CardProgram
• client.card_programs.list(**params) -> SyncCursorPage[CardProgram]

DigitalCardArt

Types:

from lithic.types import DigitalCardArt

Methods:

• client.digital_card_art.retrieve(digital_card_art_token) -> DigitalCardArt
• client.digital_card_art.list(**params) -> SyncCursorPage[DigitalCardArt]

BookTransfers

Types:

from lithic.types import BookTransferResponse

Methods:

• client.book_transfers.create(**params) -> BookTransferResponse
• client.book_transfers.retrieve(book_transfer_token) -> BookTransferResponse
• client.book_transfers.list(**params) -> SyncCursorPage[BookTransferResponse]
• client.book_transfers.reverse(book_transfer_token, **params) -> BookTransferResponse

CreditProducts

ExtendedCredit

Types:

from lithic.types.credit_products import ExtendedCredit

Methods:

• client.credit_products.extended_credit.retrieve(credit_product_token) -> ExtendedCredit

PrimeRates

Types:

from lithic.types.credit_products import PrimeRateRetrieveResponse

Methods:

• client.credit_products.prime_rates.create(credit_product_token, **params) -> None
• client.credit_products.prime_rates.retrieve(credit_product_token, **params) -> PrimeRateRetrieveResponse

ExternalPayments

Types:

from lithic.types import ExternalPayment

Methods:

• client.external_payments.create(**params) -> ExternalPayment
• client.external_payments.retrieve(external_payment_token) -> ExternalPayment
• client.external_payments.list(**params) -> SyncCursorPage[ExternalPayment]
• client.external_payments.cancel(external_payment_token, **params) -> ExternalPayment
• client.external_payments.release(external_payment_token, **params) -> ExternalPayment
• client.external_payments.reverse(external_payment_token, **params) -> ExternalPayment
• client.external_payments.settle(external_payment_token, **params) -> ExternalPayment

ManagementOperations

Types:

from lithic.types import ManagementOperationTransaction

Methods:

• client.management_operations.create(**params) -> ManagementOperationTransaction
• client.management_operations.retrieve(management_operation_token) -> ManagementOperationTransaction
• client.management_operations.list(**params) -> SyncCursorPage[ManagementOperationTransaction]
• client.management_operations.reverse(management_operation_token, **params) -> ManagementOperationTransaction