Developers
API reference

Cards

get/v1/cards

List credit cards with their statements and due dates

cards.listread tokenidempotent

Every open credit card in the ledger: what it owes, its limit and purchase APR, the latest statement and its minimum payment, and when the next payment is due. A due date the bank has not renewed yet is carried forward a month and says so in due_date_source. Closed cards are left out.

Parameters

limit
integer · query
Page size, 1–200.
cursor
string | null · query
The next_cursor of the previous page.
X-Organization-Id
string | null · header

Returns 200 · CardList

data
array of Card · required
has_more
boolean · required
next_cursor
string | null · required
Example
curl -X GET "https://api.lumaledger.app/v1/cards" \
  -H "Authorization: Bearer $LUMALEDGER_TOKEN"

Objects

Card

An open credit card, with what its bank says about the statement.

Fields

available
Money | null · required
Available credit, as the bank last reported it.
balance
Money · required
What is owed on the card, positive; negative when the issuer owes you. From the ledger, so it includes pending charges the bank's balance leaves out.
bank_due_date
date | null · required
The due date the bank last gave.
details_frozen_since
datetime | null · required
Since when the statement fields above have not been updated (the bank's card details keep failing, or its connection stopped syncing; plaid_items.list says which). Null while they are current.
due_date_source
string | null · required
bank when the bank gave next_payment_due_date; projected when the bank's last date (bank_due_date) has passed with no newer one, so this is the same day of the month carried forward (card payments fall on the same day every month).
id
integer · required
The card's account id, as accounts.list reports it.
institution_name
string | null · required
The issuer, as the ledger names it.
is_overdue
boolean | null · required
The bank's own overdue flag.
last_payment
Money | null · required
The last payment the bank recorded.
last_payment_date
date | null
limit
Money | null · required
The credit limit, when the bank reports one.
mask
string | null · required
The last digits of the card number (4721).
minimum_payment
Money | null · required
The minimum the latest statement asked for, due on bank_due_date.
name
string · required
next_payment_due_date
date | null · required
The next day a payment is due. The bank's own date stays for a day after it passes (it is still that day somewhere), then the next one is projected. Null when the bank expects no payment.
purchase_apr
string | null · required
The purchase APR in percent, as a decimal string ("23.24").
statement_balance
Money | null · required
The latest statement's balance: the cycle due on bank_due_date.
statement_issued_on
date | null · required
The day the latest statement closed.
statement_paid
Money | null · required
Payments and credits posted to the card since the statement closed, through its due date.
statement_remaining
Money | null · required
What is left of statement_balance: pay this by bank_due_date to avoid interest. Zero once it is paid in full.
statement_status
string | null · required
How much of the latest statement is paid, from the payments and credits the ledger holds since it closed (through bank_due_date and a day's grace): paid_in_full (no interest on it), unpaid (some still owed, its due date ahead) or carried (its due date passed with some unpaid, so the issuer charges interest). Null when there is nothing to judge: no balance owed, no closing date from the bank, or a due date more than a month gone.

CardList

A page of credit cards, in chart-of-accounts order.

Fields

data
array of Card · required
has_more
boolean · required
next_cursor
string | null · required

Money

An amount and its currency. `amount` is a base-10 string with two decimal places and an optional leading minus sign. Parse it with a decimal type, not a float.

Fields

amount
string · required
Pattern: ^-?\d+\.\d{2}$.
currency
string · required
ISO 4217 code. Pattern: ^[A-Z]{3}$.