Skip to main content

Events Reference

Overview

This guide is a reference for all Highnote notification events, organized by domain.

When you query for notification events, the Highnote API returns a NotificationEvent object. This object contains:

  • A name field — a NotificationEventName enum value that identifies the event type, such as ORIGINATED_ACH_TRANSFER_INITIATED.
  • A node field — a NotificationEventNode union type that contains the event details.

The tables below list both the name value you filter on when subscribing to events, and the event object you query for event details.

Node patterns

The node field follows one of two patterns depending on the domain:

  • Dedicated event objects — Each name value maps to its own event object with event-specific fields. For example, ORIGINATED_ACH_TRANSFER_INITIATED returns an OriginatedAchTransferInitiatedEvent node. In your notification event query, you can use inline fragments on __typename to select fields specific to each event type.
  • Shared domain object — Multiple name values share the same node object type. For example, CARD_PRODUCT_APPLICATION_APPROVED and CARD_PRODUCT_APPLICATION_DENIED both return an AccountHolderCardProductApplication node. Because the node type is the same regardless of which state change occurred, use the name field to determine what happened, and query the shared object for the entity's current state.

ACH transfers

Highnote organizes ACH transfer types by initiator. Highnote initiates "originated" ACH transfers, and external parties initiate "non-originated" ACH transfers. Both types can move funds in either direction (into or out of Highnote accounts) depending on the use case.

The following table describes each ACH transfer type and its direction of money movement. For more, see the ACH transfers docs.

TypeDirectionDescription
Originated ACH transferPull (Debit)Highnote originates an ACH instruction to pull funds from an external bank account into a Highnote financial account
Push (Credit)Highnote originates an ACH instruction to push funds from a Highnote financial account to an external bank account
Non-originated ACH transferPull (Debit)An external bank initiates an ACH instruction on their platform to pull funds from a Highnote financial account.
Push (Credit)An external bank initiates an ACH instruction on their platform to push funds from the external bank to a Highnote financial account

The following table describes some of the fields you may see in an ACH notification event response. For a full list of response fields, refer to the API Reference.

FieldDescription
typeThe direction of the transfer, PUSH (pushing funds from a Highnote financial account to an external account) or PULL (pulling funds from an external account to a Highnote financial account)
amountThe amount of the ACH transfer
companyEntryDescriptionDescription of the type of ACH provided by the originator of the ACH transfer
companyIdentifierAn alphanumeric code used to identify the originator of the ACH transfer
companyNameName of the company that initiated the ACH transfer
traceNumberA unique 15 digit number assigned by the originator to identify the transfer
purposeDescribes the purpose of the transfer, for example, deposit
sameDayDescribes transfer processing speed. Nacha same day transfer limit is up to $1 million
signThe impact of the transfer on a Highnote financial account
statusRepresents the status of the ACH transfer, including a failure reason if applicable

Originated ACH transfer

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:

Notification Event NameEventDescription
ORIGINATED_ACH_TRANSFER_INITIATEDObjectACH transfer initiated.
ORIGINATED_ACH_TRANSFER_PENDINGObjectACH transfer is pending.
ORIGINATED_ACH_TRANSFER_PROCESSINGObjectACH transfer sent to the external financial institution.
ORIGINATED_ACH_TRANSFER_PROCESSEDObjectACH transfer processed and reflected on the financial account.
ORIGINATED_ACH_TRANSFER_FAILEDObjectACH transfer failed.
ORIGINATED_ACH_TRANSFER_RETURNEDObjectReturn received from the external financial institution.
ORIGINATED_ACH_TRANSFER_CANCELEDObjectACH transfer canceled.
Example payload: ORIGINATED_ACH_TRANSFER_INITIATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-08-26T18:40:34.999Z",
"expiresAt": "2024-09-25T18:40:34.999Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "ORIGINATED_ACH_TRANSFER_INITIATED",
"node": {
"__typename": "OriginatedAchTransferInitiatedEvent",
"createdAt": "2024-08-26T18:40:32.481Z",
"id": "ACH_TRANSFER_EVENT_ID",
"transfer": {
"__typename": "OriginatedAchTransfer",
"amount": {
"__typename": "Amount",
"currencyCode": "USD",
"decimalPlaces": 2,
"value": 15000
},
"cardProduct": {
"__typename": "CardProduct",
"id": "CARD_PRODUCT_ID"
},
"companyEntryDescription": "entrydesc",
"companyIdentifier": "1852922649",
"companyName": "HIGHNOTEPLATFORM",
"createdAt": "2024-08-26T18:40:32.481Z",
"effectiveEntryDate": "2024-08-27",
"expectedProcessedAt": "2024-08-30T03:00:00.000Z",
"fromFinancialAccount": {
"__typename": "ExternalFinancialBankAccount",
"id": "EXTERNAL_BANK_ACCOUNT_ID"
},
"holdStatus": "NO_HOLDS",
"holdType": "UNSPECIFIED",
"id": "ELECTRONIC_FUNDS_TRANSFER_ID",
"individualIdentificationNumber": "id",
"individualName": "name",
"paymentRelatedInformation": "Payment for services rendered",
"purpose": "DEPOSIT",
"sameDay": true,
"sign": "POSITIVE",
"status": "INITIATED",
"toFinancialAccount": {
"__typename": "FinancialAccount",
"id": "FINANCIAL_ACCOUNT_ID"
},
"type": "PULL",
"updatedAt": "2024-08-26T18:40:32.491Z"
}
}
}
},
"extensions": {
"signatureTimestamp": 1724697637357
}
}

Non-originated ACH transfer

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:

Notification Event NameEventDescription
NON_ORIGINATED_ACH_TRANSFER_RECEIVEDObjectACH transfer received from an external financial institution.
NON_ORIGINATED_ACH_TRANSFER_PROCESSEDObjectACH transfer processed.
NON_ORIGINATED_ACH_TRANSFER_FAILEDObjectACH transfer failed.
NON_ORIGINATED_ACH_TRANSFER_RETURNEDObjectACH transfer returned.
Example payload: NON_ORIGINATED_ACH_TRANSFER_RECEIVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-08-26T18:41:31.421Z",
"expiresAt": "2024-09-25T18:41:31.421Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "NON_ORIGINATED_ACH_TRANSFER_RECEIVED",
"node": {
"__typename": "NonOriginatedAchTransferReceivedEvent",
"createdAt": "2024-08-26T18:41:29.208Z",
"id": "ACH_TRANSFER_ID",
"transfer": {
"__typename": "NonOriginatedAchTransfer",
"amount": {
"__typename": "Amount",
"currencyCode": "USD",
"decimalPlaces": 2,
"value": 30101
},
"cardProduct": {
"__typename": "CardProduct",
"id": "CARD_PRODUCT_ID"
},
"companyEntryDescription": "entrydesc",
"companyIdentifier": "0123456789",
"companyName": "HIGHNOTETESTING",
"createdAt": "2024-08-26T18:41:29.208Z",
"financialAccount": {
"__typename": "FinancialAccount",
"id": "FINANCIAL_ACCOUNT_ID"
},
"holdStatus": "NO_HOLDS",
"holdType": "UNSPECIFIED",
"id": "ELECTRONIC_FUNDS_TRANSFER_ID",
"individualIdentificationNumber": "id",
"individualName": "name",
"paymentRelatedInformation": "Payment for services rendered",
"purpose": "DEPOSIT",
"settlementDate": "2024-08-26",
"sign": "POSITIVE",
"status": "RECEIVED",
"traceNumber": "111111118215827",
"type": "PUSH",
"updatedAt": "2024-08-26T18:41:29.554Z"
}
}
}
},
"extensions": {
"signatureTimestamp": 1724697692414
}
}

ACH transfer hold

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:

Notification Event NameEventDescription
ACH_TRANSFER_HOLD_ADDEDObjectHold added to an ACH transfer.
ACH_TRANSFER_HOLD_REMOVEDObjectHold removed from an ACH transfer.
Example payload: ACH_TRANSFER_HOLD_ADDED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-08-26T18:43:47.305Z",
"expiresAt": "2024-09-25T18:43:47.305Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "ACH_TRANSFER_HOLD_ADDED",
"node": {
"__typename": "AchTransferHoldAddedEvent",
"fromHoldStatus": "NO_HOLDS",
"fromHoldType": "UNSPECIFIED",
"holdStatusAddedAt": "2024-08-26T18:43:44.415Z",
"id": "ACH_TRANSFER_ID",
"transfer": {
"__typename": "OriginatedAchTransfer",
"amount": {
"__typename": "Amount",
"currencyCode": "USD",
"decimalPlaces": 2,
"value": 15000
},
"cardProduct": {
"__typename": "CardProduct",
"id": "CARD_PRODUCT_ID"
},
"companyEntryDescription": "entrydesc",
"companyIdentifier": "1852922649",
"companyName": "HIGHNOTEPLATFORM",
"createdAt": "2024-08-26T18:43:35.151Z",
"effectiveEntryDate": "2024-08-27",
"expectedProcessedAt": "2024-08-30T03:00:00.000Z",
"fromFinancialAccount": {
"__typename": "ExternalFinancialBankAccount",
"id": "EXTERNAL_BANK_ACCOUNT_ID"
},
"holdStatus": "ON_HOLD",
"holdType": "RISK",
"id": "ELECTRONIC_FUNDS_TRANSFER_ID",
"individualIdentificationNumber": "id",
"individualName": "name",
"lastHoldStatusChangedAt": "2024-08-26T18:43:44.415Z",
"paymentRelatedInformation": "Payment for services rendered",
"purpose": "DEPOSIT",
"sameDay": true,
"sign": "POSITIVE",
"status": "PENDING",
"toFinancialAccount": {
"__typename": "FinancialAccount",
"id": "FINANCIAL_ACCOUNT_ID"
},
"type": "PULL",
"updatedAt": "2024-08-26T18:43:42.699Z"
}
}
}
},
"extensions": {
"signatureTimestamp": 1724697829334
}
}

