Credit Statements

Learn how to retrieve data to generate statements for your credit programs

Lithic's Statements API provides a comprehensive, compliant infrastructure for credit product statement generation that directly supports Regulation Z (Truth in Lending Act) requirements.

The API automatically calculates and exposes all mandated disclosures including:

  • Payment Allocation across principal/interest/fees
  • Detailed APR breakdowns by transaction category
  • Critical Payoff Disclosure information
  • Granular transaction categorization
  • Interest calculation methodology
  • Account standing metrics like days past due, consecutive payment tracking, and grace period status

API Schema Guide

GET /v1/financial_accounts/{financial_account_token}/statements/{statement_token}

Retrieves a single statement for a financial account. Returns detailed billing period data including balances, transaction totals, account standing, interest details, payoff projections, and payment information.


Core Identifiers

AttributeTypeRequiredDescription
tokenstringYesGlobally unique identifier for the statement
financial_account_tokenUUIDYesGlobally unique identifier for the financial account
credit_product_tokenstringYesGlobally unique identifier for the credit product

Timestamps

AttributeTypeRequiredDescription
createddate-timeYesWhen the statement was created
updateddate-timeYesWhen the statement was last updated

Statement Period

AttributeTypeRequiredDescription
statement_start_datedateYesWhen the billing period began
statement_end_datedateYesWhen the billing period ended
days_in_billing_cycleintegerYesNumber of days in the billing cycle
statement_typeenumYesType of statement: INITIAL, PERIOD_END, or FINAL

Payment Information

AttributeTypeRequiredDescription
payment_due_datedateNoWhen payment for this statement is due
next_payment_due_datedateNoWhen the next payment is due
next_statement_end_datedateNoWhen the next billing period will end

Amount Due

amount_due (object, required)

AttributeTypeDescription
amountintegerPayment due at end of billing period in cents. Negative = owed. Positive = net credit. This is the auto-collection amount if enabled
past_dueintegerAmount past due in cents

Balances

AttributeTypeRequiredDescription
starting_balanceintegerYesBalance at the start of the billing period in cents
ending_balanceintegerYesBalance at the end of the billing period in cents. For charge cards, equals statement amount due
available_creditintegerYesAmount of credit available to spend in cents
credit_limitintegerYesMaximum credit balance extended by the lender in cents

Account Standing

account_standing (object, required)

AttributeTypeDescription
consecutive_full_payments_madeintegerNumber of consecutive full payments made
consecutive_minimum_payments_madeintegerNumber of consecutive minimum payments made
consecutive_minimum_payments_missedintegerNumber of consecutive minimum payments missed
days_past_dueintegerNumber of days past due
has_gracebooleanWhether the account currently has grace
period_numberintegerCurrent overall period number
period_stateenumSTANDARD, PROMO, or PENALTY

Financial Account State

Nested under account_standing.financial_account_state (object).

AttributeTypeRequiredDescription
statusenumYesOPEN, CLOSED, PENDING, or SUSPENDED
substatusenumNoDELINQUENT, CHARGED_OFF_DELINQUENT, CHARGED_OFF_FRAUD, BANK_REQUEST, or END_USER_REQUEST

Transaction Totals (Period) — Enhanced

period_totals (object, required) — Transaction totals for this billing period. All values in cents.

AttributeTypeDescription
purchasesintegerNet card transaction volume less cash advances
cash_advancesintegerATM and cashback transactions
balance_transfersintegerOpening balance transferred from previous account
paymentsintegerFunds transfers affecting the balance
creditsintegerCredit management operations less balance transfers
feesintegerVolume of debit transactions on the financial_account. Redundant with debits
interestintegerInterest accrued
debitsintegerNew. Volume of debit transactions on the financial_account. Redundant with fees
credit_detailsobjectNew. Breakdown of credits by category
debit_detailsobjectNew. Breakdown of debits by category
payment_detailsobjectNew. Breakdown of payments by category

Transaction Totals (Year-to-Date) — Enhanced

ytd_totals (object, required) — Same enhanced structure as period_totals, but aggregated for the entire year.

Interest Details

interest_details (object, optional) — Interest calculation information.

AttributeTypeRequiredDescription
interest_calculation_methodenumYesDAILY or AVERAGE_DAILY
prime_ratestringNoPrime rate used for calculations
actual_interest_chargedintegerNoActual interest charged in cents
minimum_interest_chargedintegerNoMinimum interest charged in cents

Daily Balance Amounts

Nested under interest_details.daily_balance_amounts (object).

AttributeTypeDescription
purchasesstringDaily balance for purchases
cash_advancesstringDaily balance for cash advances
balance_transfersstringDaily balance for balance transfers

Effective APR

Nested under interest_details.effective_apr (object).

AttributeTypeDescription
purchasesstringAPR for purchases
cash_advancesstringAPR for cash advances
balance_transfersstringAPR for balance transfers

Interest for Period

Nested under interest_details.interest_for_period (object).

AttributeTypeDescription
purchasesstringInterest accrued on purchases
cash_advancesstringInterest accrued on cash advances
balance_transfersstringInterest accrued on balance transfers

Payoff Details (New)

payoff_details (object, optional) — Projections for paying off the current balance.

AttributeTypeDescription
minimum_payment_monthsstringMonths to pay off balance with minimum payments only. "NA" indicates negative or zero amortization
minimum_payment_totalstringTotal interest + principal when paying minimum only. "NA" indicates negative or zero amortization
payoff_period_length_monthsintegerNumber of months to full payoff
payoff_period_monthly_payment_amountintegerAmount needed monthly (in cents) to achieve payoff