Skip to content

Latest commit

 

History

History
835 lines (566 loc) · 58.8 KB

File metadata and controls

835 lines (566 loc) · 58.8 KB

Lithic

Types:

Methods:

Shared

Types:

Accounts

Types:

Methods:

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

AccountHolders

Types:

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(documentToken, { ...params }) -> Document
  • client.accountHolders.simulateEnrollmentDocumentReview({ ...params }) -> Document
  • client.accountHolders.simulateEnrollmentReview({ ...params }) -> AccountHolderSimulateEnrollmentReviewResponse
  • client.accountHolders.uploadDocument(accountHolderToken, { ...params }) -> Document

Entities

Types:

Methods:

  • client.accountHolders.entities.create(accountHolderToken, { ...params }) -> EntityCreateResponse
  • client.accountHolders.entities.delete(entityToken, { ...params }) -> AccountHolderEntity

AuthRules

V2

Types:

Methods:

  • client.authRules.v2.create({ ...params }) -> AuthRule
  • client.authRules.v2.retrieve(authRuleToken) -> AuthRule
  • client.authRules.v2.update(authRuleToken, { ...params }) -> AuthRule
  • client.authRules.v2.list({ ...params }) -> AuthRulesCursorPage
  • client.authRules.v2.delete(authRuleToken) -> void
  • client.authRules.v2.draft(authRuleToken, { ...params }) -> AuthRule
  • client.authRules.v2.listResults({ ...params }) -> V2ListResultsResponsesCursorPage
  • client.authRules.v2.promote(authRuleToken) -> AuthRule
  • client.authRules.v2.retrieveFeatures(authRuleToken, { ...params }) -> V2RetrieveFeaturesResponse
  • client.authRules.v2.retrieveReport(authRuleToken, { ...params }) -> V2RetrieveReportResponse

Backtests

Types:

Methods:

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

AuthStreamEnrollment

Types:

Methods:

TokenizationDecisioning

Types:

Methods:

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

Tokenizations

Types:

Methods:

  • client.tokenizations.retrieve(tokenizationToken) -> Tokenization
  • 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 }) -> Tokenization
  • client.tokenizations.unpause(tokenizationToken) -> void
  • client.tokenizations.updateDigitalCardArt(tokenizationToken, { ...params }) -> Tokenization

Cards

Types:

Methods:

  • client.cards.create({ ...params }) -> Card
  • client.cards.retrieve(cardToken) -> Card
  • client.cards.update(cardToken, { ...params }) -> Card
  • client.cards.list({ ...params }) -> NonPCICardsCursorPage
  • 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.webProvision(cardToken, { ...params }) -> CardWebProvisionResponse
  • client.cards.getEmbedHTML(...args) -> Promise<string>
  • client.cards.getEmbedURL(...args) -> string

Balances

Methods:

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

FinancialTransactions

Methods:

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

CardBulkOrders

Types:

Methods:

  • client.cardBulkOrders.create({ ...params }) -> CardBulkOrder
  • client.cardBulkOrders.retrieve(bulkOrderToken) -> CardBulkOrder
  • client.cardBulkOrders.update(bulkOrderToken, { ...params }) -> CardBulkOrder
  • client.cardBulkOrders.list({ ...params }) -> CardBulkOrdersCursorPage

Balances

Types:

Methods:

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

Disputes

Types:

Methods:

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

DisputesV2

Types:

Methods:

  • client.disputesV2.retrieve(disputeToken) -> DisputeV2
  • client.disputesV2.list({ ...params }) -> DisputeV2sCursorPage

Events