Application status

Triggered when a card product application transitions between statuses. Includes account holder and authorized user applications.

FieldDescription
applicationStateThe status of the application
updatedAtThe time the application status was last updated

Account holder applications

All account holder application events return an AccountHolderCardProductApplication event object.

Notification Event NameDescription
CARD_PRODUCT_APPLICATION_APPROVEDApplication approved.
CARD_PRODUCT_APPLICATION_CLOSEDApplication closed.
CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FRAUD_ALERTApplication requires account holder to verify identity due to a credit report fraud alert.
CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FREEZEApplication requires account holder to unfreeze their credit bureau report.
CARD_PRODUCT_APPLICATION_DENIEDApplication denied.
CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTEDDocument upload sessions requested for the application.
CARD_PRODUCT_APPLICATION_IDENTITY_UPDATE_REQUESTEDIdentity update sessions requested for the application.
CARD_PRODUCT_APPLICATION_MANUAL_REVIEWApplication requires manual review.
CARD_PRODUCT_APPLICATION_OFFER_MANAGEMENT_REQUESTEDApplication offers need to be decisioned.
CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTEDApplication requires an underwriting decision.
Example payload: CARD_PRODUCT_APPLICATION_APPROVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2022-02-23T22:22:03.830Z",
"name": "CARD_PRODUCT_APPLICATION_APPROVED",
"node": {
"__typename": "AccountHolderCardProductApplication",
"id": "ACCOUNT_HOLDER_CARD_PRODUCT_APPLICATION_ID",
"createdAt": "2022-02-23T22:21:58.759Z",
"updatedAt": "2022-02-23T22:22:01.475Z",
"applicationState": {
"status": "APPROVED"
}
}
}
},
"extensions": {
"requestId": "b5920a0f-ce66-9b8f-964a-6b5166e88dd2"
}
}
Example payload: CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FRAUD_ALERT
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2022-02-23T22:22:03.830Z",
"name": "CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FRAUD_ALERT",
"node": {
"__typename": "AccountHolderCardProductApplication",
"id": "ACCOUNT_HOLDER_CARD_PRODUCT_APPLICATION_ID",
"createdAt": "2022-02-23T22:21:58.759Z",
"updatedAt": "2022-02-23T22:22:01.475Z",
"applicationState": {
"status": "PENDING"
}
}
}
},
"extensions": {
"requestId": "REQUEST_ID"
}
}
Example payload: CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FREEZE
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2022-02-23T22:22:03.830Z",
"name": "CARD_PRODUCT_APPLICATION_CREDIT_REPORT_FREEZE",
"node": {
"__typename": "AccountHolderCardProductApplication",
"id": "ACCOUNT_HOLDER_CARD_PRODUCT_APPLICATION_ID",
"createdAt": "2022-02-23T22:21:58.759Z",
"updatedAt": "2022-02-23T22:22:01.475Z",
"applicationState": {
"status": "PENDING"
}
}
}
},
"extensions": {
"requestId": "REQUEST_ID"
}
}
Example payload: CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2023-02-08T15:41:56.871Z",
"name": "CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTED",
"expiresAt": "2023-03-10T15:41:56.873Z",
"node": {
"id": "APPLICATION_ID",
"applicationState": {
"status": "IN_REVIEW"
},
"updatedAt": "2023-02-08T15:41:54.831Z",
"__typename": "AccountHolderCardProductApplication",
"createdAt": "2023-02-07T21:27:06.955Z",
"agentServicingRestrictedDetails": {
"memo": "Document upload sessions"
}
},
"id": "NOTIFICATION_EVENT_ID"
}
},
"extensions": {
"signatureTimestamp": 1675871903487
}
}
Example payload: CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-12-12T16:32:49.125Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTED",
"node": {
"__typename": "AccountHolderCardProductApplication",
"applicationState": {
"status": "PENDING"
},
"createdAt": "2022-12-12T16:32:44.499Z",
"id": "APPLICATION_ID",
"updatedAt": "2022-12-12T16:32:44.499Z"
}
}
},
"extensions": {
"signatureTimestamp": 1670862772620
}
}

Authorized user applications

All authorized user application events return an AuthorizedUserCardProductApplication event object.

Notification Event NameDescription
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_APPROVEDAuthorized user application approved.
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_CLOSEDAuthorized user application closed.
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_DENIEDAuthorized user application denied.
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTEDDocument upload sessions requested for the authorized user application.
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_MANUAL_REVIEWAuthorized user application requires manual review.
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTEDAuthorized user application requires an underwriting decision.
Example payload: AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_APPROVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2022-02-23T22:22:03.830Z",
"name": "AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_APPROVED",
"node": {
"__typename": "AuthorizedUserCardProductApplication",
"id": "AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_ID",
"createdAt": "2022-02-23T22:21:58.759Z",
"updatedAt": "2022-02-23T22:22:01.475Z",
"applicationState": {
"status": "APPROVED"
}
}
}
},
"extensions": {
"requestId": "ID"
}
}

Acquiring card payment

Triggered during the lifecycle of a payment transaction processed through your acquiring integration. These events track authorizations, captures, clearing, settlement, disbursement, reversals, and verifications.

Transaction lifecycle

Notification Event NameEventDescription
CARD_PAYMENT_AUTHORIZED_EVENTObjectPayment transaction authorized.
CARD_PAYMENT_AUTHORIZATION_DECLINED_EVENTObjectPayment transaction authorization declined.
CARD_PAYMENT_INCREMENTAL_AUTHORIZED_EVENTObjectIncremental authorization approved.
CARD_PAYMENT_INCREMENTAL_AUTHORIZATION_DECLINED_EVENTObjectIncremental authorization declined.
CARD_PAYMENT_REVERSED_EVENTObjectPayment transaction reversed.
CARD_PAYMENT_REVERSAL_DECLINED_EVENTObjectPayment transaction reversal declined.
CARD_PAYMENT_CAPTURING_EVENTObjectPayment transaction capture initiated.
CARD_PAYMENT_CAPTURE_PROCESSING_EVENTObjectPayment transaction capture is processing.
CARD_PAYMENT_CAPTURE_DECLINED_EVENTObjectPayment transaction capture declined.
CARD_PAYMENT_SETTLED_EVENTObjectPayment transaction settled.
CARD_PAYMENT_CLEARED_EVENTObjectPayment transaction cleared through the card network.
CARD_PAYMENT_CLEARING_FAILED_EVENTObjectPayment transaction clearing failed.
CARD_PAYMENT_DISBURSED_EVENTObjectSettled funds disbursed to the merchant.
CARD_PAYMENT_PAYOUT_EVENTObjectPayment transaction payout settled and deposited.
PAYOUT_TRANSFER_COMPLETED_EVENTObjectPayout transfer completed.

Verification

Notification Event NameEventDescription
CARD_PAYMENT_VERIFIED_EVENTObjectCard verification transaction approved.
CARD_PAYMENT_VERIFICATION_DECLINED_EVENTObjectCard verification transaction declined.

Dispute

All acquiring dispute events return a CardPaymentDispute event object.

Notification Event NameDescription
CARD_PAYMENT_DISPUTE_ACTION_REQUIREDChargeback initiated against a merchant transaction and needs attention.
Example payload: CARD_PAYMENT_DISPUTE_ACTION_REQUIRED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2026-04-22T16:23:44.690Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "CARD_PAYMENT_DISPUTE_ACTION_REQUIRED",
"node": {
"__typename": "CardPaymentDispute",
"id": "CARD_PAYMENT_DISPUTE_ID",
"cardPaymentDisputeStatus": "IN_REVIEW",
"category": "FRAUD",
"networkReason": {
"code": "10.4",
"description": "Other Fraud"
},
"stages": [
{
"__typename": "CardPaymentDisputeChargebackStage",
"amount": {
"__typename": "Amount",
"value": 7500,
"currencyCode": "USD",
"decimalPlaces": 2
},
"responseDueAt": "2026-05-17T00:00:00.000Z"
}
],
"transactionEvent": {
"__typename": "CardPaymentClearedEvent",
"amount": {
"__typename": "Amount",
"value": 10000,
"currencyCode": "USD",
"decimalPlaces": 2
},
"createdAt": "2026-01-15T00:00:00.000Z",
"updatedAt": "2026-01-16T00:00:00.000Z",
"acquirerReferenceNumber": "24445551234567890123456",
"paymentTransaction": {
"__typename": "PaymentDebitTransaction",
"id": "PAYMENT_TRANSACTION_ID"
}
},
"createdAt": "2026-01-15T00:00:00.000Z"
}
}
},
"extensions": {
"signatureTimestamp": 1745338424690
}
}

Chargebacks and disputes

Triggered when dispute cases or chargebacks change status, or when provisional or dispute credits are issued or revoked.

Disputes

All dispute events return a PaymentCardTransactionDispute event object.

