Lithic API Documentation | Financial Accounts › Statements

Financial Accounts

financial_accounts

Methods

List Financial Accounts -> SinglePage<

FinancialAccount

get/v1/financial_accounts

Retrieve information on your financial accounts including routing and account number.

Get Financial Account ->

FinancialAccount

get/v1/financial_accounts/{financial_account_token}

Get a financial account

Update Financial Account ->

FinancialAccount

patch/v1/financial_accounts/{financial_account_token}

Update a financial account

Update Financial Account Status ->

FinancialAccount

post/v1/financial_accounts/{financial_account_token}/update_status

Update financial account status

Create Financial Account ->

FinancialAccount

post/v1/financial_accounts

Create a new financial account

post/v1/financial_accounts/{financial_account_token}/register_account_number

Domain types

CategoryDetails = { balance_transfers, cash_advances, purchases }

FinancialAccount = { token, account_token, created, 9 more... }

FinancialAccountBalance = { token, available_amount, created, 7 more... }

Balance of a Financial Account

FinancialTransaction = { token, category, created, 8 more... }

StatementTotals = { balance_transfers, cash_advances, credits, 8 more... }

Financial Accounts

Balances

financial_accounts.balances

Methods

Get Balances -> SinglePage<

FinancialAccountBalance

get/v1/financial_accounts/{financial_account_token}/balances

Get the balances for a given financial account.

Financial Accounts

Credit Configuration

financial_accounts.credit_configuration

Methods

Get Account Credit Configuration ->

FinancialAccountCreditConfig

get/v1/financial_accounts/{financial_account_token}/credit_configuration

Get an Account's credit configuration

Update Account Credit Configuration ->

FinancialAccountCreditConfig

patch/v1/financial_accounts/{financial_account_token}/credit_configuration

Update an account's credit configuration

Domain types

FinancialAccountCreditConfig = { account_token, auto_collection_configuration, credit_limit, 3 more... }

Financial Accounts

Financial Transactions

financial_accounts.financial_transactions

Methods

List Financial Transactions -> SinglePage<

FinancialTransaction

get/v1/financial_accounts/{financial_account_token}/financial_transactions

List the financial transactions for a given financial account.

Get Financial Transaction ->

FinancialTransaction

get/v1/financial_accounts/{financial_account_token}/financial_transactions/{financial_transaction_token}

Get the financial transaction for the provided token.

Financial Accounts

Loan Tapes

financial_accounts.loan_tapes

Methods

List Loan Tapes -> CursorPage<

LoanTape

get/v1/financial_accounts/{financial_account_token}/loan_tapes

List the loan tapes for a given financial account.

Get Loan Tape By Token ->

LoanTape

get/v1/financial_accounts/{financial_account_token}/loan_tapes/{loan_tape_token}

Get a specific loan tape for a given financial account.

Domain types

CategoryBalances = { fees, interest, principal }

LoanTape = { token, account_standing, available_credit, 19 more... }

Financial Accounts

Statements

financial_accounts.statements

Methods

List Statements -> CursorPage<

Statement

get/v1/financial_accounts/{financial_account_token}/statements

List the statements for a given financial account.

path Parameters

financial_account_token: string

(format: uuid)

Globally unique identifier for financial account.

query Parameters

begin: string

Optional

(format: date)

Date string in RFC 3339 format. Only entries created after the specified date will be included.

end: string

Optional

(format: date)

Date string in RFC 3339 format. Only entries created before the specified date will be included.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

include_initial_statements: boolean

Optional

Whether to include the initial statement. It is not included by default.

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response fields

Statements

Request example

curl https://api.lithic.com/v1/financial_accounts/$FINANCIAL_ACCOUNT_TOKEN/statements \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "token",
      "account_standing": {
        "consecutive_full_payments_made": 0,
        "consecutive_minimum_payments_made": 0,
        "consecutive_minimum_payments_missed": 0,
        "days_past_due": 0,
        "financial_account_state": {
          "status": "OPEN",
          "substatus": "CHARGED_OFF_DELINQUENT"
        },
        "has_grace": true,
        "period_number": 0,
        "period_state": "STANDARD"
      },
      "amount_due": {
        "amount": 0,
        "past_due": 0
      },
      "available_credit": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "credit_limit": 0,
      "credit_product_token": "credit_product_token",
      "days_in_billing_cycle": 0,
      "ending_balance": 0,
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "payment_due_date": "2019-12-27",
      "period_totals": {
        "balance_transfers": 0,
        "cash_advances": 0,
        "credits": 0,
        "debits": 0,
        "fees": 0,
        "interest": 0,
        "payments": 0,
        "purchases": 0,
        "credit_details": {},
        "debit_details": {},
        "payment_details": {}
      },
      "starting_balance": 0,
      "statement_end_date": "2019-12-27",
      "statement_start_date": "2019-12-27",
      "statement_type": "INITIAL",
      "updated": "2019-12-27T18:11:19.117Z",
      "ytd_totals": {
        "balance_transfers": 0,
        "cash_advances": 0,
        "credits": 0,
        "debits": 0,
        "fees": 0,
        "interest": 0,
        "payments": 0,
        "purchases": 0,
        "credit_details": {},
        "debit_details": {},
        "payment_details": {}
      },
      "interest_details": {
        "actual_interest_charged": 0,
        "daily_balance_amounts": {
          "balance_transfers": "balance_transfers",
          "cash_advances": "cash_advances",
          "purchases": "purchases"
        },
        "effective_apr": {
          "balance_transfers": "balance_transfers",
          "cash_advances": "cash_advances",
          "purchases": "purchases"
        },
        "interest_calculation_method": "DAILY",
        "interest_for_period": {
          "balance_transfers": "balance_transfers",
          "cash_advances": "cash_advances",
          "purchases": "purchases"
        },
        "prime_rate": "prime_rate",
        "minimum_interest_charged": 0
      },
      "next_payment_due_date": "2019-12-27",
      "next_statement_end_date": "2019-12-27",
      "payoff_details": {
        "minimum_payment_months": "minimum_payment_months",
        "minimum_payment_total": "minimum_payment_total",
        "payoff_period_length_months": 0,
        "payoff_period_monthly_payment_amount": 0,
        "payoff_period_payment_total": 0
      }
    }
  ],
  "has_more": true
}

Get Statement By Token ->

Statement

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

Get a specific statement for a given financial account.

Domain types

Statement = { token, account_standing, amount_due, 19 more... }

Statements = { data, has_more }

Financial Accounts Statements

Line Items

financial_accounts.statements.line_items

Methods

List Line Items For A Statement -> CursorPage<{ token, amount, category, 9 more... }>

get/v1/financial_accounts/{financial_account_token}/statements/{statement_token}/line_items

List the line items for a given statement within a given financial account.

Domain types

StatementLineItems = { data, has_more }