List bank-reported transactions for a treasury account

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

Parameter	Type	Required	Description
`account_id`	UUID	Yes	Treasury account identifier

Query parameters

Parameter	Type	Required	Description
`cursor`	String	No	Pagination cursor from `next_cursor` in a prior response.
`limit`	Integer	No	Page size.
`order`	String	No	Sort order: `asc` or `desc`.
`transaction_date_gte`	DateTime	No	Include transactions on or after this date (inclusive).
`transaction_date_lte`	DateTime	No	Include transactions on or before this date (inclusive).

Response fields (each item in data)

Field	Type	Description
`id`	UUID	Opaque identifier for this ingested bank line.
`amount_in_minor_units`	Integer	Transaction amount in the smallest unit of the currency.
`currency_code`	String	ISO 4217 currency code.
`description`	String	Bank-reported transaction type description.
`sender_info`	String	Sender name or reference from bank continuation text, when available. Omitted when unknown.
`receiver_info`	String	Receiver name or reference from bank continuation text, when available. Omitted when unknown.
`direction`	String	`credit` or `debit`, when known. Omitted when unknown.
`transaction_date`	Date	Bank-reported transaction date, when available. Omitted when unknown.

Success Responses

Status Code	Description
200	OK — paginated list of bank-ingested transactions

Error Responses

Status Code	Error Code	Description
400	VALIDATION_ERROR	Invalid query parameters
401	AUTHENTICATION_ERROR	Authentication credentials are invalid or missing
403	AUTHORIZATION_ERROR	You do not have permission to perform this action
404	NOT_FOUND	Treasury account not found

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** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | UUID | Yes | Treasury account identifier | **Query parameters** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | String | No | Pagination cursor from `next_cursor` in a prior response. | | `limit` | Integer | No | Page size. | | `order` | String | No | Sort order: `asc` or `desc`. | | `transaction_date_gte` | DateTime | No | Include transactions on or after this date (inclusive). | | `transaction_date_lte` | DateTime | No | Include transactions on or before this date (inclusive). | **Response fields** (each item in `data`) | Field | Type | Description | |-------|------|-------------| | `id` | UUID | Opaque identifier for this ingested bank line. | | `amount_in_minor_units` | Integer | Transaction amount in the smallest unit of the currency. | | `currency_code` | String | ISO 4217 currency code. | | `description` | String | Bank-reported transaction type description. | | `sender_info` | String | Sender name or reference from bank continuation text, when available. Omitted when unknown. | | `receiver_info` | String | Receiver name or reference from bank continuation text, when available. Omitted when unknown. | | `direction` | String | `credit` or `debit`, when known. Omitted when unknown. | | `transaction_date` | Date | Bank-reported transaction date, when available. Omitted when unknown. | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK — paginated list of bank-ingested transactions | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 400 | VALIDATION_ERROR | Invalid query parameters | | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | NOT_FOUND | Treasury 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. Maximum is 500.

orderenumOptional

Sort order for results by creation time.

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).

Response

Successful Response

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null