Skip to navigation

List bank-reported transactions for a treasury account

View as Markdown

Returns a paginated list of bank-reported transaction lines for a treasury account.

These records reflect activity supplied by your bank (for example through reconciliation or balance reporting). You cannot create or modify them through the API.

Path parameters

ParameterTypeRequiredDescription
account_idUUIDYesTreasury account identifier

Query parameters

ParameterTypeRequiredDescription
cursorStringNoPagination cursor from next_cursor in a prior response.
limitIntegerNoPage size.
orderStringNoSort order: asc or desc.
transaction_date_gteDateTimeNoInclude transactions on or after this date (inclusive).
transaction_date_lteDateTimeNoInclude transactions on or before this date (inclusive).
directionStringNocredit (money in) or debit (money out).
is_root_initiatedBooleanNotrue returns only transactions initiated through Root (linked to a Root transfer or carrying a Root reference in the bank text); false returns only transactions not initiated through Root. Omit to return both.
amount_in_minor_units_gteIntegerNoInclude transactions with amount_in_minor_units greater than or equal to this value (inclusive).
amount_in_minor_units_lteIntegerNoInclude transactions with amount_in_minor_units less than or equal to this value (inclusive).
counterparty_searchStringNoCase-insensitive partial match on sender_info or receiver_info.

All filters are optional and combine with AND. Amount bounds use the same smallest currency unit as amount_in_minor_units (for USD, cents: 10000 is $100.00).

Response fields (each item in data)

FieldTypeDescription
idUUIDOpaque identifier for this ingested bank line.
amount_in_minor_unitsIntegerTransaction amount in the smallest unit of the currency.
currency_codeStringISO 4217 currency code.
descriptionStringBank-reported transaction type description.
sender_infoStringSender name or reference from bank continuation text, when available. Omitted when unknown.
receiver_infoStringReceiver name or reference from bank continuation text, when available. Omitted when unknown.
continuation_textStringRaw bank-reported continuation text. Format varies by bank; treat as opaque. Omitted when the bank sent none.
directionStringcredit or debit, when known. Omitted when unknown.
transaction_dateDateBank-reported transaction date, when available. Omitted when unknown.

Success Responses

Status CodeDescription
200OK — paginated list of bank-ingested transactions

Error Responses

Status CodeError CodeDescription
400VALIDATION_ERRORInvalid query parameters
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404NOT_FOUNDTreasury account not found

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

account_idstringRequiredformat: "uuid"
Main operating account ID.

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitintegerOptional10-500Defaults to 50
Number of items to return per page. Minimum is 10. Maximum is 500.
orderenumOptional

Sort order by created_at: ‘asc’ for oldest first, ‘desc’ for newest first (default: ‘desc’)

Allowed values:
transaction_date_gtedatetime or nullOptional

Filter to transactions on or after this date (inclusive).

transaction_date_ltedatetime or nullOptional

Filter to transactions on or before this date (inclusive).

directionenum or nullOptional

Filter by direction: credit (money in) or debit (money out).

Allowed values:
is_root_initiatedboolean or nullOptional

true returns only transactions initiated through Root; false returns only transactions not initiated through Root. Omit to return both.

amount_in_minor_units_gteinteger or nullOptional
Inclusive lower bound for transaction amount in minor units.
amount_in_minor_units_lteinteger or nullOptional
Inclusive upper bound for transaction amount in minor units.

Response

Successful Response
datalist of objects
has_moreboolean
total_countinteger or nullOptional>=0Defaults to 0
next_cursorstring or nullOptional
previous_cursorstring or nullOptional