List transactions for an account (keyset paginated)

GET

/transactions

const url = 'https://api.tovarifinancial.com/transactions?accountId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&status=all&sort=asc';
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/transactions?accountId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&status=all&sort=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

accountId

required

string format: uuid

Account id

limit

integer

Page size

cursor

string

Keyset pagination cursor

from

Calendar date, ‘YYYY-MM-DD’

string

Start date ‘YYYY-MM-DD’

Calendar date, ‘YYYY-MM-DD’

string

End date ‘YYYY-MM-DD’

status

string

Allowed values: all uncleared

Filter by status

search

string

Full-text search over description/payee/memo

sort

string

Allowed values: asc desc

Sort direction

Responses

200

Transactions + running balance summary

application/json

object

data

required

object

summary

object

accountId

string

name

string

accountType

string

institution

string

nullable

maskLast4

string

nullable

lastReconciledAt

string format: date-time

nullable

startingBalanceCents

Integer minor units (cents)

integer format: int64

workingBalanceCents

Integer minor units (cents)

integer format: int64

clearedBalanceCents

Integer minor units (cents)

integer format: int64

unclearedBalanceCents

Integer minor units (cents)

integer format: int64

unclearedCount

integer

transactions

Array<object>

object

string format: uuid

transactionDate

Calendar date, ‘YYYY-MM-DD’

string

amountCents

Integer minor units (cents)

integer format: int64

status

string

Allowed values: uncleared pending cleared reconciled

memo

string

nullable

description

string

payeeId

string

nullable

payeeName

string

nullable

budgetCategoryId

string

nullable

categoryName

string

nullable

categoryColorId

string

nullable

sectionId

string

nullable

sectionName

string

nullable

runningBalanceCents

Integer minor units (cents)

integer format: int64

nextCursor

string

nullable

message

string

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "data": {
    "transactions": [
      {
        "status": "uncleared"
      }
    ]
  }
}

400

Validation failed — see errorCode / fieldErrors

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS ORG_NAME_TAKEN 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"
}

401

Missing, invalid, or expired bearer token

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

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"
}

403

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.

application/json

object

errorCode

required

Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.

string

Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED

message

required

string

details

object

outstanding

required

Active policy versions the user has not yet accepted.

Array<object>

object

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"
}

500

Internal error (no internal detail leaked)

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

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"
}

503

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.

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

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"
}