Notification Event NameDescription
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_INITIATEDDispute case initiated.
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_RESOLVED_WITH_DISPUTE_CREDITDispute case resolved with dispute credit.
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CASE_CARDHOLDER_WONDispute case resolved in cardholder's favor.
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CASE_CARDHOLDER_LOSTDispute case resolved against cardholder.
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_REJECTEDDispute case rejected.
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CANCELLEDDispute case cancelled.
PAYMENT_CARD_TRANSACTION_DISPUTE_PROVISIONAL_CREDIT_ISSUEDProvisional credit issued for a dispute.
PAYMENT_CARD_TRANSACTION_DISPUTE_PROVISIONAL_CREDIT_REVOKEDProvisional credit revoked for a dispute.
PAYMENT_CARD_TRANSACTION_DISPUTE_PROVISIONAL_CREDIT_WONProvisional credit finalized in cardholder's favor.
PAYMENT_CARD_TRANSACTION_DISPUTE_CREDIT_ISSUEDDispute credit issued.
PAYMENT_CARD_TRANSACTION_DISPUTE_CREDIT_REVERSEDDispute credit reversed.
Example payload: PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_INITIATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "",
"id": "",
"name": "PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_INITIATED",
"node": {
"__typename": "PaymentCardTransactionDispute",
"id": "DISPUTE_CASE_ID",
"status": "INITIATED",
"createdAt": "2023-03-23T16:57:43.752Z",
"updatedAt": "2023-03-23T16:57:43.752Z"
}
}
},
"extensions": {
"signatureTimestamp": 1666245348543
}
}
Example payload: PAYMENT_CARD_TRANSACTION_DISPUTE_PROVISIONAL_CREDIT_ISSUED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "",
"id": "",
"name": "PAYMENT_CARD_TRANSACTION_DISPUTE_PROVISIONAL_CREDIT_ISSUED",
"node": {
"__typename": "PaymentCardTransactionDispute",
"id": "csmdi_22fbdb3d6590e640fa98056b76b431c87f",
"status": "IN_PROGRESS",
"createdAt": "2023-03-23T16:57:43.752Z",
"updatedAt": "2023-03-23T16:57:43.752Z"
}
}
},
"extensions": {
"signatureTimestamp": 1666245348543
}
}

Chargebacks

All chargeback events return a PaymentCardTransactionChargeback event object.

Notification Event NameDescription
PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUEDChargeback provisional credit issued.
PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_REVOKEDChargeback provisional credit revoked.
Example payload: PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "",
"id": "",
"name": "PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUED",
"node": {
"__typename": "PaymentCardTransactionChargeback",
"id": "CHARGEBACK_ID",
"dispute": {
"id": "DISPUTE_CASE_ID"
},
"creditStatus": "PROVISIONAL_CREDIT_ISSUED",
"status": "RECEIVED",
"createdAt": "2023-03-23T16:57:43.752Z",
"updatedAt": "2023-03-23T16:57:43.752Z"
}
}
},
"extensions": {
"signatureTimestamp": 1666245348543
}
}

Check payment

Triggered during the lifecycle of a check payment, from funding through shipment, delivery, and completion.

All check payment events return a CheckPaymentEvent event object.

Notification Event NameDescription
CHECK_PAYMENT_EVENT_FUNDING_PENDINGCheck payment initiated, pending funding.
CHECK_PAYMENT_EVENT_FUNDING_STARTEDCheck funding initiated.
CHECK_PAYMENT_EVENT_FUNDING_COMPLETEDCheck funded, pending disbursement.
CHECK_PAYMENT_EVENT_FUNDING_DISBURSEDCheck funds disbursed to external accounts.
CHECK_PAYMENT_EVENT_PENDING_PROCESSING_BY_HIGHNOTECheck pending processing by Highnote.
CHECK_PAYMENT_EVENT_PROCESSING_BY_HIGHNOTECheck is being processed by Highnote.
CHECK_PAYMENT_EVENT_PROCESSED_BY_HIGHNOTECheck processed by Highnote.
CHECK_PAYMENT_EVENT_PRINTEDCheck printed.
CHECK_PAYMENT_EVENT_PENDING_SHIPMENTCheck printed, pending shipment.
CHECK_PAYMENT_EVENT_SHIPPEDCheck shipped.
CHECK_PAYMENT_EVENT_PAIDCheck paid out.
CHECK_PAYMENT_EVENT_COMPLETEDCheck delivered and cashed or deposited.
CHECK_PAYMENT_EVENT_ON_RISK_HOLDCheck placed on hold for risk assessment.
CHECK_PAYMENT_EVENT_VOIDEDCheck voided.
CHECK_PAYMENT_EVENT_FAILEDCheck payment failed.
CHECK_PAYMENT_EVENT_REVERSAL_INITIATEDCheck reversal initiated due to voiding or failure.
CHECK_PAYMENT_EVENT_REVERSAL_COMPLETEDCheck reversal completed.

Collaborative application decisioning

If you use collaborative application decisioning, subscribe to CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTED to receive applications that need your underwriting decision. This event is listed under Account holder applications and Authorized user applications.

Credit limit

Triggered when a credit limit change request changes status.

Notification Event NameEventDescription
CREDIT_LIMIT_CHANGE_REQUEST_STATUS_CHANGEDObjectCredit limit change request status changed.
Example payload: INCREASE INITIATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2024-01-01T00:00:00.000Z",
"name": "CREDIT_LIMIT_CHANGE_REQUEST_STATUS_CHANGED",
"node": {
"__typename": "CreditLimitChangeRequest",
"id": "CREDIT_LIMIT_CHANGE_REQUEST_ID",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"financialAccountId": "ac_1234",
"creditLimitChangeRequestType": "INCREASE",
"creditLimitChangeRequestStatus": "INITIATED",
"creditLimitChangeRequestFailureReason": null
}
}
},
"extensions": {
"requestId": "b5920a0f-ce66-9b8f-964a-6b5166e88dd2"
}
}
Example payload: INCREASE FAILED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "NOTIFICATION_EVENT_ID",
"createdAt": "2024-01-01T00:00:00.000Z",
"name": "CREDIT_LIMIT_CHANGE_REQUEST_STATUS_CHANGED",
"node": {
"__typename": "CreditLimitChangeRequest",
"id": "CREDIT_LIMIT_CHANGE_REQUEST_ID",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"financialAccountId": "ac_1234",
"creditLimitChangeRequestType": "INCREASE",
"creditLimitChangeRequestStatus": "FAILED",
"creditLimitChangeRequestFailureReason": "NSF"
}
}
},
"extensions": {
"requestId": "b5920a0f-ce66-9b8f-964a-6b5166e88dd2"
}
}

Digital wallet token status

Triggered when a card digital wallet token (Apple Pay, Google Wallet) changes status.

Notification Event NameEventDescription
CARD_DIGITAL_WALLET_TOKEN_ACTIVATEDObjectDigital wallet token activated.
CARD_DIGITAL_WALLET_TOKEN_SUSPENDEDObjectDigital wallet token suspended.
CARD_DIGITAL_WALLET_TOKEN_TERMINATEDObjectDigital wallet token terminated.
Example payload: DIGITAL_WALLET_TOKEN_ACTIVATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-12-12T16:32:49.125Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "DIGITAL_WALLET_TOKEN_ACTIVATED",
"node": {
"__typename": "CardDigitalWalletTokenEvent",
"paymentCardId": "PAYMENT_CARD_ID",
"tokenStatus": "ACTIVE",
"tokenPreviousStatus": "SUSPENDED",
"reason": "DEVICE_FOUND"
}
}
},
"extensions": {
"signatureTimestamp": 1670862772620
}
}

Document upload

Triggered during the document upload lifecycle, including on-demand document requests.

Notification Event NameEventDescription
DOCUMENT_UPLOAD_REQUESTED_EVENTObjectAn on-demand document upload session was created. See Request Documents On-Demand.
DOCUMENT_UPLOAD_SESSION_COMPLETE_EVENTObjectA document upload session moved into a terminal state.
FILE_UPLOAD_COMPLETE_EVENTObjectA document upload link completed its upload.

External bank account

Triggered when a verified external bank account is added, removed, or fails to link.

Notification Event NameEventDescription
EXTERNAL_BANK_ACCOUNT_ADDEDObjectVerified external bank account created.
EXTERNAL_BANK_ACCOUNT_REMOVEDObjectVerified external bank account disconnected.
LINK_VERIFIED_EXTERNAL_BANK_ACCOUNT_FAILEDObjectVerified external bank account creation failed.
Example payload: EXTERNAL_BANK_ACCOUNT_REMOVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-11-04T06:53:59.966Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "EXTERNAL_BANK_ACCOUNT_REMOVED",
"node": {
"__typename": "ExternalBankAccountRemovedEvent",
"id": "EXTERNAL_BANK_ACCOUNT_REMOVED_EVENT_ID",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"accountName": "Plaid Checking",
"accountStatus": "CLOSED",
"createdAt": "2022-11-04T06:53:27.627Z",
"externalBankAccountDetail": {
"__typename": "ExternalBankAccountDetail",
"id": "EXTERNAL_BANK_ACCOUNT_ID",
"createdAt": "2022-11-04T06:53:27.627Z",
"last4": "9606",
"routingNumber": "011401533",
"type": "CHECKING",
"updatedAt": "2022-11-04T06:53:27.672Z"
},
"provider": "SIMULATED",
"removedAt": "2022-11-04T06:53:58.700Z",
"updatedAt": "2022-11-04T06:53:58.737Z"
}
}
},
"extensions": {
"signatureTimestamp": 1667544843895
}
}

Fee transfer

Triggered when a fee is charged or reversed on a financial account.

