Financial Accounts
Financial Accounts
Financial Accounts
financial_accountsUpdate financial account
Update a financial account
List financial accounts
Retrieve information on your financial accounts including routing and account number.
Register Account Number
Register account number
Update financial account status
Update financial account status
Financial Account
ShowShow
Globally unique identifier for the account
Hide ParametersShow Parameters
Reason for the financial account being marked as Charged Off
Hide ParametersShow Parameters
Globally unique identifier for the credit product
State of the financial account
Hide ParametersShow Parameters
Tier assigned to the financial account
Whether financial account is for the benefit of another entity
Status of the financial account
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Substatus for the financial account
Hide ParametersShow Parameters
Financial Transaction
ShowShow
Globally unique identifier.
Status types:
CARD
- Issuing card transaction.ACH
- Transaction over ACH.INTERNAL
- Transaction for internal adjustment.TRANSFER
- Internal transfer of funds between financial accounts in your program.
Hide ParametersShow Parameters
Date and time when the financial transaction first occurred. UTC time zone.
3-character alphabetic ISO 4217 code for the settling currency of the transaction.
A string that provides a description of the financial transaction; may be useful to display to users.
A list of all financial events that have modified this financial transaction.
Hide ParametersShow Parameters
Globally unique identifier.
Amount of the financial event that has been settled in the currency's smallest unit (e.g., cents).
Date and time when the financial event occurred. UTC time zone.
APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.
APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
Hide ParametersShow Parameters
Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. This may change over time.
Status types:
DECLINED
- The transaction was declined.EXPIRED
- The authorization as it has passed its expiration time. Card transaction only.PENDING
- The transaction is expected to settle.RETURNED
- The transaction has been returned.SETTLED
- The transaction is completed.VOIDED
- The transaction was voided. Card transaction only.
Hide ParametersShow Parameters
Date and time when the financial transaction was last updated. UTC time zone.
Financial AccountsBalances
financial_accounts.balancesGet balances
Get the balances for a given financial account.
Financial AccountsCredit Configuration
financial_accounts.credit_configurationGet account credit configuration
Get an Account's credit configuration
Update account credit configuration
Update an account's credit configuration
Financial Account Credit Config
ShowShow
Globally unique identifier for the account
Reason for the financial account being marked as Charged Off
Hide ParametersShow Parameters
Globally unique identifier for the credit product
State of the financial account
Hide ParametersShow Parameters
Tier assigned to the financial account
Financial AccountsFinancial Transactions
financial_accounts.financial_transactionsGet financial transaction
Get the financial transaction for the provided token.
List financial transactions
List the financial transactions for a given financial account.
Financial AccountsLoan Tapes
financial_accounts.loan_tapesGet loan tape by token
Get a specific loan tape for a given financial account.
List loan tapes
List the loan tapes for a given financial account.
Loan Tape
ShowShow
Globally unique identifier for a loan tape
Hide ParametersShow Parameters
Number of consecutive full payments made
Number of consecutive minimum payments made
Number of consecutive minimum payments missed
Number of days past due
Information about the financial account state
Hide ParametersShow Parameters
Status of the financial account
Hide ParametersShow Parameters
Substatus for the financial account
Hide ParametersShow Parameters
Whether the account currently has grace or not
Current overall period number
Hide ParametersShow Parameters
Amount of credit available to spend in cents
Hide ParametersShow Parameters
Amount due for the prior billing cycle. Any amounts not fully paid off on this due date will be considered past due the next day
Hide ParametersShow Parameters
Amount due for the current billing cycle. Any amounts not paid off by early payments or credits will be considered due at the end of the current billing period
Hide ParametersShow Parameters
Amount not paid off on previous due dates
Hide ParametersShow Parameters
Amount due for the past billing cycles.
Hide ParametersShow Parameters
Timestamp of when the loan tape was created
For prepay accounts, this is the minimum prepay balance that must be maintained. For charge card accounts, this is the maximum credit balance extended by a lender
Globally unique identifier for a credit product
Date of transactions that this loan tape covers
Hide ParametersShow Parameters
Opening balance transferred from previous account in cents
ATM and cashback transactions in cents
Volume of credit management operation transactions less any balance transfers in cents
Volume of debit management operation transactions less any interest in cents
Interest accrued in cents
Any funds transfers which affective the balance in cents
Net card transaction volume less any cash advances in cents
Balance at the end of the day
Excess credits in the form of provisional credits, payments, or purchase refunds. If positive, the account is in net credit state with no outstanding balances. An overpayment could land an account in this state
Globally unique identifier for a financial account
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Opening balance transferred from previous account in cents
ATM and cashback transactions in cents
Volume of credit management operation transactions less any balance transfers in cents
Volume of debit management operation transactions less any interest in cents
Interest accrued in cents
Any funds transfers which affective the balance in cents
Net card transaction volume less any cash advances in cents
Hide ParametersShow Parameters
Balance at the start of the day
Timestamp of when the loan tape was updated
Version number of the loan tape. This starts at 1
Hide ParametersShow Parameters
Opening balance transferred from previous account in cents
ATM and cashback transactions in cents
Volume of credit management operation transactions less any balance transfers in cents
Volume of debit management operation transactions less any interest in cents
Interest accrued in cents
Any funds transfers which affective the balance in cents
Net card transaction volume less any cash advances in cents
Interest tier to which this account belongs to
Financial AccountsStatements
financial_accounts.statementsGet statement by token
Get a specific statement for a given financial account.
List statements
List the statements for a given financial account.
Statement
ShowShow
Globally unique identifier for a statement
Hide ParametersShow Parameters
Number of consecutive full payments made
Number of consecutive minimum payments made
Number of consecutive minimum payments missed
Number of days past due
Information about the financial account state
Hide ParametersShow Parameters
Status of the financial account
Hide ParametersShow Parameters
Substatus for the financial account
Hide ParametersShow Parameters
Whether the account currently has grace or not
Current overall period number
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Payment due at the end of the billing period in cents. Negative amount indicates something is owed. If the amount owed is positive there was a net credit. If auto-collections are enabled this is the amount that will be requested on the payment due date
Amount past due for statement in cents
Amount of credit available to spend in cents
Timestamp of when the statement was created
This is the maximum credit balance extended by the lender in cents
Globally unique identifier for a credit product
Number of days in the billing cycle
Balance at the end of the billing period. For charge cards, this should be the same at the statement amount due in cents
Globally unique identifier for a financial account
Date when the payment is due
Hide ParametersShow Parameters
Opening balance transferred from previous account in cents
ATM and cashback transactions in cents
Volume of credit management operation transactions less any balance transfers in cents
Volume of debit management operation transactions less any interest in cents
Interest accrued in cents
Any funds transfers which affective the balance in cents
Net card transaction volume less any cash advances in cents
Balance at the start of the billing period
Date when the billing period ended
Date when the billing period began
Hide ParametersShow Parameters
Timestamp of when the statement was updated
Hide ParametersShow Parameters
Opening balance transferred from previous account in cents
ATM and cashback transactions in cents
Volume of credit management operation transactions less any balance transfers in cents
Volume of debit management operation transactions less any interest in cents
Interest accrued in cents
Any funds transfers which affective the balance in cents
Net card transaction volume less any cash advances in cents
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Date when the next payment is due
Date when the next billing period will end
Statements
ShowShow
Financial AccountsStatementsLine Items
financial_accounts.statements.line_itemsList line items for a statement
List the line items for a given statement within a given financial account.
Statement Line Items
ShowShow
Hide ParametersShow Parameters
Globally unique identifier for a Statement Line Item
Transaction amount in cents
Hide ParametersShow Parameters
Timestamp of when the line item was generated
3-character alphabetic ISO 4217 code for the settling currency of the transaction
Date that the transaction effected the account balance
Hide ParametersShow Parameters
Globally unique identifier for a financial account
Globally unique identifier for a financial transaction event
Globally unique identifier for a financial transaction
Globally unique identifier for a card