Skip to content

Undo one fix applied to a credit-card statement

DELETE
/accounts/{id}/statements/{statementId}/actions/{actionId}
curl --request DELETE \
--url https://api.tovarifinancial.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/statements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/actions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

KAN-4133. X-Idempotency-Key is REQUIRED. Requires debt_planning (403 CAPABILITY_REQUIRED before any claim). The three ids resolve jointly (404 ‘Statement not found’ for any mismatch). Only user fixes (move, adjustment, add_interest, leave_open) are undoable; 409 STATEMENT_UNDO_BLOCKED for the engine’s auto_reconcile, an action already undone, a later action on the statement, a later reconciled statement on the account, or a moved/added row that has changed since. The statement returns to needs_review.

id
required
string format: uuid

Account id

statementId
required
string format: uuid

Statement history id

actionId
required
string format: uuid

Statement action id

X-Idempotency-Key
string

Optional idempotency key for safe write retries. Every operation that declares this header reads it. Three cases, told apart per operation: (1) where the operation also documents a 409 whose codes include IDEMPOTENCY_CONFLICT, replaying this key with a different payload returns 409 IDEMPOTENCY_CONFLICT and replaying it with the same payload returns the original response; (2) where it documents no 409, a replay is reconciled optimistically against a unique key column and answers the original 200; (3) where it documents a 409 whose codes do NOT include IDEMPOTENCY_CONFLICT, a conflict on this key is impossible — a replay answers a 200, and that 409 is a resource-state conflict described by the operation’s own 409 schema.

Fix undone

Media typeapplication/json
object
data
required
object
statement
required
object
statementId
required
string format: uuid
closingDate
required

Calendar date, ‘YYYY-MM-DD’

string
periodStart
required

Calendar date, ‘YYYY-MM-DD’

string
resolutionState
required
string
Allowed values: needs_review auto_reconciled resolved left_open superseded
checkedAt
required
string format: date-time
rulesVersion
required
integer
balance
required
object
status
required
string
Allowed values: pass fail unavailable
expectedLedgerCents
required

Integer minor units (cents)

integer format: int64
nullable
actualLedgerCents
required

Integer minor units (cents)

integer format: int64
nullable
differenceLedgerCents
required

Integer minor units (cents)

integer format: int64
nullable
pendingInPeriodCount
required
integer
breakdown

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
openingLedgerCents
required

Integer minor units (cents)

integer format: int64
paymentsLedgerCents
required

Integer minor units (cents)

integer format: int64
interestLedgerCents
required

Integer minor units (cents)

integer format: int64
purchasesAndCreditsLedgerCents
required

Integer minor units (cents)

integer format: int64
openingDate
required

The day before the period (‘YYYY-MM-DD’), computed at read time.

string
interest
required
object
status
required
string
Allowed values: pass fail unavailable
expectedCents
required

Integer minor units (cents)

integer format: int64
nullable
actualCents
required

Integer minor units (cents)

integer format: int64
nullable
differenceCents
required

Integer minor units (cents)

integer format: int64
nullable
minimumPayment
required
object
status
required
string
Allowed values: pass flag unavailable
flags
required
Array<string>
Allowed values: no_payment_scheduled below_minimum after_due_date minimum_jumped
billId
required
string format: uuid
nullable
scheduledDate
required

Calendar date, ‘YYYY-MM-DD’

string
nullable
scheduledCents
required

Integer minor units (cents)

integer format: int64
nullable
fees
required
object
status
required
string
Allowed values: pass flag
items
required
Array<object>
object
transactionId
required
string format: uuid
kind
required
string
Allowed values: late foreign_transaction cash_advance annual other
amountCents
required

Integer minor units (cents)

integer format: int64
expected
required
boolean
offeredFixes
required
Array
One of:
object
kind
required
string
Allowed values: move
transactionId
required
string format: uuid
ledgerAmountCents
required

Integer minor units (cents)

integer format: int64
fromDate
required

Calendar date, ‘YYYY-MM-DD’

string
activeActions
required
Array<object>
object
id
required
string format: uuid
kind
required
string
Allowed values: auto_reconcile move adjustment add_interest leave_open
createdAt
required
string format: date-time
undoneAt
required
string format: date-time
nullable
reconciledCount
required
integer
amountCents
required

The LEDGER-signed amount of the row the fix wrote, else null.

integer format: int64
nullable
movedTransactionId
required
string format: uuid
nullable
addedTransactionId
required
string format: uuid
nullable
action
required
object
id
required
string format: uuid
kind
required
string
Allowed values: auto_reconcile move adjustment add_interest leave_open
createdAt
required
string format: date-time
undoneAt
required
string format: date-time
nullable
reconciledCount
required
integer
amountCents
required

The LEDGER-signed amount of the row the fix wrote, else null.

integer format: int64
nullable
movedTransactionId
required
string format: uuid
nullable
addedTransactionId
required
string format: uuid
nullable
releasedCount
required
integer
affectedAccounts
required
Array<object>
object
accountId
string
balanceCents

Integer minor units (cents)

integer format: int64
clearedBalanceCents

Integer minor units (cents)

integer format: int64
unclearedBalanceCents

Integer minor units (cents)

integer format: int64
pendingBalanceCents

Integer minor units (cents)

integer format: int64
workingBalanceCents

Integer minor units (cents)

integer format: int64
monthChangeCents

Integer minor units (cents)

integer format: int64
message
string
requestId
required
string
timestamp
required
string format: date-time
Example
{
"data": {
"statement": {
"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"
}
]
},
"action": {
"kind": "auto_reconcile"
}
}
}

Validation failed — see errorCode / fieldErrors

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Missing, invalid, or expired bearer token

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
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.

Media typeapplication/json
object
errorCode
required

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.

string
Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED CAPABILITY_REQUIRED
message
required
string
details
object
outstanding
required

Active policy versions the user has not yet accepted.

Array<object>
object
id
required
string format: uuid
policyType
required
string
version
required
integer
title
required
string
firstAcceptance
required

True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.

boolean
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "EMAIL_NOT_VERIFIED"
}

Resource not found or not owned by the caller org

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Conflict. errorCode is IDEMPOTENCY_CONFLICT when an X-Idempotency-Key was replayed with a different request payload; where the operation instead detects a resource-state conflict it carries that endpoint’s own errorCode (a duplicate name, an import that is no longer committable, an account already linked to a bank connection).

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}

Internal error (no internal detail leaked)

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
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.

Media typeapplication/json
object
errorCode
required

Machine-readable error code (AUTH_ERROR_CODES).

string
Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND
message
required
string
fieldErrors

Optional field-level validation errors, keyed by field name.

object
key
additional properties
Array<string>
requestId
required
string
timestamp
required
string format: date-time
Example
{
"errorCode": "INVALID_EMAIL_FORMAT"
}