Notification Event NameEventDescription
FEE_CHARGE_EVENTObjectFee charged.
FEE_REVERSAL_EVENTObjectFee reversed.
Example payload: FEE_CHARGE_EVENT
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_3a298028eb3f6de6f0be97e4d81434f0",
"name": "FEE_CHARGE_EVENT",
"createdAt": "2025-06-13T21:46:19.621Z",
"node": {
"__typename": "FeeChargeEvent",
"id": "fxtre_22is001d6b701c5de5e41c7a4a45da724f20c7f",
"feeActivityType": "VIRTUAL_CARD_REISSUE_FEE",
"originatingAccount": {
"__typename": "FinancialAccount",
"id": "ac_c02293c2e80657be40018f0c05eee6ef62fd"
},
"receivingAccount": {
"__typename": "FinancialAccount",
"id": "ac_og22d44c3eb6e6f14929954ba278ffcd84ec"
},
"status": {
"__typename": "NonFailureFeeTransferStatus",
"status": "COMPLETE"
},
"transferDate": "2025-06-13T21:46:15.839Z",
"feeTransferAmount": {
"currencyCode": "USD",
"value": 500
}
},
"expiresAt": "2025-07-13T21:46:19.622Z"
}
},
"extensions": {
"signatureTimestamp": 1749851179952
}
}
Example payload: FEE_REVERSAL_EVENT
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_e865d0cdd17de956e92a9b3cee8d7fcc",
"name": "FEE_REVERSAL_EVENT",
"createdAt": "2025-06-13T21:46:55.921Z",
"node": {
"__typename": "FeeReversalEvent",
"id": "fxtre_22is001a074a8835a9b46a1ab158723d04f8f4a",
"feeActivityType": "VIRTUAL_CARD_REISSUE_FEE",
"originatingAccount": {
"__typename": "FinancialAccount",
"id": "ac_og22d44c3eb6e6f14929954ba278ffcd84ec"
},
"receivingAccount": {
"__typename": "FinancialAccount",
"id": "ac_c02293c2e80657be40018f0c05eee6ef62fd"
},
"status": {
"__typename": "NonFailureFeeTransferStatus",
"status": "COMPLETE"
},
"transferDate": "2025-06-13T21:46:53.632Z",
"feeTransferAmount": {
"currencyCode": "USD",
"value": 500
},
"sourceFeeTransferEvent": {
"__typename": "FeeTransferEvent",
"id": "fxtre_22is001d6b701c5de5e41c7a4a45da724f20c7f"
}
},
"expiresAt": "2025-07-13T21:46:55.921Z"
}
},
"extensions": {
"signatureTimestamp": 1749851216256
}
}

Financial account attributes

Triggered when a financial account attribute is added or removed. Attributes indicate account conditions such as delinquency, charge-off, or suspension.

All financial account attribute events return a FinancialAccount event object.

Notification Event NameDescription
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_CHARGE_OFFCharge-off attribute added.
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_CHARGE_OFFCharge-off attribute removed.
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_CLOSED_WITH_BALANCEClosed with balance attribute added.
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_CLOSED_WITH_BALANCEClosed with balance attribute removed.
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENTDelinquent attribute added.
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENTDelinquent attribute removed.
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT_SUSPENDEDDelinquent suspended attribute added.
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENT_SUSPENDEDDelinquent suspended attribute removed.
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_PROGRAM_OWNER_INITIATED_SUSPENSIONProgram owner initiated suspension attribute added.
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_PROGRAM_OWNER_INITIATED_SUSPENSIONProgram owner initiated suspension attribute removed.
Example payload: FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2023-02-15T23:34:16.399Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT",
"node": {
"__typename": "FinancialAccount",
"accountAttributes": ["DELINQUENT"],
"accountStatus": "ACTIVE",
"createdAt": "2023-02-15T23:34:03.095Z",
"externalId": "EXTERNAL_ID",
"id": "FINANCIAL_ACCOUNT_ID",
"name": "Test PIF Commercial Credit Account"
}
}
},
"extensions": {
"signatureTimestamp": 1676504056802
}
}

Financial account statement

Triggered when a financial account statement is ready or a payment due date is approaching.

Notification Event NameEventDescription
FINANCIAL_ACCOUNT_STATEMENT_READYObjectFinancial account statement is ready.
UPCOMING_STATEMENT_DUE_DATEObjectA statement payment due date is approaching.
Example payload: FINANCIAL_ACCOUNT_STATEMENT_READY
{
"data": {
"node": {
"__typename": "FinancialAccountStatementReadyEvent",
"id": "STATEMENT_ID",
"financialAccountId": "ACCOUNT_ID",
"createdAt": "2024-06-06T12:34:56.789Z"
}
},
"extensions": {
"signatureTimestamp": 1727990400000
}
}
Example payload: UPCOMING_STATEMENT_DUE_DATE
{
"data": {
"node": {
"__typename": "UpcomingStatementDueDateEvent",
"createdAt": "2026-04-25T08:00:00.000Z",
"financialAccount": {
"__typename": "FinancialAccount",
"id": "<FINANCIAL_ACCOUNT_ID>"
},
"numberOfDaysUntilDueDate": 5,
"paymentDueDayOfMonth": 15,
"upcomingStatementDueDate": "2026-04-30T00:00:00.000Z"
}
},
"extensions": {
"signatureTimestamp": 1777104000000
}
}

Financial account status

Triggered when a financial account transitions between statuses.

Notification Event NameEventDescription
ACCOUNT_STATUS_ACTIVEObjectFinancial account entered ACTIVE status.
ACCOUNT_STATUS_CLOSEDObjectFinancial account has been closed.
ACCOUNT_STATUS_PENDING_CLOSUREObjectFinancial account entered PENDING_CLOSURE status.
ACCOUNT_STATUS_SUSPENDEDObjectFinancial account entered SUSPENDED status.
ACCOUNT_STATUS_UNDER_REVIEWObjectFinancial account entered UNDER_REVIEW status.
Example payload: ACCOUNT_STATUS_SUSPENDED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-10-20T05:55:45.841Z",
"id": "nee_6f9f952070c8d0a6c446e3764bc905e3",
"name": "ACCOUNT_STATUS_SUSPENDED",
"node": {
"__typename": "AccountStatusSuspendedEvent",
"accountName": "My Sample Account",
"createdAt": "2022-10-20T05:55:40.505Z",
"externalId": "D5LDSYLPMR",
"id": "ac_c022c3165221cf7546ca9db0ccd480831234"
}
}
},
"extensions": {
"signatureTimestamp": 1666245348543
}
}

Identity documents and updates

Triggered when identity verification documents are requested or identity information is updated for account holders, authorized persons, or beneficial owners.

Notification Event NameEventDescription
BUSINESS_ACCOUNT_HOLDER_IDENTITY_DOCUMENTS_REQUESTEDObjectIdentity documents requested for a business account holder.
BUSINESS_ACCOUNT_HOLDER_IDENTITY_UPDATEDObjectBusiness account holder identity updated.
BUSINESS_AUTHORIZED_PERSON_IDENTITY_DOCUMENTS_REQUESTEDObjectIdentity documents requested for an authorized person.
BUSINESS_AUTHORIZED_PERSON_IDENTITY_UPDATEDObjectAuthorized person identity updated.
BUSINESS_ULTIMATE_BENEFICIAL_OWNER_IDENTITY_DOCUMENTS_REQUESTEDObjectIdentity documents requested for an ultimate beneficial owner.
BUSINESS_ULTIMATE_BENEFICIAL_OWNER_IDENTITY_UPDATEDObjectUltimate beneficial owner identity updated.
PERSON_ACCOUNT_HOLDER_IDENTITY_DOCUMENTS_REQUESTEDObjectIdentity documents requested for a person account holder.
PERSON_ACCOUNT_HOLDER_IDENTITY_UPDATEDObjectPerson account holder identity updated.
Example payload: PERSON_ACCOUNT_HOLDER_IDENTITY_DOCUMENTS_REQUESTED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-07-03T17:41:20.785Z",
"expiresAt": "2024-08-02T17:41:20.785Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PERSON_ACCOUNT_HOLDER_IDENTITY_DOCUMENTS_REQUESTED",
"node": {
"createdAt": "2024-07-03T17:41:16.559Z",
"documentUploadSession": {
"__typename": "IdentityVerificationDocumentUploadSession",
"id": "DOCUMENT_UPLOAD_SESSION_ID"
},
"personAccountHolder": {
"__typename": "USPersonAccountHolder",
"id": "PERSON_ACCOUNT_HOLDER"
},
"reason": "CIP_VERIFICATION"
}
}
},
"extensions": {
"signatureTimestamp": 1720028482632
}
}
Example payload: PERSON_ACCOUNT_HOLDER_IDENTITY_UPDATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-05-15T19:37:00.917Z",
"expiresAt": "2024-06-14T19:37:00.917Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PERSON_ACCOUNT_HOLDER_IDENTITY_UPDATED",
"node": {
"__typename": "PersonAccountHolderIdentityUpdatedEvent",
"createdAt": "2024-05-15T19:36:59.225Z",
"personAccountHolder": {
"__typename": "USPersonAccountHolder",
"id": "ACCOUNT_HOLDER_ID"
},
"updateTypes": ["FULL_LEGAL_NAME"]
}
}
},
"extensions": {
"signatureTimestamp": 1715801821319
}
}

Instant network transfer

Instant Network Transfers (INTs) are implemented through Highnote's Unified Funds Transfer (UFT) framework. Instant Network Transfers use the UnifiedFundsTransfer API object to handle the technical processing of these card-to-card transactions. For events triggered during the lifecycle of a transfer itself, see Unified funds transfer below.

Capabilities

The events in this section are triggered when an Instant Network Transfer (INT) capability on a PaymentMethodToken changes status. INT capabilities determine whether a tokenized payment card can act as the destination of a push or the source of a pull. Highnote sends one notification per capability status change.

For conceptual information, see Capabilities in the Instant Network Transfer docs.

Notification Event NameEventDescription
PAYMENT_METHOD_CAPABILITY_STATUS_ENABLED_EVENTObjectINT capability moved to ENABLED.
PAYMENT_METHOD_CAPABILITY_STATUS_DISABLED_EVENTObjectINT capability moved to DISABLED.
PAYMENT_METHOD_CAPABILITY_STATUS_REQUIRES_REVIEW_EVENTObjectINT capability moved to REQUIRES_REVIEW. The card requires manual review by Highnote's Operations team before it can be used.
PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENTObjectINT capability previously in REQUIRES_REVIEW was reviewed. Inspect capability.status for the outcome (ENABLED or DISABLED).

