api.md

Shared Params Types

• shared.AddressParam
• shared.CarrierParam
• shared.ShippingAddressParam

Shared Response Types

• shared.Address

lithic

Response Types:

• lithic.APIStatus

Methods:

• client.APIStatus(ctx context.Context) (lithic.APIStatus, error)

Accounts

Response Types:

• lithic.Account
• lithic.AccountSpendLimits

Methods:

• client.Accounts.Get(ctx context.Context, accountToken string) (lithic.Account, error)
• client.Accounts.Update(ctx context.Context, accountToken string, body lithic.AccountUpdateParams) (lithic.Account, error)
• client.Accounts.List(ctx context.Context, query lithic.AccountListParams) (pagination.CursorPage[lithic.Account], error)
• client.Accounts.GetSpendLimits(ctx context.Context, accountToken string) (lithic.AccountSpendLimits, error)

AccountHolders

Params Types:

• lithic.KYBParam
• lithic.KYCParam
• lithic.KYCExemptParam

Response Types:

• lithic.AccountHolder
• lithic.AccountHolderDocument
• lithic.AccountHolderNewResponse
• lithic.AccountHolderUpdateResponse
• lithic.AccountHolderListDocumentsResponse

Methods:

• client.AccountHolders.New(ctx context.Context, body lithic.AccountHolderNewParams) (lithic.AccountHolderNewResponse, error)
• client.AccountHolders.Get(ctx context.Context, accountHolderToken string) (lithic.AccountHolder, error)
• client.AccountHolders.Update(ctx context.Context, accountHolderToken string, body lithic.AccountHolderUpdateParams) (lithic.AccountHolderUpdateResponse, error)
• client.AccountHolders.List(ctx context.Context, query lithic.AccountHolderListParams) (pagination.SinglePage[lithic.AccountHolder], error)
• client.AccountHolders.ListDocuments(ctx context.Context, accountHolderToken string) (lithic.AccountHolderListDocumentsResponse, error)
• client.AccountHolders.Resubmit(ctx context.Context, accountHolderToken string, body lithic.AccountHolderResubmitParams) (lithic.AccountHolder, error)
• client.AccountHolders.GetDocument(ctx context.Context, accountHolderToken string, documentToken string) (lithic.AccountHolderDocument, error)
• client.AccountHolders.UploadDocument(ctx context.Context, accountHolderToken string, body lithic.AccountHolderUploadDocumentParams) (lithic.AccountHolderDocument, error)

AuthRules

Response Types:

• lithic.AuthRule
• lithic.AuthRuleGetResponse
• lithic.AuthRuleRemoveResponse

Methods:

• client.AuthRules.New(ctx context.Context, body lithic.AuthRuleNewParams) (lithic.AuthRule, error)
• client.AuthRules.Get(ctx context.Context, authRuleToken string) (lithic.AuthRuleGetResponse, error)
• client.AuthRules.Update(ctx context.Context, authRuleToken string, body lithic.AuthRuleUpdateParams) (lithic.AuthRule, error)
• client.AuthRules.List(ctx context.Context, query lithic.AuthRuleListParams) (pagination.CursorPage[lithic.AuthRule], error)
• client.AuthRules.Apply(ctx context.Context, authRuleToken string, body lithic.AuthRuleApplyParams) (lithic.AuthRule, error)
• client.AuthRules.Remove(ctx context.Context, body lithic.AuthRuleRemoveParams) (lithic.AuthRuleRemoveResponse, error)

AuthStreamEnrollment

Response Types:

• lithic.AuthStreamSecret

Methods:

• client.AuthStreamEnrollment.GetSecret(ctx context.Context) (lithic.AuthStreamSecret, error)
• client.AuthStreamEnrollment.RotateSecret(ctx context.Context) error

TokenizationDecisioning

Response Types:

• lithic.TokenizationSecret
• lithic.TokenizationDecisioningRotateSecretResponse

Methods:

• client.TokenizationDecisioning.GetSecret(ctx context.Context) (lithic.TokenizationSecret, error)
• client.TokenizationDecisioning.RotateSecret(ctx context.Context) (lithic.TokenizationDecisioningRotateSecretResponse, error)

