Credit Statements
Learn how to retrieve data to generate statements for your credit programs
Lithic's Statements API provides the data needed for customers to generate statements for their business clients. The API includes both Summary data such as total amount due and detailed Line Item data on which transactions were included in the statement.
Statement Summary Schema
{
"ach_period_total": Integer,
"ach_ytd_total": Integer,
"adjustments_period_total": Integer,
"adjustments_ytd_total": Integer,
"amount_due": Integer,
"available_credit": Integer,
"created": String,
"credit_limit": Integer,
"days_in_billing_cycle": Integer,
"ending_balance": Integer,
"financial_account_token": String,
"payment_due_date": String,
"purchases_period_total": Integer,
"purchases_ytd_total": Integer,
"starting_balance": Integer,
"statement_start_date": String,
"statement_end_date": String,
"token": String,
"updated": String
}
ach_period_total | Total payments during this billing period |
ach_ytd_total | Total payments year-to-date |
adjustments_period_total | Total adjustments (e.g., late fees) during this billing period |
adjustments_ytd_total | Total adjustments year-to-date |
amount_due | Payment due at the end of the billing period. Negative amount indicates the account holder owes payment. Positive amount indicates a net credit and funds should be returned the account holder via ACH |
available_credit | Remaining amount of credit that the account holder can still spend |
created | Date and time for when the statement was generated |
credit_limit | Maximum amount that the account holder can spend. Set by the program |
days_in_billing_cycle | Number of days in the billing cycle |
ending_balance | Balance at the end of the billing period. For charge cards, the ending_balance should be the same as the amount_due |
financial_account_token | Globally unique identifier for a financial account |
payment_due_date | Date of when payment is due |
purchases_period_total | Total settled card transactions during this billing period |
purchases_ytd_total | Total settled card transactions year-to-date |
starting_balance | Balance at the start of the billing period |
statement_end_date | Date of when the billing period ended |
statement_start_date | Date of when the billing period began |
token | Globally unique identifier for a statement |
updated | Date and time for when the statement was updated |
Statement Line Item Schema
{
"amount": String,
"card_token": String,
"category": String,
"created": String,
"currency": String,
"descriptor": String,
"event_type": String,
"financial_account_token": String,
"financial_transaction_token": String,
"settled_date": String,
"token": String
}
amount | Amount of the line item in the currency’s smallest unit (e.g., cents for USD) |
card_token | Globally unique identifier for the card used in the transaction. Will be null if the transaction was of category ACH or TRANSFER |
category | CARD , ACH , TRANSFER |
created | Date and time for when the line item was created |
currency | 3-digit alphabetic ISO 4217 code for the settling currency of the transaction |
descriptor | A string that provides a description of the financial transaction to display to users |
event_type | AUTHORIZATION , CREDIT_AUTHORIZATION , AUTHORIZATION_ADVICE , FINANCIAL_AUTHORIZATION , FINANCIAL_CREDIT_AUTHORIZATION , AUTHORIZATION_REVERSAL , CREDIT_AUTHORIZATION_ADVICE , AUTHORIZATION_EXPIRY , CLEARING , BALANCE_INQUIRY , RETURN , RETURN_REVERSAL , CORRECTION_DEBIT , CORRECTION_CREDIT , ACH_RECEIPT , ACH_ORIGINATION_PENDING , ACH_ORIGINATION_PROCESSED , ACH_ORIGINATION_RELEASED , ACH_RETURN_PENDING , ACH_RETURN , ACH_INSUFFICIENT_FUNDS , TRANSFER , TRANSFER_INSUFFICIENT_FUNDS |
financial_account_token | Globally unique identifier for the financial account that this transaction posted to |
financial_transaction_token | Globally unique identifier for a financial transaction |
settled_date | Date that the transaction settled |
token | Globally unique identifier for the line item |
API Endpoints
Lithic supports the following endpoint to retrieve data on Statement Summaries and Statement Line Items:
- LIST Statements: retrieve multiple statement summaries for a given
financial_account_token
- GET Statement: retrieve a single statement summary for a given
statement_token
- LIST Line items: retrieve the line items for a given
statement_token
Updated 8 months ago