Destination vs source capabilities

Because the capability field returns a PaymentCardInstrumentCapability union, inspect __typename to distinguish the destination capability from the source capability:

Status alias

Both members expose the same fields, including status and verificationPaymentTransaction. Highnote's webhook delivery aliases status per member — destinationStatus for destination capabilities, sourceStatus for source capabilities — so your handler receives a flat shape and can tell the two directions apart by key. The example payloads below reflect this delivery shape.

If you query a NotificationEvent directly via the GraphQL API rather than receive it via webhook, aliasing is your choice. The query below shows the same pattern:

... on PaymentMethodCapabilityEnabledEvent {
paymentMethodToken { id }
capability {
__typename
... on InstantNetworkTransferDestinationPaymentInstrumentCapability {
destinationStatus: status
createdAt
updatedAt
}
... on InstantNetworkTransferSourcePaymentInstrumentCapability {
sourceStatus: status
createdAt
updatedAt
}
}
}

Payloads

The example payloads below reflect the actual webhook delivery shape, with status aliased per direction.


Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_ENABLED_EVENT (destination)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_95af6a7374d43747ebe5cd8297d283ac",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_ENABLED_EVENT",
"createdAt": "2026-05-01T23:30:38.222Z",
"node": {
"__typename": "PaymentMethodCapabilityEnabledEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferDestinationPaymentInstrumentCapability",
"destinationStatus": "ENABLED",
"createdAt": "2026-05-01T23:30:10.716Z",
"updatedAt": "2026-05-01T23:30:10.716Z"
}
},
"expiresAt": "2026-06-30T23:30:38.222Z"
}
},
"extensions": {
"signatureTimestamp": 1777678238603
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_ENABLED_EVENT (source)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_389e720d1981622bb381d23f87b52c48",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_ENABLED_EVENT",
"createdAt": "2026-04-28T20:07:17.278Z",
"node": {
"__typename": "PaymentMethodCapabilityEnabledEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferSourcePaymentInstrumentCapability",
"sourceStatus": "ENABLED",
"createdAt": "2026-04-28T20:06:52.361Z",
"updatedAt": "2026-04-28T20:06:52.361Z"
}
},
"expiresAt": "2026-05-28T20:07:17.286Z"
}
},
"extensions": {
"signatureTimestamp": 1777406839540
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_DISABLED_EVENT (destination)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_bb611b55ff7e7b300e74de823e55e5f1",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_DISABLED_EVENT",
"createdAt": "2026-04-28T20:07:17.280Z",
"node": {
"__typename": "PaymentMethodCapabilityDisabledEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferDestinationPaymentInstrumentCapability",
"destinationStatus": "DISABLED",
"createdAt": "2026-04-28T20:06:52.355Z",
"updatedAt": "2026-04-28T20:06:52.355Z"
}
},
"expiresAt": "2026-05-28T20:07:17.286Z"
}
},
"extensions": {
"signatureTimestamp": 1777406839538
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_DISABLED_EVENT (source)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_87dcbf565a05d631e9ff2814547e7670",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_DISABLED_EVENT",
"createdAt": "2026-04-28T20:10:20.420Z",
"node": {
"__typename": "PaymentMethodCapabilityDisabledEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferSourcePaymentInstrumentCapability",
"sourceStatus": "DISABLED",
"createdAt": "2026-04-28T20:09:53.046Z",
"updatedAt": "2026-04-28T20:09:53.046Z"
}
},
"expiresAt": "2026-05-28T20:10:20.423Z"
}
},
"extensions": {
"signatureTimestamp": 1777407021225
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REQUIRES_REVIEW_EVENT (destination)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_c9f710caa3f06ccbbc6605199beae107",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REQUIRES_REVIEW_EVENT",
"createdAt": "2026-05-01T23:25:54.519Z",
"node": {
"__typename": "PaymentMethodCapabilityRequiresReviewEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferDestinationPaymentInstrumentCapability",
"destinationStatus": "REQUIRES_REVIEW",
"createdAt": "2026-05-01T23:25:29.543Z",
"updatedAt": "2026-05-01T23:25:29.543Z"
}
},
"expiresAt": "2026-06-30T23:25:54.521Z"
}
},
"extensions": {
"signatureTimestamp": 1777677955151
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REQUIRES_REVIEW_EVENT (source)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_9cf52cfa08f87311aa1516f676fd00d2",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REQUIRES_REVIEW_EVENT",
"createdAt": "2026-05-01T23:25:54.521Z",
"node": {
"__typename": "PaymentMethodCapabilityRequiresReviewEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferSourcePaymentInstrumentCapability",
"sourceStatus": "REQUIRES_REVIEW",
"createdAt": "2026-05-01T23:25:29.585Z",
"updatedAt": "2026-05-01T23:25:29.585Z"
}
},
"expiresAt": "2026-06-30T23:25:54.521Z"
}
},
"extensions": {
"signatureTimestamp": 1777677955071
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT (destination, enabled)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_af2a043cc3e76d3696a698df96bc8ffd",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT",
"createdAt": "2026-05-01T23:27:05.245Z",
"node": {
"__typename": "PaymentMethodCapabilityReviewedEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferDestinationPaymentInstrumentCapability",
"destinationStatus": "ENABLED",
"createdAt": "2026-05-01T23:26:48.671Z",
"updatedAt": "2026-05-01T23:26:48.671Z"
}
},
"expiresAt": "2026-06-30T23:27:05.245Z"
}
},
"extensions": {
"signatureTimestamp": 1777678025698
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT (source, enabled)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_ab62a5ef1139944f019ff2e3ebd70316",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT",
"createdAt": "2026-05-01T23:27:05.269Z",
"node": {
"__typename": "PaymentMethodCapabilityReviewedEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferSourcePaymentInstrumentCapability",
"sourceStatus": "ENABLED",
"createdAt": "2026-05-01T23:26:48.984Z",
"updatedAt": "2026-05-01T23:26:48.984Z"
}
},
"expiresAt": "2026-06-30T23:27:05.269Z"
}
},
"extensions": {
"signatureTimestamp": 1777678025776
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT (destination, disabled)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_fd34948b7c1d6a4a3624e8e50cad4c7c",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT",
"createdAt": "2026-05-01T23:29:07.261Z",
"node": {
"__typename": "PaymentMethodCapabilityReviewedEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferDestinationPaymentInstrumentCapability",
"destinationStatus": "DISABLED",
"createdAt": "2026-05-01T23:28:48.654Z",
"updatedAt": "2026-05-01T23:28:48.654Z"
}
},
"expiresAt": "2026-06-30T23:29:07.261Z"
}
},
"extensions": {
"signatureTimestamp": 1777678147616
}
}
Example payload: PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT (source, disabled)
{
"data": {
"node": {
"__typename": "NotificationEvent",
"id": "nee_22792b0c309843a2f69fe78703baf379",
"name": "PAYMENT_METHOD_CAPABILITY_STATUS_REVIEWED_EVENT",
"createdAt": "2026-05-01T23:29:07.292Z",
"node": {
"__typename": "PaymentMethodCapabilityReviewedEvent",
"paymentMethodToken": {
"__typename": "PaymentMethodToken",
"id": "<PAYMENT_METHOD_TOKEN_ID>"
},
"capability": {
"__typename": "InstantNetworkTransferSourcePaymentInstrumentCapability",
"sourceStatus": "DISABLED",
"createdAt": "2026-05-01T23:28:48.846Z",
"updatedAt": "2026-05-01T23:28:48.846Z"
}
},
"expiresAt": "2026-06-30T23:29:07.292Z"
}
},
"extensions": {
"signatureTimestamp": 1777678147772
}
}

Internal transfer

Triggered when funds are transferred between Highnote financial accounts.

FieldDescription
memoA description of the transfer for reference; input provided from your organization
internalTransferStatusThe current status of the internal transfer

Between financial accounts

All events return an InterFinancialAccountTransfer event object.

Notification Event Name, description, and event object
INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_PENDING
Internal transfer between financial accounts pending.
INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_COMPLETED
Internal transfer between financial accounts completed.
INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_FAILED
Internal transfer between financial accounts failed.

From funding account to payment card account

Notification Event Name, description, and event object
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDING
Transfer from funding account to payment card account pending.
Event object
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_COMPLETED
Transfer from funding account to payment card account completed.
Event object
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_FAILED
Transfer from funding account to payment card account failed.
Event object

From payment card account to funding account