Tokenizations

Response Types:

• lithic.Tokenization
• lithic.TokenizationGetResponse
• lithic.TokenizationSimulateResponse
• lithic.TokenizationUpdateDigitalCardArtResponse

Methods:

• client.Tokenizations.Get(ctx context.Context, tokenizationToken string) (lithic.TokenizationGetResponse, error)
• client.Tokenizations.List(ctx context.Context, query lithic.TokenizationListParams) (pagination.CursorPage[lithic.Tokenization], error)
• client.Tokenizations.Activate(ctx context.Context, tokenizationToken string) error
• client.Tokenizations.Deactivate(ctx context.Context, tokenizationToken string) error
• client.Tokenizations.Pause(ctx context.Context, tokenizationToken string) error
• client.Tokenizations.ResendActivationCode(ctx context.Context, tokenizationToken string, body lithic.TokenizationResendActivationCodeParams) error
• client.Tokenizations.Simulate(ctx context.Context, body lithic.TokenizationSimulateParams) (lithic.TokenizationSimulateResponse, error)
• client.Tokenizations.Unpause(ctx context.Context, tokenizationToken string) error
• client.Tokenizations.UpdateDigitalCardArt(ctx context.Context, tokenizationToken string, body lithic.TokenizationUpdateDigitalCardArtParams) (lithic.TokenizationUpdateDigitalCardArtResponse, error)

Cards

Params Types:

• lithic.SpendLimitDuration

Response Types:

• lithic.Card
• lithic.CardSpendLimits
• lithic.SpendLimitDuration
• lithic.CardProvisionResponse

Methods:

• client.Cards.New(ctx context.Context, body lithic.CardNewParams) (lithic.Card, error)
• client.Cards.Get(ctx context.Context, cardToken string) (lithic.Card, error)
• client.Cards.Update(ctx context.Context, cardToken string, body lithic.CardUpdateParams) (lithic.Card, error)
• client.Cards.List(ctx context.Context, query lithic.CardListParams) (pagination.CursorPage[lithic.Card], error)
• client.Cards.Embed(ctx context.Context, query lithic.CardEmbedParams) (string, error)
• client.Cards.Provision(ctx context.Context, cardToken string, body lithic.CardProvisionParams) (lithic.CardProvisionResponse, error)
• client.Cards.Reissue(ctx context.Context, cardToken string, body lithic.CardReissueParams) (lithic.Card, error)
• client.Cards.Renew(ctx context.Context, cardToken string, body lithic.CardRenewParams) (lithic.Card, error)
• client.Cards.GetSpendLimits(ctx context.Context, cardToken string) (lithic.CardSpendLimits, error)
• client.Cards.SearchByPan(ctx context.Context, body lithic.CardSearchByPanParams) (lithic.Card, error)
• client.Cards.GetEmbedHTML(ctx context.Context, params lithic.CardGetEmbedHTMLParams) ([]byte, error)
• client.Cards.GetEmbedURL(ctx context.Context, params lithic.CardGetEmbedURLParams) (*url.URL, error)

AggregateBalances

Response Types:

• lithic.CardAggregateBalanceListResponse

Methods:

• client.Cards.AggregateBalances.List(ctx context.Context, query lithic.CardAggregateBalanceListParams) (pagination.SinglePage[lithic.CardAggregateBalanceListResponse], error)

Balances

Response Types:

• lithic.CardBalanceListResponse

Methods:

• client.Cards.Balances.List(ctx context.Context, cardToken string, query lithic.CardBalanceListParams) (pagination.SinglePage[lithic.CardBalanceListResponse], error)

FinancialTransactions

Methods:

• client.Cards.FinancialTransactions.Get(ctx context.Context, cardToken string, financialTransactionToken string) (lithic.FinancialTransaction, error)
• client.Cards.FinancialTransactions.List(ctx context.Context, cardToken string, query lithic.CardFinancialTransactionListParams) (pagination.SinglePage[lithic.FinancialTransaction], error)

Balances

Response Types:

• lithic.Balance

Methods:

• client.Balances.List(ctx context.Context, query lithic.BalanceListParams) (pagination.SinglePage[lithic.Balance], error)

AggregateBalances

Response Types:

• lithic.AggregateBalance

Methods:

• client.AggregateBalances.List(ctx context.Context, query lithic.AggregateBalanceListParams) (pagination.SinglePage[lithic.AggregateBalance], error)

Disputes

Response Types:

• lithic.Dispute
• lithic.DisputeEvidence

Methods:

• client.Disputes.New(ctx context.Context, body lithic.DisputeNewParams) (lithic.Dispute, error)
• client.Disputes.Get(ctx context.Context, disputeToken string) (lithic.Dispute, error)
• client.Disputes.Update(ctx context.Context, disputeToken string, body lithic.DisputeUpdateParams) (lithic.Dispute, error)
• client.Disputes.List(ctx context.Context, query lithic.DisputeListParams) (pagination.CursorPage[lithic.Dispute], error)
• client.Disputes.Delete(ctx context.Context, disputeToken string) (lithic.Dispute, error)
• client.Disputes.DeleteEvidence(ctx context.Context, disputeToken string, evidenceToken string) (lithic.DisputeEvidence, error)
• client.Disputes.InitiateEvidenceUpload(ctx context.Context, disputeToken string, body lithic.DisputeInitiateEvidenceUploadParams) (lithic.DisputeEvidence, error)
• client.Disputes.ListEvidences(ctx context.Context, disputeToken string, query lithic.DisputeListEvidencesParams) (pagination.CursorPage[lithic.DisputeEvidence], error)
• client.Disputes.GetEvidence(ctx context.Context, disputeToken string, evidenceToken string) (lithic.DisputeEvidence, error)
• client.Disputes.UploadEvidence(ctx context.Context, disputeToken string, file io.Reader, opts ...option.RequestOption) error

Events

Response Types:

• lithic.Event
• lithic.EventSubscription
• lithic.MessageAttempt

Methods:

• client.Events.Get(ctx context.Context, eventToken string) (lithic.Event, error)
• client.Events.List(ctx context.Context, query lithic.EventListParams) (pagination.CursorPage[lithic.Event], error)
• client.Events.ListAttempts(ctx context.Context, eventToken string, query lithic.EventListAttemptsParams) (pagination.CursorPage[lithic.MessageAttempt], error)

Subscriptions

Response Types:

• lithic.EventSubscriptionGetSecretResponse

Methods:

• client.Events.Subscriptions.New(ctx context.Context, body lithic.EventSubscriptionNewParams) (lithic.EventSubscription, error)
• client.Events.Subscriptions.Get(ctx context.Context, eventSubscriptionToken string) (lithic.EventSubscription, error)
• client.Events.Subscriptions.Update(ctx context.Context, eventSubscriptionToken string, body lithic.EventSubscriptionUpdateParams) (lithic.EventSubscription, error)
• client.Events.Subscriptions.List(ctx context.Context, query lithic.EventSubscriptionListParams) (pagination.CursorPage[lithic.EventSubscription], error)
• client.Events.Subscriptions.Delete(ctx context.Context, eventSubscriptionToken string) error
• client.Events.Subscriptions.ListAttempts(ctx context.Context, eventSubscriptionToken string, query lithic.EventSubscriptionListAttemptsParams) (pagination.CursorPage[lithic.MessageAttempt], error)
• client.Events.Subscriptions.Recover(ctx context.Context, eventSubscriptionToken string, body lithic.EventSubscriptionRecoverParams) error
• client.Events.Subscriptions.ReplayMissing(ctx context.Context, eventSubscriptionToken string, body lithic.EventSubscriptionReplayMissingParams) error
• client.Events.Subscriptions.GetSecret(ctx context.Context, eventSubscriptionToken string) (lithic.EventSubscriptionGetSecretResponse, error)
• client.Events.Subscriptions.RotateSecret(ctx context.Context, eventSubscriptionToken string) error
• client.Events.Subscriptions.SendSimulatedExample(ctx context.Context, eventSubscriptionToken string, body lithic.EventSubscriptionSendSimulatedExampleParams) error

