LogoLithic API Documentation

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

Register Account Number ->
post/v1/financial_accounts/{financial_account_token}/register_account_number

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.

path Parameters
financial_account_token: string
(format: uuid)
query Parameters
begin: string
Optional
(format: date-time)

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

category:
Optional

Financial Transaction category to be returned.

"ACH"
"CARD"
"INTERNAL"
"TRANSFER"
end: string
Optional
(format: date-time)

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

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.

result:
Optional

Financial Transaction result to be returned.

"APPROVED"
"DECLINED"
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.

status:
Optional

Financial Transaction status to be returned.

"DECLINED"
"EXPIRED"
"PENDING"
"RETURNED"
"SETTLED"
"VOIDED"
Response fields
data: Array<
FinancialTransaction
>
has_more: boolean

More data exists.

Request example
200Example
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 AccountsStatements

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 }