Notification Event Name, description, and event object
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_PENDING
Transfer from payment card account to funding account pending.
Event object
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_COMPLETED
Transfer from payment card account to funding account completed.
Event object
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_FAILED
Transfer from payment card account to funding account failed.
Event object
Example payload: INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_PENDING
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2023-02-15T23:34:16.399Z",
"id": "nee_8b35c7332637359ee998cbd35ee10923",
"name": "INTERNAL_TRANSFER_BETWEEN_FINANCIAL_ACCOUNTS_PENDING",
"node": {
"__typename": "InterFinancialAccountTransfer",
"id": "ia_229d0fc1823ba64d8e9539ea160a93f00e",
"toFinancialAccount": {
"id": "ac_c022126bc2bb629545a988564e267d8982a5",
"name": "To Account",
"createdAt": "2023-07-19T20:45:23.091Z",
"updatedAt": "2023-07-19T20:45:23.114Z",
"externalId": "8UMLNCAKPJ",
"accountAttributes": [],
"accountStatus": "ACTIVE"
},
"fromFinancialAccount": {
"id": "ac_og226c09fff75b35495a932bc5ee92b722ad",
"name": "From Account",
"createdAt": "2023-07-19T20:44:35.110Z",
"updatedAt": "2023-07-19T20:44:35.128Z",
"externalId": "LBA3ME6QXF",
"accountAttributes": [],
"accountStatus": "ACTIVE"
},
"amount": {
"currencyCode": "USD",
"value": 1000
},
"statusReason": null,
"memo": "",
"purpose": null,
"transferActivityType": "SET_LIMIT",
"createdAt": "2023-07-19T20:50:21.485Z",
"updatedAt": "2023-07-19T20:50:21.486Z"
}
}
}
}
Example payload: INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_ TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDING
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-08-22T20:11:36.337Z",
"id": "nee_8521b5febf49f4b19d7deb01dc0b5539",
"name": "INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDING",
"node": {
"__typename": "InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent",
"amount": {
"currencyCode": "USD",
"value": 500000,
"decimalPlaces": 2
},
"createdAt": "2022-08-22T20:11:32.302Z",
"id": "ia_22dab11a1e0df343a89f7ecb53096bd32e",
"internalTransferStatus": "PENDING",
"updatedAt": "2022-08-22T20:11:32.302Z"
}
}
},
"extensions": {
"signatureTimestamp": 1661199096776
}
}
Example payload: INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_ TO_FUNDING_FINANCIAL_ACCOUNT_PENDING
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-08-19T23:11:53.132Z",
"id": "nee_49f8c163f4f8a2c47fe702f02fcbbf52",
"name": "INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_PENDING",
"node": {
"__typename": "InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent",
"amount": {
"currencyCode": "USD",
"value": 350000,
"decimalPlaces": 2
},
"createdAt": "2022-08-19T23:11:51.931Z",
"id": "ia_22e017a985a3034683aa55cef491902791",
"internalTransferStatus": "PENDING",
"updatedAt": "2022-08-19T23:11:51.931Z"
}
}
},
"extensions": {
"signatureTimestamp": 1660950715339
}
}

Notification system

Triggered when a notification target is activated.

Notification Event NameEventDescription
NOTIFICATION_ACTIVATIONObjectNotification target activated. This event is automatically delivered and cannot be unsubscribed.
NOTIFICATION_EVENT_VALIDATION_TESTObjectSent when the initiateEventValidationTest mutation is called.
NOTIFICATION_PING_TESTObjectSent when the initiateNotificationPingTest mutation is called.
Example payload: NOTIFICATION_ACTIVATION
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-10-21T19:14:46.664Z",
"id": "nee_b0f306cc171b44ef89223ca68a0da569",
"name": "NOTIFICATION_ACTIVATION",
"node": {
"__typename": "NotificationTargetActivationEvent",
"ping": "pong"
}
}
},
"extensions": {
"signatureTimestamp": 1666379691368
}
}

Payment card

Triggered when a payment card changes status or when card transaction events occur (issuing side).

Card status

Notification Event NameEventDescription
PAYMENT_CARD_ISSUEDObjectPayment card issued.
PAYMENT_CARD_ACTIVATEDObjectPayment card activated.
PAYMENT_CARD_SUSPENDEDObjectPayment card suspended.
PAYMENT_CARD_UNSUSPENDEDObjectPayment card unsuspended.
PAYMENT_CARD_CLOSEDObjectPayment card closed.
Example payload: PAYMENT_CARD_ACTIVATED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2021-12-02T18:12:13.408Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_ACTIVATED",
"node": {
"__typename": "PaymentCardActivatedEvent",
"id": "PAYMENT_CARD_EVENT_ID",
"bin": "510510",
"cardProductId": "CARD_PRODUCT_ID",
"expirationDate": "Sat Jan 01 08:00:00 UTC 2022",
"formFactor": "VIRTUAL",
"last4": "5100",
"network": "MASTERCARD",
"status": "ACTIVE",
"previousStatus": "ACTIVATION_REQUIRED",
"updatedAt": "2021-12-02T18:12:13.408Z"
}
}
},
"extensions": { "signatureTimestamp": 1638843592782 }
}

Card transactions (issuing)

Notification Event NameEventDescription
PAYMENT_CARD_AUTHORIZATION_APPROVEDObjectCard authorization approved.
PAYMENT_CARD_AUTHORIZATION_DECLINEDObjectCard authorization declined.
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVEDObjectCard authorization and clear approved (single message).
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_DECLINEDObjectCard authorization and clear declined (single message).
PAYMENT_CARD_AUTHORIZATION_REVERSEDObjectCard authorization reversed.
PAYMENT_CARD_CLEAREDObjectCard transaction cleared.
PAYMENT_CARD_ADJUSTMENTObjectCard transaction adjusted.
PAYMENT_CARD_ENHANCED_DATA_RECEIVEDObjectEnhanced transaction data received (Level 2/3).
PAYMENT_CARD_VERIFICATION_APPROVEDObjectCard verification approved.
PAYMENT_CARD_VERIFICATION_DECLINEDObjectCard verification declined.

Surcharge fees

Authorization events include a fees: [TransactionFee!] array that surfaces fees applied to the transaction. Each entry has requestedFeeAmount, approvedFeeAmount, and transactionFeeType. The current transactionFeeType value is SURCHARGE, used for ATM network charges on cash withdrawals or balance inquiries.

You can find the following fees array in the PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED example below.

        "fees": [
{
"requestedFeeAmount": {
"currencyCode": "USD",
"value": 250,
"decimalPlaces": 2
},
"approvedFeeAmount": {
"currencyCode": "USD",
"value": 250,
"decimalPlaces": 2
},
"transactionFeeType": "SURCHARGE"
}
],

