A credit card's statement details, user-entered terms and credit limit
const url = 'https://api.tovarifinancial.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/statement-details';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.tovarifinancial.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/statement-details \ --header 'Authorization: Bearer <token>'READ-ONLY (KAN-4132): no idempotency key. Credit cards only — any other account type, a missing id and another org’s account are the IDENTICAL 404. userTerms and creditLimit are always returned. statement and history are returned only when the household holds the debt_planning capability (a capability read error counts as not entitled): otherwise status is ‘not_entitled’, statement null and history []. statement is non-null whenever the household is entitled and a statement has been stored, independent of status. status is derived server-side with the precedence not_entitled > not_linked > not_enabled > needs_relink > checking_consent > reauth_required > fetch_paused > available > error > pending_first_fetch. Statement amounts are OWED-POSITIVE integer cents as the bank reports them (a negative statement balance is a credit balance), unlike the ledger’s signed balances. history is first-seen per closing date, newest first, at most 24 rows; Plaid reports only the latest statement, so nothing before the first refresh exists. KAN-4135: institutionName, userTerms and credit are always returned; lastReconciledStatement, historySummary and the statement / history[] additions are entitled-only (null / [] otherwise). Every figure is server-computed; daysUntilDue and the newest paidTowardThroughDate use the client’s today (X-Client-Timezone).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Account id
Responses
Section titled “Responses”Statement details
object
object
KAN-4135 — the live link’s institution name; null = not linked.
object
Integer minor units (cents)
KAN-4135 — user-entered.
KAN-4135 — user-entered, an exact decimal string.
KAN-4135 — the per-card automatic statement check.
object
Integer minor units (cents)
KAN-4135 — credit used against the limit (computeCreditUtilization); null with no usable limit.
object
Integer minor units (cents)
Integer minor units (cents)
Rounded whole percent; may exceed 100 over the limit.
object
Integer minor units (cents)
The closing date, ‘YYYY-MM-DD’.
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
Calendar date, ‘YYYY-MM-DD’
Exact decimal string; no writer yet, so always null today.
object
Plaid’s apr_type, normalized; a type the server does not recognize is ‘other’.
The rate as an EXACT decimal string (at most 4 places), never a JSON number.
Integer minor units (cents)
Integer minor units (cents)
KAN-4135 — the sum of the APRs’ interest; null when none is reported.
KAN-4135 — card payments since the closing date, >= 0.
KAN-4135 — due date minus the client’s today; negative = past due.
KAN-4135 — the bank’s promo fields when either is set, else the user’s, else null.
object
Calendar date, ‘YYYY-MM-DD’
KAN-4135 — the newest statement that reads reconciled, and the action that reconciled it.
object
Calendar date, ‘YYYY-MM-DD’
KAN-4135 — the KPI strip over the newest up to 6 statements; deltas are newest minus oldest in the window (null when either is null or under 2 rows). null for an empty history.
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
object
Plaid’s apr_type, normalized; a type the server does not recognize is ‘other’.
The rate as an EXACT decimal string (at most 4 places), never a JSON number.
Integer minor units (cents)
Integer minor units (cents)
KAN-4133 — the statement history row id (the {statementId} of the fix/undo routes).
KAN-4135 — the sum of the APRs’ interest; null when none.
KAN-4135 — card payments in (closingDate, paidTowardThroughDate], >= 0.
KAN-4135 — the next newer closing date, or the client’s today.
KAN-4135 — the newest payment in that window.
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
KAN-4133 — the statement check result, or null when the statement has not been checked yet.
object
Calendar date, ‘YYYY-MM-DD’
Calendar date, ‘YYYY-MM-DD’
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
KAN-4135 — “How it adds up”, ledger-signed: opening + payments + interest + purchasesAndCredits equals actualLedgerCents exactly (purchasesAndCredits is the residual). null for a check written before the breakdown shipped.
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
The day before the period (‘YYYY-MM-DD’), computed at read time.
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
object
object
Integer minor units (cents)
object
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
object
Integer minor units (cents)
object
Integer minor units (cents)
object
object
The LEDGER-signed amount of the row the fix wrote, else null.
Example
{ "data": { "creditLimit": { "source": "user" }, "credit": { "tier": "low" }, "status": "available", "statement": { "aprs": [ { "type": "purchase_apr" } ], "promo": { "source": "bank" } }, "history": [ { "aprs": [ { "type": "purchase_apr" } ], "check": { "resolutionState": "needs_review", "balance": { "status": "pass" }, "interest": { "status": "pass" }, "minimumPayment": { "status": "pass", "flags": [ "no_payment_scheduled" ] }, "fees": { "status": "pass", "items": [ { "kind": "late" } ] }, "offeredFixes": [ { "kind": "move" } ], "activeActions": [ { "kind": "auto_reconcile" } ] } } ] }}Validation failed — see errorCode / fieldErrors
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Missing, invalid, or expired bearer token
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.
object
Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.
object
Active policy versions the user has not yet accepted.
object
True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.
Example
{ "errorCode": "EMAIL_NOT_VERIFIED"}Resource not found or not owned by the caller org
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Internal error (no internal detail leaked)
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.
object
Machine-readable error code (AUTH_ERROR_CODES).
Optional field-level validation errors, keyed by field name.
object
Example
{ "errorCode": "INVALID_EMAIL_FORMAT"}