Transfers

Response Types:

• lithic.Transfer

Methods:

• client.Transfers.New(ctx context.Context, body lithic.TransferNewParams) (lithic.Transfer, error)

FinancialAccounts

Response Types:

• lithic.FinancialAccount
• lithic.FinancialTransaction

Methods:

• client.FinancialAccounts.New(ctx context.Context, params lithic.FinancialAccountNewParams) (lithic.FinancialAccount, error)
• client.FinancialAccounts.Get(ctx context.Context, financialAccountToken string) (lithic.FinancialAccount, error)
• client.FinancialAccounts.Update(ctx context.Context, financialAccountToken string, body lithic.FinancialAccountUpdateParams) (lithic.FinancialAccount, error)
• client.FinancialAccounts.List(ctx context.Context, query lithic.FinancialAccountListParams) (pagination.SinglePage[lithic.FinancialAccount], error)

Balances

Response Types:

• lithic.FinancialAccountBalanceListResponse

Methods:

• client.FinancialAccounts.Balances.List(ctx context.Context, financialAccountToken string, query lithic.FinancialAccountBalanceListParams) (pagination.SinglePage[lithic.FinancialAccountBalanceListResponse], error)

FinancialTransactions

Methods:

• client.FinancialAccounts.FinancialTransactions.Get(ctx context.Context, financialAccountToken string, financialTransactionToken string) (lithic.FinancialTransaction, error)
• client.FinancialAccounts.FinancialTransactions.List(ctx context.Context, financialAccountToken string, query lithic.FinancialTransactionListParams) (pagination.SinglePage[lithic.FinancialTransaction], error)

CreditConfiguration

Response Types:

• lithic.FinancialAccountCreditConfig

Methods:

• client.FinancialAccounts.CreditConfiguration.Get(ctx context.Context, financialAccountToken string) (lithic.FinancialAccountCreditConfig, error)
• client.FinancialAccounts.CreditConfiguration.Update(ctx context.Context, financialAccountToken string, body lithic.FinancialAccountCreditConfigurationUpdateParams) (lithic.FinancialAccountCreditConfig, error)

Statements

Response Types:

• lithic.Statement
• lithic.Statements

Methods:

• client.FinancialAccounts.Statements.Get(ctx context.Context, financialAccountToken string, statementToken string) (lithic.Statement, error)
• client.FinancialAccounts.Statements.List(ctx context.Context, financialAccountToken string, query lithic.FinancialAccountStatementListParams) (pagination.CursorPage[lithic.Statement], error)

LineItems

Response Types:

• lithic.StatementLineItems
• lithic.FinancialAccountStatementLineItemListResponse

Methods:

• client.FinancialAccounts.Statements.LineItems.List(ctx context.Context, financialAccountToken string, statementToken string, query lithic.FinancialAccountStatementLineItemListParams) (pagination.CursorPage[lithic.FinancialAccountStatementLineItemListResponse], error)

Transactions

Response Types:

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

Methods:

• client.Transactions.Get(ctx context.Context, transactionToken string) (lithic.Transaction, error)
• client.Transactions.List(ctx context.Context, query lithic.TransactionListParams) (pagination.CursorPage[lithic.Transaction], error)
• client.Transactions.SimulateAuthorization(ctx context.Context, body lithic.TransactionSimulateAuthorizationParams) (lithic.TransactionSimulateAuthorizationResponse, error)
• client.Transactions.SimulateAuthorizationAdvice(ctx context.Context, body lithic.TransactionSimulateAuthorizationAdviceParams) (lithic.TransactionSimulateAuthorizationAdviceResponse, error)
• client.Transactions.SimulateClearing(ctx context.Context, body lithic.TransactionSimulateClearingParams) (lithic.TransactionSimulateClearingResponse, error)
• client.Transactions.SimulateCreditAuthorization(ctx context.Context, body lithic.TransactionSimulateCreditAuthorizationParams) (lithic.TransactionSimulateCreditAuthorizationResponse, error)
• client.Transactions.SimulateReturn(ctx context.Context, body lithic.TransactionSimulateReturnParams) (lithic.TransactionSimulateReturnResponse, error)
• client.Transactions.SimulateReturnReversal(ctx context.Context, body lithic.TransactionSimulateReturnReversalParams) (lithic.TransactionSimulateReturnReversalResponse, error)
• client.Transactions.SimulateVoid(ctx context.Context, body lithic.TransactionSimulateVoidParams) (lithic.TransactionSimulateVoidResponse, error)

