Home / Basics / Highnote API
Universal Transaction Search
The Highnote Universal Transaction Search (UTS) API empowers users to easily view different types of transactions together, for example:
- Search across transaction types and products.
- View all transactions for a given account card holder today, including card transactions, ACHs, wire transfers, check payments, inter-financial account transfers, and manual adjustments.
The following fields work together to provide comprehensive filtering and search capabilities across all transaction types in the Highnote platform, supporting both high-level transaction views and detailed event-level analysis.
| Search Field | Description |
|---|---|
| TRANSACTION_ID | Unique identifier for the transaction. This is a global ID that can reference various types of financial transactions within the Highnote platform. |
| Type: String (Global ID) | |
| Example: "tr_abc123def456" | |
| TRANSACTION_AMOUNT | The monetary amount associated with the transaction, including currency information. Used for filtering transactions by amount ranges. |
| Type: Amount object with value and currency code | |
| Example: { "value": "10000", "currencyCode": "USD" } (represents $100.00) | |
| ACCOUNT_ID | Global identifier for the financial account involved in the transaction. This can be any type of financial account within the Highnote ecosystem. |
| Type: String (Global ID) | |
| Example: "fa_xyz789abc123" | |
| ACCOUNT_HOLDER_ID | Global identifier for the account holder (person or business) associated with the transaction. |
| Type: String (Global ID) | |
| Example: "ah_person123" or "ah_business456" | |
| TRANSACTION_SEARCH_TYPE | Defines the granularity level of the search result - whether you're looking at complete transactions, individual events, or account-specific activities. Possible Values: |
TRANSACTION - Top-level entity representing the complete transaction, often computed from multiple underlying events | |
EVENT - Granular movement of money or state change involved in a transaction (e.g., authorization, settlement, refund) | |
ACTIVITY - A transaction or event as viewed from the perspective of a specific financial account | |
| TRANSACTION_SEARCH_OBJECT_TYPE | Specifies the type of financial object/operation being searched. This categorizes transactions by their business purpose. Possible Values: |
ACH_TRANSFER - Automated Clearing House transfers | |
CARD_TRANSACTION - Payment card authorizations and settlements (for issuing transactions) | |
CHECK_PAYMENT - Transfers by physical check | |
DISBURSEMENT - Funds distribution or payout transactions | |
INSTANT_NETWORK_TRANSFER - Real-time network transfers (e.g., FedNow, RTP) | |
INTER_FINANCIAL_ACCOUNT_TRANSFER - Transfers between financial accounts | |
MANUAL_ADJUSTMENT - Manual adjustments to account balances | |
WIRE_TRANSFER - Wire transfer transactions | |
| TRANSACTION_SEARCH_STATUS | The current status or state of the transaction, indicating its processing stage or final outcome. Normalized across all object types. Describes the current/latest status of a TRANSACTION. Describes the status at the time of the EVENT / ACTIVITY. |
Possible Values: COMPLETE / FAIL / PENDING | |
| Type: String enum | |
| ACTION_DATE | The date and time when a specific action was taken on the transaction (e.g., when an authorization was made, when a settlement occurred). |
| Type: ISO 8601 formatted timestamp string | |
| Example: "2024-01-15T14:30:00.000Z" | |
| COMPLETED_DATE | The date and time when the transaction was fully completed or reached its final state. |
| Type: ISO 8601 formatted timestamp string | |
| Example: "2024-01-15T16:45:00.000Z" | |
| CREATED_AT | The date and time when the transaction record was first created in the system. |
| Type: ISO 8601 formatted timestamp string | |
| Example: "2024-01-15T14:25:00.000Z" | |
| UPDATED_AT | The date and time when the transaction record was last modified or updated. |
| Type: ISO 8601 formatted timestamp string | |
| Example: "2024-01-15T16:50:00.000Z" |
Use the following query to search transactions above $500 for a specific account holder.
The following are UTS request and response object examples:
- UTS Request Object
- UTS Response Object