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.
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.
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").
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.
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.