Example payload: PAYMENT_CARD_AUTHORIZATION_APPROVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-02-14T19:40:27.635Z",
"expiresAt": "2024-03-15T19:40:27.642Z",
"id": "nee_f7bf7cd4faa05f091801c288de8a1c30",
"name": "PAYMENT_CARD_AUTHORIZATION_APPROVED",
"node": {
"__typename": "PaymentCardAuthorizationApprovedEvent",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"additionalNetworkData": {
"__typename": "VisaData",
"transactionIdentifier": "38082a7f771345ce989e4574ff3252e4"
},
"approvedAmount": {
"currencyCode": "USD",
"value": 15000,
"decimalPlaces": 2
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "PAYMENT_CARD_ID",
"createdAt": "2024-02-14T19:40:22.954Z",
"currentFinancialAccountAvailableToSpendAmount": {
"currencyCode": "USD",
"value": 49925000,
"decimalPlaces": 2
},
"currentFinancialAccountMaximumBalanceAmount": {
"currencyCode": "USD",
"value": 50000000,
"decimalPlaces": 2
},
"cvvResponseCode": "MATCH",
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"id": "TRANSACTION_EVENT_ID",
"merchantDetails": {
"address": {
"countryCodeAlpha3": "USA",
"locality": "San Francisco",
"postalCode": "94105",
"region": "CA"
},
"category": "AUTOMATED_FUEL_DISPENSERS",
"categoryCode": "5542",
"countryCodeAlpha3": "USA",
"description": "KWIK TRIP 123456",
"merchantId": "MERCHANT_ID",
"name": "My Awesome Fuel"
},
"partial": true,
"paymentCardSnapshot": {
"createdAt": "2024-02-14T19:40:22.954Z",
"paymentCardCurrent": {
"id": "PAYMENT_CARD_ID"
},
"status": "ACTIVE"
},
"pointOfServiceDetails": {
"category": "AUTOMATED_FUEL_DISPENSER",
"isCardHolderPresent": true,
"isCardPresent": true,
"isRecurring": false,
"panEntryMode": "MAGNETIC_STRIPE",
"pinEntryMode": "PIN_ENTRY_CAPABILITY",
"terminalAttendance": "ATTENDED",
"terminalSupportsPartialApproval": true
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 100,
"decimalPlaces": 2
},
"responseCode": "APPROVED_FOR_PARTIAL_AMOUNT",
"transactionId": "TRANSACTION_ID",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}
},
"extensions": {
"signatureTimestamp": 1707939629312
}
}
Example payload: PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-02-14T19:45:09.082Z",
"expiresAt": "2024-03-15T19:45:09.082Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED",
"node": {
"__typename": "PaymentCardAuthorizationAndClearApprovedEvent",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"additionalNetworkData": {
"__typename": "VisaData",
"transactionIdentifier": "a72be1cc26ea444697b8fa171f6bab6f"
},
"approvedAmount": {
"currencyCode": "USD",
"value": 1000,
"decimalPlaces": 2
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "PAYMENT_CARD_ID",
"createdAt": "2024-02-14T19:45:04.386Z",
"currentFinancialAccountAvailableToSpendAmount": {
"currencyCode": "USD",
"value": 49930000,
"decimalPlaces": 2
},
"currentFinancialAccountMaximumBalanceAmount": {
"currencyCode": "USD",
"value": 50000000,
"decimalPlaces": 2
},
"cvvResponseCode": "NOT_PROVIDED",
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"id": "TRANSACTION_EVENT_ID",
"merchantDetails": {
"address": {
"countryCodeAlpha3": "USA",
"locality": "Redmond",
"postalCode": "98053",
"region": "WA"
},
"category": "AUTOMATED_CASH_DISBURSE",
"categoryCode": "6011",
"countryCodeAlpha3": "USA",
"description": "HIGHNOTE SF CA US 1234",
"merchantId": "1234567890",
"name": "HIGHNOTE_PLATFORM 1234"
},
"paymentCardSnapshot": {
"createdAt": "2024-02-14T19:45:04.386Z",
"paymentCardCurrent": {
"id": "PAYMENT_CARD_ID"
},
"status": "ACTIVE"
},
"pointOfServiceDetails": {
"category": "AUTOMATED_TELLER_MACHINE",
"isCardHolderPresent": true,
"isCardPresent": true,
"isRecurring": false,
"panEntryMode": "INTEGRATED_CIRCUIT_CARD",
"pinEntryMode": "PIN_VERIFIED_BY_TERMINAL_DEVICE",
"terminalAttendance": "UNATTENDED",
"terminalSupportsPartialApproval": false
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 1000,
"decimalPlaces": 2
},
"fees": [
{
"requestedFeeAmount": {
"currencyCode": "USD",
"value": 250,
"decimalPlaces": 2
},
"approvedFeeAmount": {
"currencyCode": "USD",
"value": 250,
"decimalPlaces": 2
},
"transactionFeeType": "SURCHARGE"
}
],
"responseCode": "APPROVED",
"transactionId": "TRANSACTION_ID",
"transactionProcessingType": "CASH"
}
}
},
"extensions": {
"signatureTimestamp": 1707939909559
}
}
Example payload: PAYMENT_CARD_CLEARED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-02-14T19:44:18.646Z",
"expiresAt": "2024-03-15T19:44:18.647Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_CLEARED",
"node": {
"__typename": "PaymentCardClearedEvent",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"additionalNetworkData": {
"__typename": "VisaData",
"transactionIdentifier": "38082a7f771345ce989e4574ff3252e4"
},
"approvedAmount": {
"currencyCode": "USD",
"value": 10000,
"decimalPlaces": 2
},
"avsResponseCode": "NOT_PROVIDED",
"cardId": "PAYMENT_CARD_ID",
"createdAt": "2024-02-14T19:44:18.148Z",
"currentFinancialAccountAvailableToSpendAmount": {
"currencyCode": "USD",
"value": 49930000,
"decimalPlaces": 2
},
"currentFinancialAccountMaximumBalanceAmount": {
"currencyCode": "USD",
"value": 50000000,
"decimalPlaces": 2
},
"cvvResponseCode": "MATCH",
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"id": "TRANSACTION_EVENT_ID",
"merchantDetails": {
"address": {
"countryCodeAlpha3": "USA",
"locality": "San Francisco",
"postalCode": "94105",
"region": "CA"
},
"category": "AUTOMATED_FUEL_DISPENSERS",
"categoryCode": "5542",
"countryCodeAlpha3": "USA",
"description": "The awesomest awesome fuel dispensers",
"merchantId": "Merchant Id",
"name": "My Awesome Fuel"
},
"partial": true,
"paymentCardSnapshot": {
"createdAt": "2024-02-14T19:44:18.148Z",
"paymentCardCurrent": {
"id": "PAYMENT_CARD_ID"
},
"status": "ACTIVE"
},
"pointOfServiceDetails": {
"category": "AUTOMATED_FUEL_DISPENSER",
"isCardHolderPresent": true,
"isCardPresent": true,
"isRecurring": false,
"panEntryMode": "MAGNETIC_STRIPE",
"pinEntryMode": "PIN_ENTRY_CAPABILITY",
"terminalAttendance": "ATTENDED",
"terminalSupportsPartialApproval": true
},
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 10000,
"decimalPlaces": 2
},
"responseCode": "APPROVED",
"transactionId": "TRANSACTION_ID",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}
},
"extensions": {
"signatureTimestamp": 1707939859969
}
}
Example payload: PAYMENT_CARD_ADJUSTMENT
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2024-06-10T14:22:08.312Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_ADJUSTMENT",
"node": {
"__typename": "PaymentCardAdjustmentEvent",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"approvedAmount": {
"currencyCode": "USD",
"value": 500,
"decimalPlaces": 2
},
"cardId": "PAYMENT_CARD_ID",
"createdAt": "2024-06-10T14:22:07.891Z",
"currentFinancialAccountAvailableToSpendAmount": {
"currencyCode": "USD",
"value": 49935000,
"decimalPlaces": 2
},
"currentFinancialAccountMaximumBalanceAmount": {
"currencyCode": "USD",
"value": 50000000,
"decimalPlaces": 2
},
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"id": "TRANSACTION_EVENT_ID",
"merchantDetails": null,
"paymentCardSnapshot": {
"createdAt": "2024-06-10T14:22:07.891Z",
"paymentCardCurrent": {
"id": "PAYMENT_CARD_ID"
},
"status": "ACTIVE"
},
"pointOfServiceDetails": null,
"responseCode": "APPROVED",
"transactionId": "TRANSACTION_ID",
"transactionProcessingType": "ADJUSTMENT_CREDIT"
}
}
},
"extensions": {
"signatureTimestamp": 1718025729105
}
}
Example payload: PAYMENT_CARD_ENHANCED_DATA_RECEIVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2023-04-01T00:55:18.566Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_ENHANCED_DATA_RECEIVED",
"node": {
"__typename": "PaymentCardEnhancedDataEvent",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"additionalNetworkData": {
"__typename": "VisaData",
"transactionIdentifier": "63e2d6aaaef24f5d9cab99af689c5a21"
},
"cardId": "cd_b47701ed1fe71b98acb2d67c710a912d",
"createdAt": "2023-04-01T00:55:16.495Z",
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"id": "TRANSACTION_EVENT_ID",
"responseCode": "APPROVED",
"transactionId": "TRANSACTION_ID",
"transactionProcessingType": "GOODS_AND_SERVICES"
}
}
},
"extensions": {
"signatureTimestamp": 1680310520414
}
}
Example payload: PAYMENT_CARD_VERIFICATION_APPROVED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-05-09T22:27:32.871Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYMENT_CARD_VERIFICATION_APPROVED",
"node": {
"__typename": "PaymentCardVerificationApprovedEvent",
"approvedAmount": {
"currencyCode": "USD",
"value": 100,
"decimalPlaces": 2
},
"avsResponseCode": "NOT_PROVIDED",
"createdAt": "2022-05-09T22:27:31.636Z",
"cvvResponseCode": "NOT_PROVIDED",
"id": "PAYMENT_CARD_VERIFICATION_EVENT_ID",
"financialAccountId": "FINANCIAL_ACCOUNT_ID",
"accountHolderId": "ACCOUNT_HOLDER_ID",
"paymentCardId": "PAYMENT_CARD_ID",
"merchantDetails": {
"merchantId": "000000000011111",
"name": "Safeway",
"category": "MISCELLANEOUS_SPECIALTY_RETAIL",
"categoryCode": "5514",
"address": {
"postalCode": "94105",
"region": "CA",
"locality": "San Francisco",
"countryCodeAlpha3": "USA"
}
},
"paymentCardSnapshot": {
"createdAt": "2024-02-14T19:43:23.039Z",
"paymentCardCurrent": {
"id": "PAYMENT_CARD_ID"
},
"status": "ACTIVE"
},
"pointOfServiceDetails": {
"category": "AUTOMATIC_FUEL_DISPENSER",
"panEntryMode": "MAGNETIC_STRIPE",
"pinEntryMode": "PIN_VERIFIED_BY_TERMINAL_DEVICE",
"terminalAttendance": "ATTENDED",
"isCardHolderPresent": true,
"isCardPresent": true,
"terminalSupportsPartialApproval": false,
"isRecurring": false
},
"transactionProcessingType": "PAYMENT_DEBIT",
"postalCodeResponseCode": "NOT_PROVIDED",
"requestedAmount": {
"currencyCode": "USD",
"value": 100,
"decimalPlaces": 2
},
"responseCode": "APPROVED",
"transactionId": "TRANSACTION_ID"
}
}
},
"extensions": {
"signatureTimestamp": 1652135254644
}
}

Payroll advance

Triggered when a payroll advance repayment completes or a write-off is finalized.

Notification Event NameEventDescription
PAYROLL_ADVANCE_REPAYMENT_COMPLETEDObjectPayroll advance repayment completed.
PAYROLL_ADVANCE_WRITE_OFF_COMPLETEDObjectPayroll advance write-off completed.

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

Payment Event StatusDescription
NOT_REPAIDStatus indicates that the payroll advance has not been paid
FULLY_REPAIDThe balance of the payroll advance is fully repaid.
PARTIALLY_REPAIDThe balance of the payroll advance is partially repaid.
WRITTEN_OFFThe payroll advance is written off on the Highnote platform because the 3 repayment AttemptCount was reached.
Example payload: PAYROLL_ADVANCE_REPAYMENT_COMPLETED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-09-14T23:04:17.337Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYROLL_ADVANCE_REPAYMENT_COMPLETED",
"node": {
"id": "PAYROLL_ADVANCE_EVENT_ID",
"employerFinancialAccountId": "FINANCIAL_ACCOUNT_ID",
"payrollAdvance": {
"advanceAmount": {
"currencyCode": "USD",
"value": 100000,
"decimalPlaces": 2
},
"amountApplied": {
"currencyCode": "USD",
"value": 10000,
"decimalPlaces": 2
},
"amountBefore": {
"currencyCode": "USD",
"value": 80000,
"decimalPlaces": 2
},
"balanceAfter": {
"currencyCode": "USD",
"value": 70000,
"decimalPlaces": 2
},
"id": "PAYROLL_ADVANCE_ID",
"paymentAdvanceStatus": "PARTIALLY_REPAID",
"repaymentAttemptCount": 3
}
}
}
},
"extensions": {
"signatureTimestamp": 1663196658157
}
}
Example payload: PAYROLL_ADVANCE_WRITE_OFF_COMPLETED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-09-14T23:04:27.797Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PAYROLL_ADVANCE_WRITE_OFF_COMPLETED",
"node": {
"id": "PAYROLL_ACCOUNT_TRANSFER_ID",
"payrollAdvance": {
"advanceAmount": {
"currencyCode": "USD",
"value": 100000,
"decimalPlaces": 2
},
"amountApplied": {
"currencyCode": "USD",
"value": 0,
"decimalPlaces": 2
},
"amountBefore": {
"currencyCode": "USD",
"value": 70000,
"decimalPlaces": 2
},
"balanceAfter": {
"currencyCode": "USD",
"value": 0,
"decimalPlaces": 2
},
"id": "PAYROLL_ADVANCE_ID",
"paymentAdvanceStatus": "WRITTEN_OFF",
"repaymentAttemptCount": 3,
"writeOffAmount": {
"currencyCode": "USD",
"value": 70000,
"decimalPlaces": 2
}
}
}
}
},
"extensions": {
"signatureTimestamp": 1663196668260
}
}

