TIP Data Dictionary

This document provides a comprehensive data dictionary for all TIP (Transaction Interdiction Protocol) request types.

Transaction Types

Ach

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • ach (AchTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • details (List): List type with elements described in elements property

      Elements:

      Type: AchDetail

      Fields:

      • account_number (int): The account number to which the ACH transaction is sent. This is the account number specific to the financial institution receiving the funds.

      • aba (str): The ABA number to which the ACH transaction is being sent.

      • amount (float): The dollar value of the ACH transaction.

AchPassThru

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • ach (AchPassThruTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • batches (List): List type with elements described in elements property

      Elements:

      Type: AchBatch

      Fields:

      • details (List): List type with elements described in elements property

        Elements:

        Type: AchDetail

        Fields:

        • account_number (int): The account number to which the ACH transaction is sent. This is the account number specific to the financial institution receiving the funds.

        • aba (str): The ABA number to which the ACH transaction is being sent.

        • amount (float): The dollar value of the ACH transaction.

DomesticWire

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • domestic_wire (DomesticWireTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • originating_account_id (int): The account id (Unique identifier, within Financial Institution, for an online banking customer’s account. This is a Q2 internal identifier.) from which the Domestic Wire transaction is being sent.

    • originating_account (optional str): The account number from which the Domestic Wire transaction is being sent.

    • to_account (optional str): The account number to which the Domestic Wire transaction is being sent. This is the account number specific to the financial institution receiving the funds.

    • to_account_aba (optional str): The ABA number to which the Domestic Wire transaction is being sent.

ExternalTransfer

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • external_transfer (ExternalTransferTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • direction (TransferDirection): The direction of money movement in the External Transfer transaction. Can be Outbound, Inbound, or Unsupported. Unsupported is set when an Financial Institution’s HQ version is earlier than this data became available.

    • originating_account (str): The account id (Unique identifier, within Financial Institution, for an online banking customer’s account. This is a Q2 internal identifier.) from which the External Transfer transaction is being sent.

    • to_account (str): The account number to which the External Transfer transaction is being sent. This is the account number specific to the financial institution receiving the funds.

    • to_account_aba (optional str): The ABA number to which the External Transfer transaction is being sent.

    • originating_account_aba (optional str): The ABA number from which the External Transfer transaction is being sent.

FundsTransfer

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • funds_transfer (FundsTransferTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • direction (TransferDirection): The direction of money movement in the Funds Transfer transaction. Can be Outbound, Inbound, or Unsupported. Unsupported is set when an Financial Institution’s HQ version is earlier than this data became available.

    • originating_account (optional str): The account id (Unique identifier, within Financial Institution, for an online banking customer’s account. This is a Q2 internal identifier.) from which the Funds Transfer transaction is being sent.

    • to_account (optional str): The account number to which the Funds Transfer transaction is being sent. This is the account number specific to the financial institution receiving the funds.

InternationalWire

Version: 0

Fields

  • customer_key (str): The Q2 Insight customer key unique to the Financial Institution. This is a Q2 internal identifier.

  • event_user_id (int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who triggered the authorize transaction event.

  • session_id (str): Unique identifier for the session in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • ui_source (str): The UI source that the transaction was authorized from. E.g. OnlineBanking, OpenBanking, etc.

  • transaction_id (int): Unique identifier, within Financial Institution, for the generated transaction in online banking. This is a Q2 internal identifier.

  • audit_id (int): Unique identifier, within Financial Institution, for the audit event within online banking. This is a Q2 internal identifier.

  • event_date_time (datetime): The timestamp of the authorize transaction event.

  • customer_id (int): Unique identifier, within Financial Institution, for the online banking customer. This is a Q2 internal identifier.

  • group_id (int): Unique identifier, within Financial Institution, for the group that the user_id belongs to, this is the same as Q2_Group. This is a Q2 internal identifier.

  • transaction_type (TransactionTypeEnum): The transaction type being authorized. Will be one of the following: Ach, FundsTransfer, DomesticWire, AchPassThru, InternationalWire, ExternalTransfer

  • gt_type_short_name (str): Similar to TransactionType, but more granular. This is the Q2 internal name for the type of transaction generated within Online Banking.

  • transaction_type_version (str): The version of the request shape that is specific to a given transaction type. That is, different transaction types can be on different versions.

  • create_date (datetime): Timestamp when the transaction was created.

  • transaction_amount (float): Timestamp when the transaction was authorized.

  • login_audit_id (int): Audit ID for the login where the transaction was authorized in online banking. This is a Q2 internal identifier.

  • user_logon_id (int): Unique identifier for the logon in online banking that triggered the authorize transaction event. This is a Q2 internal identifier.

  • created_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who created the transaction that is being authorized.

  • authorized_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who authorized the transaction that is being authorized.

  • modified_user_id (optional int): The user id (Unique identifier, within Financial Institution, for the online banking user. This is a Q2 internal identifier.) for the user who modified the transaction that is being authorized.

  • international_wire (InternationalWireTransactionDetails): Data class containing the fields described in fields property

    Fields:

    • to_account (str): The account number to which the International Wire transaction is being sent. This is the account number specific to the financial institution receiving the funds.

    • intermed_swift_or_bic (optional str): The SWIFT code or BIC (Bank Identifier Code) of an intermediary bank in the International Wire transaction being authorized.

    • swift_code_or_bic (optional str): The SWIFT code or BIC (Bank Identifier Code) of the recipient’s bank in the International Wire transaction being authorized.

    • iban (optional str): The recipient’s International Bank Account Number in the International Wire transaction being authorized. IBAN is a standardized international numbering system developed to identify bank accounts from around the world.

    • intermed_iban (optional str): The intermediary bank’s International Bank Account Number. IBAN is a standardized international numbering system developed to identify bank accounts from around the world.

    • recip_address_3 (optional str): The recipient’s third line of address in the International Wire transaction being authorized.

    • address_1 (optional str): The sender’s first line of address in the International Wire transaction being authorized.

    • address_2 (optional str): The sender’s second line of address in the International Wire transaction being authorized.

    • address_3 (optional str): The sender’s third line of address in the International Wire transaction being authorized.

    • intermed_address_1 (optional str): The intermediary bank’s first line of address in the International Wire transaction being authorized.

    • intermed_address_2 (optional str): The intermediary bank’s second line of address in the International Wire transaction being authorized.

    • intermed_address_3 (optional str): The intermediary bank’s third line of address in the International Wire transaction being authorized.

Legend

Required Fields:

Shown without prefix (e.g., str)

Optional Fields:

Shown with ‘optional’ prefix (e.g., optional str)

Nested Objects:

Objects contain sub-fields listed under ‘Fields’

Lists:

Lists contain elements of the specified type listed under ‘Elements’

Note

This documentation was generated automatically from the TIP model schemas.