Home

Acquiring Data Dictionary

Overview

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.

Data tables and fields

This section lists the data tables and associated fields available to query your Highnote data.

Table: payment transaction event

The payment_transaction_event table is mutable and always displays the current state.

Use the following fields to query your Payment Transactions.

#Data FieldData TypeDescription
1payment_transaction_event_idStringUnique ID of the payment transaction event
2payment_idStringUnique ID of the payment transaction
3payment_transaction_step_idStringUnique ID of different steps of the payment transaction life cycle
4payment_credential_idStringUnique ID of the payment card instrument
5brandStringThe card brand name
6step_type_codeStringCode of the transaction step type
7event_type_codeStringCode of the payment transaction event type
8event_type_valueStringValue of the payment transaction event type
9refund_indicatorBooleanIndicates whether this event is a refund or not
10merchant_settlement_account_idStringUnique ID of the merchant settlement account
11merchant_idStringUnique ID of the merchant assigned by Highnote
12network_merchant_idStringNetwork-assigned merchant Unique ID
13acquirer_reference_numberStringUnique ID that Highnote sends to the network for the transaction capture event
14transaction_amount_signedDecimalAmount of the transaction event requested by the cardholder, in the local currency of the acquirer or source location of the transaction
15transaction_amount_currency_codeStringThe ISO 4217 currency code represents the currency of the transaction amount. The local currency of the acquirer or source location of the transaction.
16settlement_amount_signedDecimalAmount of the transaction event in the settlement’s currency. Usually the same as transaction_amount_signed. Also called Total Gross Settled Amount.
17settlement_amount_currency_codeStringThe settlement amount’s currency of the merchant’s settlement account. Usually the same as transaction_amount_currency_code.
18platform_fee_amount_signedDecimalThe fee charged by the platform for this transaction. This is also called merchant discount fee
19net_disbursement_amount_signedDecimalThe net disbursed amount to the merchant’s settlement account. (settlement_amount_signed - platform_fee_amount_signed)
20batch_job_idStringID of the job that processes the payout and transfers
21original_network_transaction_idStringThe network transaction id of the original transaction
22processor_codeStringThe code of the processor in which this transaction was processed
23network_response_codeStringHighnote's normalized response code
24program_idStringUnique ID of the Highnote acquiring program
25program_name_snapshotStringSnapshot of the acquiring program name at the time when the transaction event is processed.
26product_idStringUnique ID of the acquiring product
27product_name_snapshotStringSnapshot of the acquiring product name at the time when the transaction event is processed.
28payment_order_idStringThe ID of the order associated with this payment
29payout_idStringUnique ID of the payout
30receiving_account_idStringUnique ID of the payout receiving account
31transfer_idStringUnique ID of transfer of the payout
32network_settlement_dateDateHighnote (issuer) defined settlement date, calculated using network cutoff and transaction timestamp. Date that banks use to settle the card transaction amounts.
33platform_dateDateThe date when the transaction was settled on the platform, with a cutoff time of 8 PM Eastern Time (ET).
34create_timestampDatetime ISO 8601: YYYY-MM-DDTHH:MM:SSZUTC timestamp when the transaction event was created. It is the timestamp of the transaction event created in the ledger.
35update_timestampDatetime ISO 8601: YYYY-MM-DDTHH:MM:SSZUTC timestamp of when the data record was last updated.

Table: payment instruction item

The payment_instruction table is mutable and always displays the current state.

Use the following fields to query your Payment Instructions.

#Data FieldData TypeDescription
1payment_instruction_item_idStringUnique ID of the payment instruction item
2payment_instruction_group_idStringUnique group ID of the payment instructions
3payment_order_idStringUnique ID of the order
4payment_order_item_list_idStringUnique ID of the payment order item
5catalog_item_idStringUnique ID of the catalog item
6order_item_nameStringName of the order item
7order_item_descriptionStringDescription of the order item
8order_item_quantityDecimalQuantity of the order item
9order_item_amount_signedDecimalAmount of the order item
10order_item_amount_currency_codeStringCurrency of the order item amount
11order_total_amount_signedStringTotal amount of the order
12order_total_amount_currency_codeStringTotal currency amount of the order
13instruction_percentDecimalPayment instruction percentage
14instruction_amount_signedStringPayment instruction amount
15financial_account_idStringUnique ID of the financial account associated with the payment instruction
16create_timestampDatetimeUTC timestamp when the transaction event created
17update_timestampDatetimeUTC timestamp when the data record was last updated

Table: payment order item

The payment_order_item table is mutable and always displays the current state.

Use the following fields to query your Payment Orders.

#Data FieldData TypeDescription
1payment_order_idStringThe ID of the order associated with this payment
2payment_order_item_list_idStringUnique ID of the payment order item
3payment_instruction_group_idStringUnique ID of the payment order item
4order_item_nameStringName of the order item
5order_item_descriptionStringDescription of the order item
6order_item_quantityDecimalDescription of the order item
7order_item_amount_signedDecimalAmount of the order item
8order_item_amount_currency_codeStringCurrency of the order item amount
9order_total_amount_signedStringTotal amount of the order
10order_total_amount_currency_codeStringTotal currency amount of the order
11create_timestampDateTime ISO 8601: YYYY-MM-DDTHH:MM:SSZUTC timestamp when the transaction event was created. It is the timestamp of the transaction event created in the ledger.
12update_timestampDateTime ISO 8601: YYYY-MM-DDTHH:MM:SSZUTC timestamp of when the data record was last updated.

Query library

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

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.

Query: Accounts and Ledgers

The following query returns all accounts and associated ledgers.

Query List accounts and ledgers

Transaction detail reports

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.

Query: Cash movement

The following query returns the running balance of a settlement account, showing how each transaction affects the account balance over time.

Query Cash Movement

Query: Balance report

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.

Query Balance Report

Query: Product funding account

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.

Query Visa Product Funding

Aggregated financial reports

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.

Query: Monthly aggregated invoice

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.

Query Monthly Aggregated Invoice Report

Query: Monthly payout

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.

Query Monthly Payout Report

Query: Monthly aggregated fees

The following query calculates the total platform fees earned from all completed payouts during a defined date range.

Query Monthly Aggregate Fees

Distribution reports

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.

Query: Distribution payment detail

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.

Query Distribution Payment Detail Report

Query: Cleared transactions by brand / item

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.

Query Settled Cleared Transactions by Card Brand and Item

Provide Feedback

Was this content helpful?