Lithic API Documentation | Financial Accounts › Balances

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.

path Parameters

financial_account_token: string

(format: uuid)

query Parameters

balance_date: string

Optional

(format: date-time)

UTC date of the balance to retrieve. Defaults to latest available balance

last_transaction_event_token: string

Optional

(format: uuid)

Balance after a given financial event occured. For example, passing the event_token of a $5 CARD_CLEARING financial event will return a balance decreased by $5

Response fields

data: Array<

FinancialAccountBalance

has_more: boolean

More data exists.

Request example

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

200Example

{
  "data": [
    {
      "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "available_amount": 0,
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "last_transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "last_transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 0,
      "total_amount": 0,
      "type": "ISSUING",
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}

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.

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 }