The Card table is mutable and always displays the current state.
Field name | Data type | Description |
---|---|---|
card_id | String | Unique identifier of the card |
product_id | String | Unique identifier of the card product |
product_name_snapshot | String | Name of the card product associated with the ledger entry |
product_type_code | String | Type of the product |
card_network | String | Name of the network provider (Visa, Mastercard) |
expiration_date | Date | Date that the card expires |
last4 | String | Last 4 digits of the card |
cardholder_party_id | String | Unique identifier of the card holder |
state | String | State of the card: UNACTIVATED , ACTIVE , SUSPENDED , TERMINATED |
financial_account_id | String | Unique identifier of the financial account associated with the card |
form_factor | String | Form of the card: PHYSICAL or VIRTUAL |
card_profile_set_id | String | Unique identifier of the card profile for a given card product |
create_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the transaction event was created in the ledger |
export_id | String | ID that Highnote uses to track a record's lifecycle. To facilitate data investigations, Highnote may request shared record identifiers and export_id . |
update_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the data record was last updated |
The Card Transaction Event table is mutable and always displays the current state.
Field name | Data type | Description |
---|---|---|
create_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the transaction event was created in the ledger |
export_id | String | ID that Highnote uses to track a record's lifecycle. To facilitate data investigations, Highnote may request shared record identifiers and export_id . |
update_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the data record was last updated |
authorization_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the transaction was first authorized on the financial account, if applicable |
interchange_create_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the interchange record was created |
platform_settlement_date | Date | Date when the transaction was settled on the platform, with a cutoff of 8 PM Eastern Time (ET) |
product_id | String | Unique identifier of the card product |
product_name_snapshot | String | Name of the card product associated with the ledger entry |
financial_account_id | String | Unique identifier of the financial account associated with the card |
card_profile_set_id | String | Unique identifier of the card profile for a given card product |
card_network | String | Name of the network provider (Visa, Mastercard) |
bin_classification | String | Classification of the network BIN product type (consumer, commercial, business, etc.) |
bin_funding_type | String | Funding type for the card program (credit, prepaid, debit) |
account_holder_id | String | Unique identifier of the account holder |
payment_card_id | String | Unique identifier of the payment card |
processing_network_code | String | Card transaction network. Possible values: VNT (Visanet), MCC (Mastercard Dual Message), MDS (Maestro Single Message), PUL (PULSE), or MPS (Moneypass) |
financial_event_id | String | Unique identifier of the financial event |
event_type | String | Type of card financial event, e.g., AUTHORIZE , CLEAR , REVERSE , AUTHORIZE_AND_CLEAR |
transaction_id | String | Transaction lifecycle identifier. Example: Two transaction events (AUTH and CLEAR ) make up one transaction lifecycle, so both events share the same transaction lifecycle ID. |
merchant_identifier | String | Identifier of the merchant |
merchant_category_code | String | 4-digit ISO 18245 code representing retail financial services. MCCs classify businesses by the type of goods or services they provide. |
merchant_name | String | Name of the merchant where the transaction took place |
merchant_country | String | ISO 3166 Alpha-3 code representing the country where the card was accepted |
card_acceptor_location | String | Location where the transaction took place. Maps to the merchantID in MerchantDetails GraphQL object. |
issuer_response_code | Enum | Highnote response code: APPROVED , DO_NOT_HONOR , NO_CARD_RECORD |
avs_address_response_code | Enum | Code representing the result of an address verification check |
avs_postal_code_response_code | Enum | Code representing the result of a postal code verification check |
cvv_response_code | Enum | Code representing the result of a card verification value (CVV) check |
settlement_ind | Boolean | Flag identifying a settled transaction |
approved_amount_signed | Decimal | Funds approved and posted to the Highnote ledger for the transaction. Appears as responseCode in GQL response. |
approved_amount_currency_code | String | ISO 4217 code representing the currency of the approved amount |
surcharge_fee_amount_signed | Decimal | Fee for the approved amount of each transaction event type |
surcharge_fee_amount_currency_code | String | ISO 4217 code representing the currency of the surcharge fee amount |
requested_amount_signed | Decimal | Funds requested by the network for each transaction event type |
requested_amount_currency_code | String | ISO 4217 code representing the currency of the requested amount |
interchange_amount_signed | Decimal | Interchange amount of the transaction. Positive for income. Negative for expense. |
interchange_amount_currency_code | String | ISO 4217 code representing the currency of the interchange amount |
interchange_data_availability_ind | Boolean | Indicates whether or not the interchange data is available for the transaction event |
interchange_rate_code | String | Code provided by the card network that denotes the interchange category or rate applied to the transaction. Only available for VNT and MCC. |
pos_terminal_type_code | String | Code representing where the payment was initiated. See PointOfServiceCategory in the API reference. |
pos_pan_entry_mode_code | String | Code representing the method for inputting a Primary Account Number (PAN) into a POS system. This is done manually or electronically via a card reader. See PanEntryMode in the API Reference. |
pos_card_data_input_capability_code | String | Code representing the POS terminal's card input capabilities, e.g., MAGNETIC_STRIPE means the POS terminal can read magnetic stripe cards. See CardDataInputCapability in the API Reference. |
pos_card_presence_code | String | Code representing the presence of a card during the sale: CARD_PRESENT , CARD_NOT_PRESENT , PREAUTHORIZED_PURCHASE , UNKNOWN |
transaction_type_code | String | Code representing the card transaction processing type from the transaction type network, e.g., 00 =goods and services, 01 =cash, 20 =returns, etc |
platform_transaction_category | String | Category created by Highnote to calculate Highnote TPV invoices, e.g., purchase , cash , refund , funding , payment , etc. Non-TPV records display as NOT_APPLICABLE . |
take_rate_transaction_impact | Integer | Direction multiplier used to calculate the take rate for Highnote TPV invoices. Supported values: +1 , -1 , 0 . |
net_settled_transaction_impact | Integer | Direction multiplier used to calculate the net settlement for Highnote TPV invoices. Supported values: +1 , -1 , 0 . |
original_transaction_id | String | Contains the original transaction ID in the case of refunds. Is empty if the network does not provide sufficient context to identify the original transaction. |
issuer_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. |
The Ledger Entry table is immutable.
Field name | Data type | Description |
---|---|---|
create_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the ledger entry was created |
export_id | String | ID that Highnote uses to track a record's lifecycle. To facilitate data investigations, Highnote may request shared record identifiers and export_id . |
update_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp when the data record was last updated |
product_id | String | Unique identifier of the card product |
product_name_snapshot | String | Name of the card product associated with the ledger entry |
financial_account_id | String | Unique identifier of the financial account associated with the ledger entry |
financial_account_name_snapshot | String | Name of the financial account associated with the ledger entry |
transaction_id | String | Transaction lifecycle identifier. Example: Two transaction events (AUTH and CLEAR ) make up one transaction lifecycle, so both events share the same transaction lifecycle ID. |
financial_event_type | String | Activity type of the financial event (e.g., AUTHORIZE , CLEAR , REVERSE , AUTHORIZE_AND_CLEAR ) |
financial_event_id | String | Unique identifier of the financial event that the LedgerEntry results from |
ledger_entry_id | String | Unique identifier of the ledger entryy |
change_amount_signed | String | Amount by which the ledger balance changed |
normal_balance_type | Decimal | Expected balance type of an account. Possible values are Debit or Credit . |
balance_at_ledger_entry_signed | Decimal | Balance of the account after the ledger entry |
card_transaction_settlement_ind | Boolean | Flag identifying cleared transactions to settle at the bank |
billing_month | Date | Month of a billed invoice, with a cutoff of 8 PM Eastern Time (ET) |
ledger_type_code | String | Code representing the type of ledger |
platform_transaction_category | String | Category created by Highnote to calculate Highnote TPV invoices, e.g., purchase , cash , refund , funding , payment , etc. Non-TPV records display as NOT_APPLICABLE . |
take_rate_transaction_impact | Integer | Direction multiplier used to calculate the take rate for Highnote TPV invoices. Supported values: +1 , -1 , 0 . |
net_settled_transaction_impact | Integer | Direction multiplier used to calculate the net settlement for Highnote TPV invoices. Supported values: +1 , -1 , 0 . |
issuer_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. |
receivable_purchase_date | Date | Date when Highnote purchases receivables from the sponsor bank |
receivable_purchase_percent | Integer | Percentage of card settlement amount to be purchased for receivables |
receivables_purchase_ind | Boolean | Indicates that ledger entry is involved in purchasing receivables |
If issuer_settlement_date
= June 10 and ET = Eastern Time, transactions have following criteria:
VISA:
MNGS - MCI/MSI/PULSE/PPE/CIR/EXI:
MNGS - MoneyPass:
Field name | Data type | Description |
---|---|---|
table_name | String | Name of the database table to which the enum values correspond. Helps identify which table the enum codes belong to. |
code_column_name | String | Name of the column within the referenced table_name that uses the enum code. Provides a direct link between the enum value and its usage in a specific column of a table. |
code | String | Actual enum code used in the database. This is the value stored in the column specified by code_column_name in the table_name . |
code_enum | String | Descriptive name or label representing the enum code. This human-readable description provides more context for what the code represents. |
create_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp indicating when the enum record was created. Helps track when the enum was first introduced into the system. |
update_timestamp | DateTime (ISO 8601: YYYY-MM-DDTHH:MM:SSZ) | UTC timestamp indicating the last time the enum record was updated. Helps with auditing and understanding the history of changes to the enum values. |