api.md

Lithic

Types:

• APIStatus

Methods:

• client.apiStatus() -> APIStatus

Shared

Types:

• AccountFinancialAccountType
• Address
• Carrier
• Currency
• Document
• InstanceFinancialAccountType
• ShippingAddress

Accounts

Types:

• Account
• AccountSpendLimits

Methods:

• client.accounts.retrieve(accountToken) -> Account
• client.accounts.update(accountToken, { ...params }) -> Account
• client.accounts.list({ ...params }) -> AccountsCursorPage
• client.accounts.retrieveSpendLimits(accountToken) -> AccountSpendLimits

AccountHolders

Types:

• AccountHolder
• KYB
• KYC
• KYCExempt
• RequiredDocument
• AccountHolderCreateResponse
• AccountHolderUpdateResponse
• AccountHolderListDocumentsResponse
• AccountHolderSimulateEnrollmentReviewResponse

Methods:

• client.accountHolders.create({ ...params }) -> AccountHolderCreateResponse
• client.accountHolders.retrieve(accountHolderToken) -> AccountHolder
• client.accountHolders.update(accountHolderToken, { ...params }) -> AccountHolderUpdateResponse
• client.accountHolders.list({ ...params }) -> AccountHoldersSinglePage
• client.accountHolders.listDocuments(accountHolderToken) -> AccountHolderListDocumentsResponse
• client.accountHolders.retrieveDocument(accountHolderToken, documentToken) -> Document
• client.accountHolders.simulateEnrollmentDocumentReview({ ...params }) -> Document
• client.accountHolders.simulateEnrollmentReview({ ...params }) -> AccountHolderSimulateEnrollmentReviewResponse
• client.accountHolders.uploadDocument(accountHolderToken, { ...params }) -> Document

AuthRules

V2

Types:

• AuthRule
• AuthRuleCondition
• ConditionalAttribute
• ConditionalBlockParameters
• VelocityLimitParams
• VelocityLimitParamsPeriodWindow
• V2CreateResponse
• V2RetrieveResponse
• V2UpdateResponse
• V2ListResponse
• V2ApplyResponse
• V2DraftResponse
• V2PromoteResponse
• V2ReportResponse

Methods:

• client.authRules.v2.create({ ...params }) -> V2CreateResponse
• client.authRules.v2.retrieve(authRuleToken) -> V2RetrieveResponse
• client.authRules.v2.update(authRuleToken, { ...params }) -> V2UpdateResponse
• client.authRules.v2.list({ ...params }) -> V2ListResponsesCursorPage
• client.authRules.v2.apply(authRuleToken, { ...params }) -> V2ApplyResponse
• client.authRules.v2.draft(authRuleToken, { ...params }) -> V2DraftResponse
• client.authRules.v2.promote(authRuleToken) -> V2PromoteResponse
• client.authRules.v2.report(authRuleToken) -> V2ReportResponse

Backtests

Types:

• BacktestResults
• BacktestCreateResponse

Methods:

• client.authRules.v2.backtests.create(authRuleToken, { ...params }) -> BacktestCreateResponse
• client.authRules.v2.backtests.retrieve(authRuleToken, authRuleBacktestToken) -> BacktestResults

AuthStreamEnrollment

Types:

• AuthStreamSecret

Methods:

• client.authStreamEnrollment.retrieveSecret() -> AuthStreamSecret
• client.authStreamEnrollment.rotateSecret() -> void

TokenizationDecisioning

Types:

• TokenizationSecret
• TokenizationDecisioningRotateSecretResponse

Methods:

• client.tokenizationDecisioning.retrieveSecret() -> TokenizationSecret
• client.tokenizationDecisioning.rotateSecret() -> TokenizationDecisioningRotateSecretResponse

Tokenizations

Types:

• Tokenization
• TokenizationRetrieveResponse
• TokenizationSimulateResponse
• TokenizationUpdateDigitalCardArtResponse

Methods:

• client.tokenizations.retrieve(tokenizationToken) -> TokenizationRetrieveResponse
• client.tokenizations.list({ ...params }) -> TokenizationsCursorPage
• client.tokenizations.activate(tokenizationToken) -> void
• client.tokenizations.deactivate(tokenizationToken) -> void
• client.tokenizations.pause(tokenizationToken) -> void
• client.tokenizations.resendActivationCode(tokenizationToken, { ...params }) -> void
• client.tokenizations.simulate({ ...params }) -> TokenizationSimulateResponse
• client.tokenizations.unpause(tokenizationToken) -> void
• client.tokenizations.updateDigitalCardArt(tokenizationToken, { ...params }) -> TokenizationUpdateDigitalCardArtResponse

Cards

Types:

• Card
• CardSpendLimits
• SpendLimitDuration
• CardEmbedResponse
• CardProvisionResponse

Methods:

• client.cards.create({ ...params }) -> Card
• client.cards.retrieve(cardToken) -> Card
• client.cards.update(cardToken, { ...params }) -> Card
• client.cards.list({ ...params }) -> CardsCursorPage
• client.cards.convertPhysical(cardToken, { ...params }) -> Card
• client.cards.embed({ ...params }) -> string
• client.cards.provision(cardToken, { ...params }) -> CardProvisionResponse
• client.cards.reissue(cardToken, { ...params }) -> Card
• client.cards.renew(cardToken, { ...params }) -> Card
• client.cards.retrieveSpendLimits(cardToken) -> CardSpendLimits
• client.cards.searchByPan({ ...params }) -> Card
• client.cards.getEmbedHTML(...args) -> Promise<string>
• client.cards.getEmbedURL(...args) -> string

AggregateBalances

Types:

• AggregateBalanceListResponse

Methods:

• client.cards.aggregateBalances.list({ ...params }) -> AggregateBalanceListResponsesSinglePage

Balances

Types:

• BalanceListResponse

Methods:

• client.cards.balances.list(cardToken, { ...params }) -> BalanceListResponsesSinglePage

FinancialTransactions

Methods:

• client.cards.financialTransactions.retrieve(cardToken, financialTransactionToken) -> FinancialTransaction
• client.cards.financialTransactions.list(cardToken, { ...params }) -> FinancialTransactionsSinglePage

Balances

Types:

• Balance

Methods:

• client.balances.list({ ...params }) -> BalancesSinglePage

AggregateBalances

Types:

• AggregateBalance

Methods:

• client.aggregateBalances.list({ ...params }) -> AggregateBalancesSinglePage

Disputes

Types:

• Dispute
• DisputeEvidence
• DisputeInitiateEvidenceUploadResponse

Methods:

• client.disputes.create({ ...params }) -> Dispute
• client.disputes.retrieve(disputeToken) -> Dispute
• client.disputes.update(disputeToken, { ...params }) -> Dispute
• client.disputes.list({ ...params }) -> DisputesCursorPage
• client.disputes.del(disputeToken) -> Dispute
• client.disputes.deleteEvidence(disputeToken, evidenceToken) -> DisputeEvidence
• client.disputes.initiateEvidenceUpload(disputeToken, { ...params }) -> DisputeEvidence
• client.disputes.listEvidences(disputeToken, { ...params }) -> DisputeEvidencesCursorPage
• client.disputes.retrieveEvidence(disputeToken, evidenceToken) -> DisputeEvidence
• client.disputes.uploadEvidence(disputeToken, file, options?) -> Promise<void>

Events

Types:

• Event
• EventSubscription
• MessageAttempt

Methods:

• client.events.retrieve(eventToken) -> Event
• client.events.list({ ...params }) -> EventsCursorPage
• client.events.listAttempts(eventToken, { ...params }) -> MessageAttemptsCursorPage
• client.events.resend(eventToken, params, options?) -> Promise<void>

Subscriptions

Types:

• SubscriptionRetrieveSecretResponse

Methods:

• client.events.subscriptions.create({ ...params }) -> EventSubscription
• client.events.subscriptions.retrieve(eventSubscriptionToken) -> EventSubscription
• client.events.subscriptions.update(eventSubscriptionToken, { ...params }) -> EventSubscription
• client.events.subscriptions.list({ ...params }) -> EventSubscriptionsCursorPage
• client.events.subscriptions.del(eventSubscriptionToken) -> void
• client.events.subscriptions.listAttempts(eventSubscriptionToken, { ...params }) -> MessageAttemptsCursorPage
• client.events.subscriptions.recover(eventSubscriptionToken, { ...params }) -> void
• client.events.subscriptions.replayMissing(eventSubscriptionToken, { ...params }) -> void
• client.events.subscriptions.retrieveSecret(eventSubscriptionToken) -> SubscriptionRetrieveSecretResponse
• client.events.subscriptions.rotateSecret(eventSubscriptionToken) -> void
• client.events.subscriptions.sendSimulatedExample(eventSubscriptionToken, { ...params }) -> void

Transfers

Types:

• Transfer

Methods:

• client.transfers.create({ ...params }) -> Transfer

FinancialAccounts

Types:

• FinancialAccount
• FinancialTransaction

Methods:

• client.financialAccounts.create({ ...params }) -> FinancialAccount
• client.financialAccounts.retrieve(financialAccountToken) -> FinancialAccount
• client.financialAccounts.update(financialAccountToken, { ...params }) -> FinancialAccount
• client.financialAccounts.list({ ...params }) -> FinancialAccountsSinglePage
• client.financialAccounts.chargeOff(financialAccountToken, { ...params }) -> FinancialAccountCreditConfig

Balances

Types:

• BalanceListResponse

Methods:

• client.financialAccounts.balances.list(financialAccountToken, { ...params }) -> BalanceListResponsesSinglePage

FinancialTransactions

Methods:

• client.financialAccounts.financialTransactions.retrieve(financialAccountToken, financialTransactionToken) -> FinancialTransaction
• client.financialAccounts.financialTransactions.list(financialAccountToken, { ...params }) -> FinancialTransactionsSinglePage

CreditConfiguration

Types:

• FinancialAccountCreditConfig

Methods:

• client.financialAccounts.creditConfiguration.retrieve(financialAccountToken) -> FinancialAccountCreditConfig
• client.financialAccounts.creditConfiguration.update(financialAccountToken, { ...params }) -> FinancialAccountCreditConfig

Statements

Types:

• Statement
• Statements

Methods:

• client.financialAccounts.statements.retrieve(financialAccountToken, statementToken) -> Statement
• client.financialAccounts.statements.list(financialAccountToken, { ...params }) -> StatementsCursorPage

LineItems

Types:

• StatementLineItems

Methods:

• client.financialAccounts.statements.lineItems.list(financialAccountToken, statementToken, { ...params }) -> StatementLineItemsDataCursorPage

LoanTapes

Types:

• LoanTape

Methods:

• client.financialAccounts.loanTapes.retrieve(financialAccountToken, loanTapeToken) -> LoanTape
• client.financialAccounts.loanTapes.list(financialAccountToken, { ...params }) -> LoanTapesCursorPage

Transactions

Types:

• Transaction
• TransactionSimulateAuthorizationResponse
• TransactionSimulateAuthorizationAdviceResponse
• TransactionSimulateClearingResponse
• TransactionSimulateCreditAuthorizationResponse
• TransactionSimulateReturnResponse
• TransactionSimulateReturnReversalResponse
• TransactionSimulateVoidResponse

Methods:

• client.transactions.retrieve(transactionToken) -> Transaction
• client.transactions.list({ ...params }) -> TransactionsCursorPage
• client.transactions.simulateAuthorization({ ...params }) -> TransactionSimulateAuthorizationResponse
• client.transactions.simulateAuthorizationAdvice({ ...params }) -> TransactionSimulateAuthorizationAdviceResponse
• client.transactions.simulateClearing({ ...params }) -> TransactionSimulateClearingResponse
• client.transactions.simulateCreditAuthorization({ ...params }) -> TransactionSimulateCreditAuthorizationResponse
• client.transactions.simulateReturn({ ...params }) -> TransactionSimulateReturnResponse
• client.transactions.simulateReturnReversal({ ...params }) -> TransactionSimulateReturnReversalResponse
• client.transactions.simulateVoid({ ...params }) -> TransactionSimulateVoidResponse

EnhancedCommercialData

Types:

• EnhancedCommercialDataRetrieveResponse

Methods:

• client.transactions.enhancedCommercialData.retrieve(transactionToken) -> EnhancedCommercialDataRetrieveResponse

Events

EnhancedCommercialData

Types:

• EnhancedData

Methods:

• client.transactions.events.enhancedCommercialData.retrieve(eventToken) -> EnhancedData

ResponderEndpoints

Types:

• ResponderEndpointStatus
• ResponderEndpointCreateResponse

Methods:

• client.responderEndpoints.create({ ...params }) -> ResponderEndpointCreateResponse
• client.responderEndpoints.del({ ...params }) -> void
• client.responderEndpoints.checkStatus({ ...params }) -> ResponderEndpointStatus

Webhooks

Methods:

• client.webhooks.unwrap(payload, headers, secret) -> Object
• client.webhooks.verifySignature(body, headers, secret) -> void

ExternalBankAccounts

Types:

• ExternalBankAccountAddress
• OwnerType
• VerificationMethod
• ExternalBankAccountCreateResponse
• ExternalBankAccountRetrieveResponse
• ExternalBankAccountUpdateResponse
• ExternalBankAccountListResponse
• ExternalBankAccountRetryMicroDepositsResponse
• ExternalBankAccountRetryPrenoteResponse

Methods:

• client.externalBankAccounts.create({ ...params }) -> ExternalBankAccountCreateResponse
• client.externalBankAccounts.retrieve(externalBankAccountToken) -> ExternalBankAccountRetrieveResponse
• client.externalBankAccounts.update(externalBankAccountToken, { ...params }) -> ExternalBankAccountUpdateResponse
• client.externalBankAccounts.list({ ...params }) -> ExternalBankAccountListResponsesCursorPage
• client.externalBankAccounts.retryMicroDeposits(externalBankAccountToken, { ...params }) -> ExternalBankAccountRetryMicroDepositsResponse
• client.externalBankAccounts.retryPrenote(externalBankAccountToken, { ...params }) -> ExternalBankAccountRetryPrenoteResponse

MicroDeposits

