The Highnote Acquiring Data Dictionary provides all the data available for querying your payment transactions, items, and orders.
The queries and objects below demonstrate how you can construct on-demand reports and generate metrics as needed.
This section lists the data tables and associated fields available to query your Highnote data.
The payment_transaction_event table is mutable and always displays the current state.
Use the following fields to query your Payment Transactions.
| # | Data Field | Data Type | Description |
|---|---|---|---|
| 1 | payment_transaction_event_id | String | Unique ID of the payment transaction event |
| 2 | payment_id | String | Unique ID of the payment transaction |
| 3 | payment_transaction_step_id | String | Unique ID of different steps of the payment transaction life cycle |
| 4 | payment_credential_id | String | Unique ID of the payment card instrument |
| 5 | brand | String | The card brand name |
| 6 | step_type_code | String | Code of the transaction step type |
| 7 | event_type_code | String | Code of the payment transaction event type |
| 8 | event_type_value | String | Value of the payment transaction event type |
| 9 | refund_indicator | Boolean | Indicates whether this event is a refund or not |
| 10 | merchant_settlement_account_id | String | Unique ID of the merchant settlement account |
| 11 | merchant_id | String | Unique ID of the merchant assigned by Highnote |
| 12 | network_merchant_id | String | Network-assigned merchant Unique ID |
| 13 | acquirer_reference_number | String | Unique ID that Highnote sends to the network for the transaction capture event |
| 14 | transaction_amount_signed | Decimal | Amount of the transaction event requested by the cardholder, in the local currency of the acquirer or source location of the transaction |
| 15 | transaction_amount_currency_code | String | The ISO 4217 currency code represents the currency of the transaction amount. The local currency of the acquirer or source location of the transaction. |
| 16 | settlement_amount_signed | Decimal | Amount of the transaction event in the settlement’s currency. Usually the same as transaction_amount_signed. Also called Total Gross Settled Amount. |
| 17 | settlement_amount_currency_code | String | The settlement amount’s currency of the merchant’s settlement account. Usually the same as transaction_amount_currency_code. |
| 18 | platform_fee_amount_signed | Decimal | The fee charged by the platform for this transaction. This is also called merchant discount fee |
| 19 | net_disbursement_amount_signed | Decimal | The net disbursed amount to the merchant’s settlement account. (settlement_amount_signed - platform_fee_amount_signed) |
| 20 | batch_job_id | String | ID of the job that processes the payout and transfers |
| 21 | original_network_transaction_id | String | The network transaction id of the original transaction |
| 22 | processor_code | String | The code of the processor in which this transaction was processed |
| 23 | network_response_code | String | Highnote's normalized response code |
| 24 | program_id | String | Unique ID of the Highnote acquiring program |
| 25 | program_name_snapshot | String | Snapshot of the acquiring program name at the time when the transaction event is processed. |
| 26 | product_id | String | Unique ID of the acquiring product |
| 27 | product_name_snapshot | String | Snapshot of the acquiring product name at the time when the transaction event is processed. |
| 28 | payment_order_id | String | The ID of the order associated with this payment |
| 29 | payout_id | String | Unique ID of the payout |
| 30 | receiving_account_id | String | Unique ID of the payout receiving account |
| 31 | transfer_id | String | Unique ID of transfer of the payout |
| 32 | network_settlement_date | Date | Highnote (issuer) defined settlement date, calculated using network cutoff and transaction timestamp. Date that banks use to settle the card transaction amounts. |
| 33 | platform_date | Date | The date when the transaction was settled on the platform, with a cutoff time of 8 PM Eastern Time (ET). |
| 34 | create_timestamp | Datetime ISO 8601: YYYY-MM-DDTHH:MM:SSZ | UTC timestamp when the transaction event was created. It is the timestamp of the transaction event created in the ledger. |
| 35 | update_timestamp | Datetime ISO 8601: YYYY-MM-DDTHH:MM:SSZ | UTC timestamp of when the data record was last updated. |
The payment_instruction table is mutable and always displays the current state.
Use the following fields to query your Payment Instructions.
| # | Data Field | Data Type | Description |
|---|---|---|---|
| 1 | payment_instruction_item_id | String | Unique ID of the payment instruction item |
| 2 | payment_instruction_group_id | String | Unique group ID of the payment instructions |
| 3 | payment_order_id | String | Unique ID of the order |
| 4 | payment_order_item_list_id | String | Unique ID of the payment order item |
| 5 | catalog_item_id | String | Unique ID of the catalog item |
| 6 | order_item_name | String | Name of the order item |
| 7 | order_item_description | String | Description of the order item |
| 8 | order_item_quantity | Decimal | Quantity of the order item |
| 9 | order_item_amount_signed | Decimal | Amount of the order item |
| 10 | order_item_amount_currency_code | String | Currency of the order item amount |
| 11 | order_total_amount_signed | String | Total amount of the order |
| 12 | order_total_amount_currency_code | String | Total currency amount of the order |
| 13 | instruction_percent | Decimal | Payment instruction percentage |
| 14 | instruction_amount_signed | String | Payment instruction amount |
| 15 | financial_account_id | String | Unique ID of the financial account associated with the payment instruction |
| 16 | create_timestamp | Datetime | UTC timestamp when the transaction event created |
| 17 | update_timestamp | Datetime | UTC timestamp when the data record was last updated |
The payment_order_item table is mutable and always displays the current state.
Use the following fields to query your Payment Orders.
| # | Data Field | Data Type | Description |
|---|---|---|---|
| 1 | payment_order_id | String | The ID of the order associated with this payment |
| 2 | payment_order_item_list_id | String | Unique ID of the payment order item |
| 3 | payment_instruction_group_id | String | Unique ID of the payment order item |
| 4 | order_item_name | String | Name of the order item |
| 5 | order_item_description | String | Description of the order item |
| 6 | order_item_quantity | Decimal | Description of the order item |
| 7 | order_item_amount_signed | Decimal | Amount of the order item |
| 8 | order_item_amount_currency_code | String | Currency of the order item amount |
| 9 | order_total_amount_signed | String | Total amount of the order |
| 10 | order_total_amount_currency_code | String | Total currency amount of the order |
| 11 | create_timestamp | DateTime ISO 8601: YYYY-MM-DDTHH:MM:SSZ | UTC timestamp when the transaction event was created. It is the timestamp of the transaction event created in the ledger. |
| 12 | update_timestamp | DateTime ISO 8601: YYYY-MM-DDTHH:MM:SSZ | UTC timestamp of when the data record was last updated. |
This acquiring query library includes a selection of common Highnote queries in the Snowflake dialect. We demonstrate how to generate the following types of reports:
The queries below include a defined date range which you can edit as necessary:
To see the full data set, remove the BETWEEN condition in each query:
Foundational reports are essential for understanding the system's structure and configuration. These reports identify available accounts, ledger types, and their relationships, providing the foundational context needed to interpret all other financial reports.
The following query returns all accounts and associated ledgers.
Transaction detail reports monitor individual transactions and their impact on account balances over time. These reports show the complete flow of funds through the system, including running balances, transaction linkages, and reconciliation details necessary for auditing and troubleshooting.
The following query returns the running balance of a settlement account, showing how each transaction affects the account balance over time.
The following query returns all transactions and running balances for a Product Funding account, linking each ledger entry to its corresponding payment event for reconciliation purposes.
The following query generates a parameterized monthly ledger report for a Product Funding Account, showing all transactions and balance changes for a specified date range in reverse chronological order.
Aggregated reports consolidate transaction data into meaningful business metrics. These reports provide executive-level insights into settlement volumes, payout amounts, and platform fees across different time periods and payment brands.
The following query generates a monthly settlement report for a defined date range, summarizing completed payouts by payment brand with counts, gross amounts, merchant fees, and net settlement totals.
The following query summarizes daily payout batches for a defined date range, showing the number of transactions and total amount disbursed in each payout run.
The following query calculates the total platform fees earned from all completed payouts during a defined date range.
Distribution reports reveal how the payment system operates behind the scenes. These reports show payment routing rules, fund distribution logic, and product-level performance metrics that help optimize payment operations and understand revenue allocation.
The following query retrieves payment distribution instructions for a defined date range, showing how order amounts are split across different financial accounts based on percentage-based routing rules.
The following query analyzes cleared transactions by payment brand and product/item type for a defined date range, showing total sales amounts for each combination.