Card payment editor figures for one card
const url = 'https://api.tovarifinancial.com/bills/card-payment-preview?cardAccountId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';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/bills/card-payment-preview?cardAccountId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --header 'Authorization: Bearer <token>'READ-ONLY (KAN-4134): writes nothing and takes no idempotency key. The card payment editor’s server-computed figures: the current statement, payments since it closed (non-pending inbound transfer legs and unlinked LOAN_PAYMENTS_CREDIT_CARD_PAYMENT rows on the card dated after the closing date and on or before today; refunds and other credits excluded), each amount mode resolved, the usual and due pay dates, the default choice, the target occurrence when editing and any other card payment bill on the card. Requires debt_planning (403). Another household’s id and a nonexistent one both answer 404. KAN-4183: WITHOUT sourceAccountId the answer is the candidates-only shape (status: 'candidates_only', no figures) carrying linkCandidates — the household’s existing recurring expense bills, paid from an active checking or savings account, that already pay this card (destination is the card, or no destination and matched to a Plaid recurring stream whose every live linked row is a transfer into this one card), newest payment first, at most 10, and [] whenever a card payment bill already pays the card. billId, streamId and fixedCents are accepted only beside sourceAccountId (400 on sourceAccountId otherwise). WITH sourceAccountId the answer carries no linkCandidates, and targetOccurrenceDate is null unless billId names a card payment bill.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The credit card (required)
The checking or savings account it is paid from. OPTIONAL (KAN-4183): omit it for the candidates-only answer.
The card payment bill being edited (only with sourceAccountId)
The card-payment recurring suggestion seeding a new bill (only with sourceAccountId)
The Fixed amount being typed, positive integer cents (only with sourceAccountId)
Responses
Section titled “Responses”The preview: the candidates-only answer without sourceAccountId, else the figures
object
object
Always null on this shape.
object
The bill name as stored.
The bill’s stored frequency; never ‘once’.
Day_of_month when the bill is monthly, else null.
The newest payment, positive integer cents; null when never paid.
The newest payment’s register date; null when never paid.
A Plaid recurring stream in the household is matched to this bill.
object
object
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
object
KAN-4134. One amount mode resolved against the current statement: { kind: amount, amountCents, baseAmountCents, raisedToMinimum, cappedAtStatement }, { kind: skip, reason: zero_or_credit | statement_paid | minimum_met } or { kind: unavailable, reason: no_statement }.
object
Integer minor units (cents)
Integer minor units (cents)
KAN-4134. One amount mode resolved against the current statement: { kind: amount, amountCents, baseAmountCents, raisedToMinimum, cappedAtStatement }, { kind: skip, reason: zero_or_credit | statement_paid | minimum_met } or { kind: unavailable, reason: no_statement }.
object
Integer minor units (cents)
Integer minor units (cents)
KAN-4134. One amount mode resolved against the current statement: { kind: amount, amountCents, baseAmountCents, raisedToMinimum, cappedAtStatement }, { kind: skip, reason: zero_or_credit | statement_paid | minimum_met } or { kind: unavailable, reason: no_statement }.
object
Integer minor units (cents)
Integer minor units (cents)
Integer minor units (cents)
object
Calendar date, ‘YYYY-MM-DD’
Calendar date, ‘YYYY-MM-DD’
object
object
Integer minor units (cents)
Calendar date, ‘YYYY-MM-DD’
Example
{ "data": { "status": "candidates_only", "linkCandidates": [ { "autoEnterMode": "automatic" } ] }}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. This operation can ALSO answer 403 with errorCode CAPABILITY_REQUIRED and no details, a refusal by the HANDLER rather than by the tenant gate: the request needs the debt_planning capability (the Premier plan or Founder access) — turning statement details on (enabled: true; turning it off needs no capability), or (KAN-4134) saving a non-null card payment field on a bill (clearing the mode needs none) or reading the card payment preview. It fails closed: a capability read that errors is refused the same way. Nothing is written, nothing is queued and no idempotency record is kept. It does NOT depend on CAPABILITY_FENCE_ENABLED or BILLING_ENABLED. The errorCode enum on this operation’s response schema is the complete, machine-readable list.
object
Which condition refused the request, evaluated in this order (CCR-1). SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true; CAPABILITY_REQUIRED is unreachable while CAPABILITY_FENCE_ENABLED is not exactly true. The two switches are independent, so CAPABILITY_REQUIRED is reachable with the subscription paywall off. CAPABILITY_REQUIRED carries no details.
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"}