Types:

• MicroDepositCreateResponse

Methods:

• client.externalBankAccounts.microDeposits.create(externalBankAccountToken, { ...params }) -> MicroDepositCreateResponse

Payments

Types:

• Payment
• PaymentCreateResponse
• PaymentRetryResponse
• PaymentSimulateActionResponse
• PaymentSimulateReceiptResponse
• PaymentSimulateReleaseResponse
• PaymentSimulateReturnResponse

Methods:

• client.payments.create({ ...params }) -> PaymentCreateResponse
• client.payments.retrieve(paymentToken) -> Payment
• client.payments.list({ ...params }) -> PaymentsCursorPage
• client.payments.retry(paymentToken) -> PaymentRetryResponse
• client.payments.simulateAction(paymentToken, { ...params }) -> PaymentSimulateActionResponse
• client.payments.simulateReceipt({ ...params }) -> PaymentSimulateReceiptResponse
• client.payments.simulateRelease({ ...params }) -> PaymentSimulateReleaseResponse
• client.payments.simulateReturn({ ...params }) -> PaymentSimulateReturnResponse

ThreeDS

Authentication

Types:

• AuthenticationRetrieveResponse
• AuthenticationSimulateResponse

Methods:

• client.threeDS.authentication.retrieve(threeDSAuthenticationToken) -> AuthenticationRetrieveResponse
• client.threeDS.authentication.simulate({ ...params }) -> AuthenticationSimulateResponse

Decisioning

Types:

• ChallengeResponse
• ChallengeResult
• DecisioningRetrieveSecretResponse
• DecisioningSimulateChallengeResponse

Methods:

• client.threeDS.decisioning.challengeResponse({ ...params }) -> void
• client.threeDS.decisioning.retrieveSecret() -> DecisioningRetrieveSecretResponse
• client.threeDS.decisioning.rotateSecret() -> void
• client.threeDS.decisioning.simulateChallenge({ ...params }) -> DecisioningSimulateChallengeResponse
• client.threeDS.decisioning.simulateChallengeResponse({ ...params }) -> void

Reports

Types:

• SettlementDetail
• SettlementReport
• SettlementSummaryDetails

Settlement

Methods:

• client.reports.settlement.listDetails(reportDate, { ...params }) -> SettlementDetailsCursorPage
• client.reports.settlement.summary(reportDate) -> SettlementReport

CardPrograms

Types:

• CardProgram

Methods:

• client.cardPrograms.retrieve(cardProgramToken) -> CardProgram
• client.cardPrograms.list({ ...params }) -> CardProgramsCursorPage

DigitalCardArt

Types:

• DigitalCardArt

Methods:

• client.digitalCardArt.retrieve(digitalCardArtToken) -> DigitalCardArt
• client.digitalCardArt.list({ ...params }) -> DigitalCardArtsCursorPage

BookTransfers

Types:

• BookTransferResponse

Methods:

• client.bookTransfers.create({ ...params }) -> BookTransferResponse
• client.bookTransfers.retrieve(bookTransferToken) -> BookTransferResponse
• client.bookTransfers.list({ ...params }) -> BookTransferResponsesCursorPage
• client.bookTransfers.reverse(bookTransferToken, { ...params }) -> BookTransferResponse

CreditProducts

ExtendedCredit

Types:

• ExtendedCredit

Methods:

• client.creditProducts.extendedCredit.retrieve(creditProductToken) -> ExtendedCredit

PrimeRates

Types:

• PrimeRateRetrieveResponse

Methods:

• client.creditProducts.primeRates.create(creditProductToken, { ...params }) -> void
• client.creditProducts.primeRates.retrieve(creditProductToken, { ...params }) -> PrimeRateRetrieveResponse

ExternalPayments

Types:

• ExternalPayment

Methods:

• client.externalPayments.create({ ...params }) -> ExternalPayment
• client.externalPayments.retrieve(externalPaymentToken) -> ExternalPayment
• client.externalPayments.list({ ...params }) -> ExternalPaymentsCursorPage
• client.externalPayments.cancel(externalPaymentToken, { ...params }) -> ExternalPayment
• client.externalPayments.release(externalPaymentToken, { ...params }) -> ExternalPayment
• client.externalPayments.reverse(externalPaymentToken, { ...params }) -> ExternalPayment
• client.externalPayments.settle(externalPaymentToken, { ...params }) -> ExternalPayment

ManagementOperations

Types:

• ManagementOperationTransaction

Methods:

• client.managementOperations.create({ ...params }) -> ManagementOperationTransaction
• client.managementOperations.retrieve(managementOperationToken) -> ManagementOperationTransaction
• client.managementOperations.list({ ...params }) -> ManagementOperationTransactionsCursorPage
• client.managementOperations.reverse(managementOperationToken, { ...params }) -> ManagementOperationTransaction