EnhancedCommercialData

Response Types:

• lithic.TransactionEnhancedCommercialDataGetResponse

Methods:

• client.Transactions.EnhancedCommercialData.Get(ctx context.Context, transactionToken string) (lithic.TransactionEnhancedCommercialDataGetResponse, error)

Events

EnhancedCommercialData

Response Types:

• lithic.EnhancedData

Methods:

• client.Transactions.Events.EnhancedCommercialData.Get(ctx context.Context, eventToken string) (lithic.EnhancedData, error)

ResponderEndpoints

Response Types:

• lithic.ResponderEndpointStatus
• lithic.ResponderEndpointNewResponse

Methods:

• client.ResponderEndpoints.New(ctx context.Context, body lithic.ResponderEndpointNewParams) (lithic.ResponderEndpointNewResponse, error)
• client.ResponderEndpoints.Delete(ctx context.Context, body lithic.ResponderEndpointDeleteParams) error
• client.ResponderEndpoints.CheckStatus(ctx context.Context, query lithic.ResponderEndpointCheckStatusParams) (lithic.ResponderEndpointStatus, error)

Webhooks

Methods:

• client.Webhooks.VerifySignature(payload []byte, headers http.Header, secret string, now time.Time) error

ExternalBankAccounts

Params Types:

• lithic.ExternalBankAccountAddressParam
• lithic.OwnerType
• lithic.VerificationMethod

Response Types:

• lithic.ExternalBankAccountAddress
• lithic.OwnerType
• lithic.VerificationMethod
• lithic.ExternalBankAccountNewResponse
• lithic.ExternalBankAccountGetResponse
• lithic.ExternalBankAccountUpdateResponse
• lithic.ExternalBankAccountListResponse
• lithic.ExternalBankAccountRetryMicroDepositsResponse
• lithic.ExternalBankAccountRetryPrenoteResponse

Methods:

• client.ExternalBankAccounts.New(ctx context.Context, body lithic.ExternalBankAccountNewParams) (lithic.ExternalBankAccountNewResponse, error)
• client.ExternalBankAccounts.Get(ctx context.Context, externalBankAccountToken string) (lithic.ExternalBankAccountGetResponse, error)
• client.ExternalBankAccounts.Update(ctx context.Context, externalBankAccountToken string, body lithic.ExternalBankAccountUpdateParams) (lithic.ExternalBankAccountUpdateResponse, error)
• client.ExternalBankAccounts.List(ctx context.Context, query lithic.ExternalBankAccountListParams) (pagination.CursorPage[lithic.ExternalBankAccountListResponse], error)
• client.ExternalBankAccounts.RetryMicroDeposits(ctx context.Context, externalBankAccountToken string, body lithic.ExternalBankAccountRetryMicroDepositsParams) (lithic.ExternalBankAccountRetryMicroDepositsResponse, error)
• client.ExternalBankAccounts.RetryPrenote(ctx context.Context, externalBankAccountToken string, body lithic.ExternalBankAccountRetryPrenoteParams) (lithic.ExternalBankAccountRetryPrenoteResponse, error)

MicroDeposits

Response Types:

• lithic.ExternalBankAccountMicroDepositNewResponse

Methods:

• client.ExternalBankAccounts.MicroDeposits.New(ctx context.Context, externalBankAccountToken string, body lithic.ExternalBankAccountMicroDepositNewParams) (lithic.ExternalBankAccountMicroDepositNewResponse, error)

Payments

Response Types:

• lithic.Payment
• lithic.PaymentNewResponse
• lithic.PaymentRetryResponse
• lithic.PaymentSimulateActionResponse
• lithic.PaymentSimulateReceiptResponse
• lithic.PaymentSimulateReleaseResponse
• lithic.PaymentSimulateReturnResponse

Methods:

• client.Payments.New(ctx context.Context, body lithic.PaymentNewParams) (lithic.PaymentNewResponse, error)
• client.Payments.Get(ctx context.Context, paymentToken string) (lithic.Payment, error)
• client.Payments.List(ctx context.Context, query lithic.PaymentListParams) (pagination.CursorPage[lithic.Payment], error)
• client.Payments.Retry(ctx context.Context, paymentToken string) (lithic.PaymentRetryResponse, error)
• client.Payments.SimulateAction(ctx context.Context, paymentToken string, body lithic.PaymentSimulateActionParams) (lithic.PaymentSimulateActionResponse, error)
• client.Payments.SimulateReceipt(ctx context.Context, body lithic.PaymentSimulateReceiptParams) (lithic.PaymentSimulateReceiptResponse, error)
• client.Payments.SimulateRelease(ctx context.Context, body lithic.PaymentSimulateReleaseParams) (lithic.PaymentSimulateReleaseResponse, error)
• client.Payments.SimulateReturn(ctx context.Context, body lithic.PaymentSimulateReturnParams) (lithic.PaymentSimulateReturnResponse, error)

ThreeDS

Authentication

Response Types:

• lithic.ThreeDSAuthenticationGetResponse
• lithic.ThreeDSAuthenticationSimulateResponse

Methods:

• client.ThreeDS.Authentication.Get(ctx context.Context, threeDSAuthenticationToken string) (lithic.ThreeDSAuthenticationGetResponse, error)
• client.ThreeDS.Authentication.Simulate(ctx context.Context, body lithic.ThreeDSAuthenticationSimulateParams) (lithic.ThreeDSAuthenticationSimulateResponse, error)

Decisioning

Response Types:

• lithic.ThreeDSDecisioningGetSecretResponse

Methods:

• client.ThreeDS.Decisioning.GetSecret(ctx context.Context) (lithic.ThreeDSDecisioningGetSecretResponse, error)
• client.ThreeDS.Decisioning.RotateSecret(ctx context.Context) error

Reports

Response Types:

• lithic.SettlementDetail
• lithic.SettlementReport
• lithic.SettlementSummaryDetails

Settlement

Methods:

• client.Reports.Settlement.ListDetails(ctx context.Context, reportDate time.Time, query lithic.ReportSettlementListDetailsParams) (pagination.CursorPage[lithic.SettlementDetail], error)
• client.Reports.Settlement.Summary(ctx context.Context, reportDate time.Time) (lithic.SettlementReport, error)

CardPrograms

Response Types:

• lithic.CardProgram

Methods:

• client.CardPrograms.Get(ctx context.Context, cardProgramToken string) (lithic.CardProgram, error)
• client.CardPrograms.List(ctx context.Context, query lithic.CardProgramListParams) (pagination.CursorPage[lithic.CardProgram], error)

DigitalCardArt

Response Types:

• lithic.DigitalCardArt

Methods:

• client.DigitalCardArt.Get(ctx context.Context, digitalCardArtToken string) (lithic.DigitalCardArt, error)
• client.DigitalCardArt.List(ctx context.Context, query lithic.DigitalCardArtListParams) (pagination.CursorPage[lithic.DigitalCardArt], error)

BookTransfers

Response Types:

• lithic.BookTransferResponse

Methods:

• client.BookTransfers.New(ctx context.Context, body lithic.BookTransferNewParams) (lithic.BookTransferResponse, error)
• client.BookTransfers.Get(ctx context.Context, bookTransferToken string) (lithic.BookTransferResponse, error)
• client.BookTransfers.List(ctx context.Context, query lithic.BookTransferListParams) (pagination.CursorPage[lithic.BookTransferResponse], error)
• client.BookTransfers.Reverse(ctx context.Context, bookTransferToken string, body lithic.BookTransferReverseParams) (lithic.BookTransferResponse, error)