Types:

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:

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.delete(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

EventSubscriptions

Methods:

  • client.events.eventSubscriptions.resend(eventSubscriptionToken, { ...params }) -> void

Transfers

Types:

Methods:

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

FinancialAccounts

Types:

Methods:

  • client.financialAccounts.create({ ...params }) -> FinancialAccount
  • client.financialAccounts.retrieve(financialAccountToken) -> FinancialAccount
  • client.financialAccounts.update(financialAccountToken, { ...params }) -> FinancialAccount
  • client.financialAccounts.list({ ...params }) -> FinancialAccountsSinglePage
  • client.financialAccounts.registerAccountNumber(financialAccountToken, { ...params }) -> void
  • client.financialAccounts.updateStatus(financialAccountToken, { ...params }) -> FinancialAccount

Balances

Methods:

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

FinancialTransactions

Methods:

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

CreditConfiguration

Types:

Methods:

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

Statements

Types:

Methods:

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

LineItems

Types:

Methods:

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

LoanTapes

Types:

Methods:

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

LoanTapeConfiguration

Types:

Methods:

  • client.financialAccounts.loanTapeConfiguration.retrieve(financialAccountToken) -> LoanTapeConfiguration

InterestTierSchedule

Types:

Methods:

  • client.financialAccounts.interestTierSchedule.create(financialAccountToken, { ...params }) -> InterestTierSchedule
  • client.financialAccounts.interestTierSchedule.retrieve(effectiveDate, { ...params }) -> InterestTierSchedule
  • client.financialAccounts.interestTierSchedule.update(effectiveDate, { ...params }) -> InterestTierSchedule
  • client.financialAccounts.interestTierSchedule.list(financialAccountToken, { ...params }) -> InterestTierSchedulesSinglePage
  • client.financialAccounts.interestTierSchedule.delete(effectiveDate, { ...params }) -> void

Transactions

Types:

Methods:

EnhancedCommercialData

Types:

Methods:

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

Events

EnhancedCommercialData

Types:

Methods:

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

ResponderEndpoints

Types:

Methods:

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

Webhooks

Methods:

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

ExternalBankAccounts

Types:

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 }) -> ExternalBankAccount
  • client.externalBankAccounts.unpause(externalBankAccountToken) -> ExternalBankAccount

MicroDeposits

Types:

Methods:

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

Payments

Types:

Methods:

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

ThreeDS

Types:

Authentication

Types:

Methods:

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

Decisioning

Types:

Methods:

Reports

Types:

Settlement

Methods:

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

NetworkTotals

Methods:

  • client.reports.settlement.networkTotals.retrieve(token) -> NetworkTotal
  • client.reports.settlement.networkTotals.list({ ...params }) -> NetworkTotalsCursorPage

CardPrograms

Types:

Methods:

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

DigitalCardArt

Types:

Methods:

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

BookTransfers

Types:

Methods:

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

CreditProducts

ExtendedCredit

Types:

Methods:

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

PrimeRates

Types:

Methods:

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

ExternalPayments

Types:

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:

Methods:

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

InternalTransaction

Types:

FundingEvents

Types:

Methods:

  • client.fundingEvents.retrieve(fundingEventToken) -> FundingEvent
  • client.fundingEvents.list({ ...params }) -> FundingEventsCursorPage
  • client.fundingEvents.retrieveDetails(fundingEventToken) -> FundingEventRetrieveDetailsResponse

Fraud

Transactions

Types:

Methods:

  • client.fraud.transactions.retrieve(transactionToken) -> TransactionRetrieveResponse
  • client.fraud.transactions.report(transactionToken, { ...params }) -> TransactionReportResponse

NetworkPrograms

Types:

Methods:

  • client.networkPrograms.retrieve(networkProgramToken) -> NetworkProgram
  • client.networkPrograms.list({ ...params }) -> NetworkProgramsSinglePage

AccountActivity

Types:

Methods:

  • client.accountActivity.list({ ...params }) -> AccountActivityListResponsesCursorPage
  • client.accountActivity.retrieveTransaction(transactionToken) -> AccountActivityRetrieveTransactionResponse

TransferLimits

Types:

Methods:

  • client.transferLimits.list({ ...params }) -> TransferLimitsResponseDataSinglePage

Webhooks

Types:

Methods:

  • client.webhooks.parsed(body) -> void