List

List statements

get/v1/financial_accounts/{financial_account_token}/statements

List the statements for a given financial account.

Path Parameters

financial_account_tokenstring

Globally unique identifier for financial account.

formatuuid

Query Parameters

beginstring

optional

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

formatdate

endstring

optional

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

formatdate

ending_beforestring

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_statementsboolean

optional

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

page_sizenumber

optional

Page size (for pagination).

maximum100

minimum1

starting_afterstring

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.

Returns

Request example Request

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

200 Example

{
  "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,
        "fees": 0,
        "interest": 0,
        "payments": 0,
        "purchases": 0
      },
      "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,
        "fees": 0,
        "interest": 0,
        "payments": 0,
        "purchases": 0
      },
      "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"
    }
  ],
  "has_more": true
}