Physical card order

Triggered when a physical payment card or group order ships or fails to ship.

Notification Event NameEventDescription
PHYSICAL_PAYMENT_CARD_SHIPPEDObjectPhysical payment card shipped.
PHYSICAL_PAYMENT_CARD_SHIP_FAILEDObjectPhysical payment card shipment failed.
PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIPPEDObjectPhysical payment card group order shipped.
PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIP_FAILEDObjectPhysical payment card group order shipment failed.
Example payload: PHYSICAL_PAYMENT_CARD_SHIPPED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-04-08T00:57:05.589Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PHYSICAL_PAYMENT_CARD_SHIPPED",
"node": {
"__typename": "PhysicalPaymentCardShippedEvent",
"createdAt": "2022-04-08T00:56:46.242Z",
"id": "PHYSICAL_PAYMENT_CARD_EVENT_ID",
"orderState": {
"status": "SHIPPED"
},
"paymentCardId": "PAYMENT_CARD_ID",
"updatedAt": "2022-04-08T00:57:03.588Z"
}
}
},
"extensions": {
"signatureTimestamp": 1649379429987
}
}
Example payload: PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIPPED
{
"data": {
"node": {
"__typename": "NotificationEvent",
"createdAt": "2022-10-25T22:28:02.991Z",
"id": "NOTIFICATION_EVENT_ID",
"name": "PHYSICAL_PAYMENT_CARD_GROUP_ORDER_SHIPPED",
"node": {
"__typename": "PhysicalPaymentCardGroupOrderShippedEvent",
"cardCount": 1,
"cardProductId": "CARD_PRODUCT_ID",
"createdAt": "2022-10-25T22:24:53.923Z",
"groupOrderState": {
"status": "SHIPPED"
},
"id": "PHYSICAL_PAYMENT_CARD_GROUP_ORDER_EVENT_ID",
"updatedAt": "2022-10-25T22:27:58.019Z"
}
}
},
"extensions": {
"signatureTimestamp": 1666736885597
}
}

Provision account holder

Triggered during the automated account holder provisioning workflow. Each workflow action progresses through the same statuses: INITIATED, IN_PROGRESS, COMPLETED, ERROR, or NOT_COMPLETED.

All provision account holder events return an AccountHolderProvisioning event object.

Workflow status

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_INITIATEDProvisioning workflow initiated.
PROVISION_ACCOUNT_HOLDER_IN_PROGRESSProvisioning workflow in progress.
PROVISION_ACCOUNT_HOLDER_COMPLETEDProvisioning workflow completed.
PROVISION_ACCOUNT_HOLDER_ERRORProvisioning workflow encountered an error.
PROVISION_ACCOUNT_HOLDER_REJECTEDProvisioning workflow rejected.

Create application

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_CREATE_APPLICATION_INITIATEDCreate application action initiated.
PROVISION_ACCOUNT_HOLDER_CREATE_APPLICATION_IN_PROGRESSCreate application action in progress.
PROVISION_ACCOUNT_HOLDER_CREATE_APPLICATION_COMPLETEDCreate application action completed.
PROVISION_ACCOUNT_HOLDER_CREATE_APPLICATION_ERRORCreate application action encountered an error.
PROVISION_ACCOUNT_HOLDER_CREATE_APPLICATION_NOT_COMPLETEDCreate application action did not complete.

Issue financial account

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_ISSUE_FINANCIAL_ACCOUNT_INITIATEDIssue financial account action initiated.
PROVISION_ACCOUNT_HOLDER_ISSUE_FINANCIAL_ACCOUNT_IN_PROGRESSIssue financial account action in progress.
PROVISION_ACCOUNT_HOLDER_ISSUE_FINANCIAL_ACCOUNT_COMPLETEDIssue financial account action completed.
PROVISION_ACCOUNT_HOLDER_ISSUE_FINANCIAL_ACCOUNT_ERRORIssue financial account action encountered an error.
PROVISION_ACCOUNT_HOLDER_ISSUE_FINANCIAL_ACCOUNT_NOT_COMPLETEDIssue financial account action did not complete.

Issue payment card

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_ISSUE_PAYMENT_CARD_INITIATEDIssue payment card action initiated.
PROVISION_ACCOUNT_HOLDER_ISSUE_PAYMENT_CARD_IN_PROGRESSIssue payment card action in progress.
PROVISION_ACCOUNT_HOLDER_ISSUE_PAYMENT_CARD_COMPLETEDIssue payment card action completed.
PROVISION_ACCOUNT_HOLDER_ISSUE_PAYMENT_CARD_ERRORIssue payment card action encountered an error.
PROVISION_ACCOUNT_HOLDER_ISSUE_PAYMENT_CARD_NOT_COMPLETEDIssue payment card action did not complete.
Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_LINK_EXTERNAL_BANK_ACCOUNT_INITIATEDLink external bank account action initiated.
PROVISION_ACCOUNT_HOLDER_LINK_EXTERNAL_BANK_ACCOUNT_IN_PROGRESSLink external bank account action in progress.
PROVISION_ACCOUNT_HOLDER_LINK_EXTERNAL_BANK_ACCOUNT_COMPLETEDLink external bank account action completed.
PROVISION_ACCOUNT_HOLDER_LINK_EXTERNAL_BANK_ACCOUNT_ERRORLink external bank account action encountered an error.
PROVISION_ACCOUNT_HOLDER_LINK_EXTERNAL_BANK_ACCOUNT_NOT_COMPLETEDLink external bank account action did not complete.

Notify provider

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_NOTIFY_PROVIDER_INITIATEDNotify provider action initiated.
PROVISION_ACCOUNT_HOLDER_NOTIFY_PROVIDER_IN_PROGRESSNotify provider action in progress.
PROVISION_ACCOUNT_HOLDER_NOTIFY_PROVIDER_COMPLETEDNotify provider action completed.
PROVISION_ACCOUNT_HOLDER_NOTIFY_PROVIDER_ERRORNotify provider action encountered an error.
PROVISION_ACCOUNT_HOLDER_NOTIFY_PROVIDER_NOT_COMPLETEDNotify provider action did not complete.

Register Visa payable funding account

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_REGISTER_VISA_PAYABLE_FUNDING_ACCOUNT_INITIATEDRegister Visa payable funding account action initiated.
PROVISION_ACCOUNT_HOLDER_REGISTER_VISA_PAYABLE_FUNDING_ACCOUNT_IN_PROGRESSRegister Visa payable funding account action in progress.
PROVISION_ACCOUNT_HOLDER_REGISTER_VISA_PAYABLE_FUNDING_ACCOUNT_COMPLETEDRegister Visa payable funding account action completed.
PROVISION_ACCOUNT_HOLDER_REGISTER_VISA_PAYABLE_FUNDING_ACCOUNT_ERRORRegister Visa payable funding account action encountered an error.
PROVISION_ACCOUNT_HOLDER_REGISTER_VISA_PAYABLE_FUNDING_ACCOUNT_NOT_COMPLETEDRegister Visa payable funding account action did not complete.

Set credit limit

Notification Event NameDescription
PROVISION_ACCOUNT_HOLDER_SET_CREDIT_LIMIT_INITIATEDSet credit limit action initiated.
PROVISION_ACCOUNT_HOLDER_SET_CREDIT_LIMIT_IN_PROGRESSSet credit limit action in progress.
PROVISION_ACCOUNT_HOLDER_SET_CREDIT_LIMIT_COMPLETEDSet credit limit action completed.
PROVISION_ACCOUNT_HOLDER_SET_CREDIT_LIMIT_ERRORSet credit limit action encountered an error.
PROVISION_ACCOUNT_HOLDER_SET_CREDIT_LIMIT_NOT_COMPLETEDSet credit limit action did not complete.

Report

Triggered when an on-demand report completes or fails.

All report events return a Report event object.

Notification Event NameDescription
REPORT_COMPLETEDReport completed successfully.
REPORT_FAILEDReport failed.

Unified funds transfer

Triggered during the lifecycle of a Unified Funds Transfer (single-call money movement via the Transfer Funds API).

Instant network transfer events return an InstantNetworkTransfer event object. Unified funds transfer events return a UnifiedFundsTransfer event object.

Notification Event NameDescription
INSTANT_NETWORK_TRANSFER_INITIATED_EVENTInstant network transfer initiated.
INSTANT_NETWORK_TRANSFER_COMPLETED_EVENTInstant network transfer completed.
INSTANT_NETWORK_TRANSFER_FAILED_EVENTInstant network transfer failed.
UNIFIED_FUNDS_TRANSFER_INITIATED_EVENTUnified funds transfer initiated.
UNIFIED_FUNDS_TRANSFER_COMPLETED_EVENTUnified funds transfer completed.
UNIFIED_FUNDS_TRANSFER_FAILED_EVENTUnified funds transfer failed.