Events Reference

This guide is a reference for all Highnote notification events. Note the following when using this reference:

• Notification events are categorized by domain. For example, the ACH section of this guide houses all notification events related to ACH transfers.
• The NotificationEvent object in the Highnote API uses a NotificationEventName field to identify different event types. This field is not always the same name as the object used to create a notification event query.
• When creating notification event queries, refer to the event's object in the Highnote API Reference. Each notification event in this reference links out to its corresponding object in the API.
• For a description of each notification event, see the corresponding Object reference link in the reference tables in this guide.

Note: To simplify ACH transfer events and notifications on the Highnote platform, ACH v2 notification events were released in August 2024.

ACH v1 notification events are still supported by the Highnote platform. Using these notification events will not impact your integration’s functionality or performance. You can upgrade to using ACH v2 notification events at any time. Refer to the Upgrade to ACH v2 notification events guide for more information.

ACH v1 notification events are triggered for various ACH event types.

The following table provides an overview of some fields you may see in an ACH notification event response. Note that this table does not contain all response fields. For a full list of response fields, refer to the API Reference:

ACH externally initiated deposit notifications are triggered when an incoming NACHA file credit transaction is processed. The following notification events are available for ACH externally initiated deposits:

The following payload provides an example notification response from an ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVED event:

ACH externally initiated deposit events are triggered when an incoming NACHA file debit transaction is processed, and a fund out ACH payment transitions states. The following notification events are available for ACH externally initiated withdrawals:

The following payload provides an example notification response from an ACH_EXTERNALLY_INITIATED_WITHDRAWAL_RECEIVED event:

ACH funds deposit notifications are triggered when a fund-in ACH transfer is initiated from within Highnote, or transitions states. The following notification events are available for ACH funds deposits:

The following payload provides an example notification response from an ACH_FUNDS_DEPOSIT_INITIATED event:

ACH funds withdrawal events are triggered when a fund-out ACH payment is initiated from within Highnote, or transitions states. The following notification events are available for ACH funds withdrawals:

The following payload provides an example notification response from an ACH_FUNDS_WITHDRAWAL_INITIATED event:

ACH hold notifications trigger when an ACH transfer has been put on hold, or has a hold removed from it. The following notification events are available for ACH holds:

The following payload provides an example notification response from an ACH_HOLD_ADDED event:

ACH repayment events are triggered when an ACH repayment transaction transitions states. The following notification events are available for ACH repayments:

The following payload provides an example notification response from an ACH_REPAYMENT_PROCESSED event:

ACH secure deposit events are triggered when an ACH secure deposit transitions states. The following notification events are available for ACH secure deposits:

The following payload provides an example notification response from an ACH_SECURE_DEPOSIT_PROCESSING event:

ACH v2 notification events are Highnote’s updated version of the legacy ACH v1 notification events. ACHv2 notifications have been simplified to represent two types of ACH transfers: originated and non-originated.

The following table provides descriptions for each type of ACH transfer, and the direction of money movement for each:

The following table provides an overview of some fields you may see in an ACH v2 notification event response. Note that this table does not contain all response fields. For a full list of response fields, refer to the API Reference:

Originated ACH transfer notifications are triggered when an ACH transfer is initiated from within the Highnote platform. The following notification events are available for originated ACH transfers:

The following payload provides an example notification response from an ORIGINATED_ACH_TRANSFER_INITIATED event:

Non-originated ACH transfer notifications are triggered when an ACH transfer is initiated from outside the Highnote platform by a third-party. The following notification events are available for non-originated ACH transfers:

The following payload provides an example notification response from an NON_ORIGINATED_ACH_TRANSFER_RECEIVED event:

ACH transfer hold notification events are triggered when a hold is added or removed from an ACH transfer. The following notification events are available for ACH transfer hold events:

The following payload provides an example notification response from an ACH_TRANSFER_HOLD_ADDED event:

To simplify ACH transfer events and notifications on the Highnote platform, ACH v2 notification events were released in August 2024.

To upgrade from ACH v1 events to ACH v2 events, refer to the following table for a mapping of which v2 event to use for your corresponding v1 event:

Account holder identity document events are sent when a document is requested from an account holder for identity verification. This process can happen during application onboarding, underwriting, or for ongoing identity verification. The notification event type sent when a document is requested differs based on the type of document requested, and will include a reason code that indicates the purpose for requesting the document(s).

The following events are available for account holder identity documents:

The following payload provides an example notification response of a PERSON_ACCOUNT_HOLDER_IDENTITY_DOCUMENTS_REQUESTED event:

Account holder information update events are sent with an account holder or associated person's information is updated. The following events are available for account holder information updates:

In the event payload, the updatedTypes field shows what information was updated for the account holder. The following payload provides an example notification response of a PERSON_ACCOUNT_HOLDER_IDENTITY_UPDATED event:

Application status notification events are triggered when an account holder or authorized user card product application transitions states. The following table provides an overview of some fields you may see in an application status event response. For a full list of response fields, refer to the API Reference:

Account holder application status notifications are triggered when a card product application transitions states. The following notification events are available for account holder application statuses:

The following payload provides an example notification response from an CARD_PRODUCT_APPLICATION_APPROVED event:

Authorized user application status events are triggered when an authorized user's card product application transitions states. The following notification events are available for authorized user application statuses:

The following payload provides an example response for an AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_APPROVED event:

Credit report fraud alert events are triggered when a card product application receives a fraud alert tag during underwriting. You can subscribe to the following event to inform you when a credit report fraud alert is triggered:

The following payload is an example notification response from a CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FRAUD_ALERT event:

Credit report freeze events are triggered when a card product application receives a credit report freeze tag during underwriting. You can subscribe to the following event to inform you when a credit report freeze is triggered:

The following payload is an example notification response from a CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FREEZE event:

Chargeback and dispute notification events are triggered for various dispute-related events. Refer to the API reference for fields you may see in a chargeback or dispute notification event response.

Dispute case status events are triggered when the state of a transaction's dispute case is updated. The following notification events are available for dispute case statuses:

The following payload provides an example notification response from a PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_INITIATED event:

Dispute credit status events are triggered when the credit status of a dispute is updated for a provisional credit or dispute credit. The following notification events are available for dispute credit status events:

The following payload provides an example notification response from a PAYMENT_CARD_TRANSACTION_DISPUTE_CREDIT_STATUS_PROVISIONAL_CREDIT_ISSUED event:

Chargeback provisional credit status events are triggered when a dispute case's provisional credit status is updated. The following notification events are available for chargeback provisional credit status events:

The following payload provides an example notification response from a PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUED event:

Credit limit change request notification events are triggered when the status of the case transitions states. The following notification events are available for credit limit change case statuses:

When the collaborative application decisioning feature is enabled, you can subscribe to the following event informing you an application decision is requested:

The following payload provides an example notification response from a CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTED event:

The following payload is an example notification response from a CREDIT_LIMIT_CHANGE_REQUEST_STATUS_CHANGED event when an increase to the credit limit is initiated:

The following payload is an example notification response from a CREDIT_LIMIT_CHANGE_REQUEST_STATUS_CHANGED event when an increase to the credit limit fails:

Digital wallet token notification events are triggered when a tokenized card is activated, suspended, or terminated. The following notification events are available for digital wallet token statuses:

The following payload provides an example notification response from a CARD_DIGITAL_WALLET_TOKEN_ACTIVATED event:

Financial account attribute events are triggered when financial account attributes are added or removed. The following notification events are available for financial account attributes:

The following payload provides an example notification event response for an FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT event:

Document upload session events are sent when a new document upload session is requested.

The following payload provides an example notification response of a CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTED event:

External bank account events are triggered when an external bank account is added or removed from an account holder. The following notification events are available for external bank account events:

The following payload provides an example notification event response for an EXTERNAL_BANK_ACCOUNT_REMOVED event:

Financial account status events are triggered when a financial account transitions states. The following notification events are available for financial account statuses:

The following payload provides an example notification event response for an ACCOUNT_STATUS_SUSPENDED event:

Internal transfer notification events are triggered when any internal Highnote transfer transitions states. Internal transfer types represent the direction of money movement within Highnote, including:

• From a funding financial account to a payment card financial account
• From a payment card financial account to a funding financial account
• Between financial accounts

The following table includes some of the fields you may see in an internal transfer notification event response. Note that this table does not contain all response fields. For a full list of response fields, refer to the API Reference.

Internal transfer events are triggered to denote a transfer between Financial Accounts. Depending on the use case for your card program, these transfers can be configured for a variety of financial account types. The following notification events are supported:

The following payload is an example of a notification sent for the event, INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_PENDING:

Financial account statement events are triggered when a statement is ready for a financial account. You can subscribe to the following event to inform you when a statement is ready:

The following payload is an example notification response from a FINANCIAL_ACCOUNT_STATEMENT_READY event:

Internal transfers from funding financial account events are triggered when the internal transfer transitions states. The following notification events are supported:

The following payload is an example of a notification sent for the event, INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDING:

Internal transfer from payment card financial account events are triggered when an internal transfer transitions states. The following notification events are supported:

The following payload is an example of a notification sent for the event, INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_PENDING:

NOTIFICATION_ACTIVATION events are ignored if provided as a subscription event name when adding a webhook.

Notification activation events are sent to your webhook to verify it's been set up correctly. This event will fire on the initial creation and when you attempt to reactivate a webhook.

The following payload provides an example notification event response from a NOTIFICATION_ACTIVATION event:

Payroll advance notification events are triggered when the following payroll advance events occur:

• Repayment completed
• Write-off occurs

The following table provides an overview of some of the fields you may see in a payroll advance notification event response. Note that this table does not contain all response fields. For a full list of response fields, refer to the API Reference:

Payroll advance repayment status events are triggered when a payroll repayment is processed.

The following response codes are returned from a complete payroll repayment status event:

The following payload provides an example response from a PAYROLL_ADVANCE_REPAYMENT_COMPLETED event with a PARTIALLY_REPAID status response:

A payroll advance write off status event is sent when a payroll advance amount is written off.

The following payload provides an example response body for a PAYROLL_ADVANCE_WRITE_OFF_COMPLETED event:

Payment card notification events are triggered for various payment card-related events.

The following table provides an overview of some of the fields you may see in payment card notification event responses. Note that this table does not contain all response fields. For a full list of fields, see the API Reference:

Payment card status events are triggered when a payment card transitions states. The following notification events are available for payment card statuses:

The following payload provides an example response body for a PAYMENT_CARD_ACTIVATED event:

Payment card authorization events are triggered when a transaction is authorized or transitions states. The following types of notification events are available for payment card authorizations:

The following payload provides an example response body from a PAYMENT_CARD_AUTHORIZATION_APPROVED event:

Payment card authorization and clear events are triggered when a transaction is authorized and cleared or transitions states. The following notification events are available for payment card authorization and clear events:

The following payload provides an example of a PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APROVED event:

Payment card cleared events are triggered when a transaction made using a payment card is cleared.

The following payload provides an example response body for a PAYMENT_CARD_CLEARED event:

Payment card verification events are triggered when a verification is either approved or denied. The following notification events are available for payment card verification:

The following payload provides an example response body for a PAYMENT_CARD_VERIFICATION_APPROVED event:

The payment card transaction enhanced data event is received is enhanced data is received from the card network.

The following payload provides an example response body for a PAYMENT_CARD_ENHANCED_DATA_RECEIVED event:

Physical card order notification events are triggered for various physical card order-related events.

The following table provides an overview of some fields you may see in a physical card order notification event response. Note that this table does not contain all response fields. For a full list, see the API Reference:

Physical card fulfillment events are triggered when a physical payment card shipment fulfillment changes states. The following notification events are available for physical card fulfillment:

The following payload provides an example response body for a PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIPPED event:

Physical card group order events are triggered when a group card order shipment ships or fails. The following notification events are available for physical card group orders:

The following payload provides an example response body for a PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIPPED event: