Home / Basics / Events and Notifications
The ACH_EXTERNALLY_INITIATED_DEPOSIT
events are triggered when an incoming NACHA file credit transaction, such as payroll direct deposit, is processed.
Notification Event Name | Description |
---|---|
ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVED | The externally initiated ACH Deposit has been RECEIVED |
ACH_EXTERNALLY_INITIATED_DEPOSIT_PROCESSED | The externally initiated ACH Deposit has PROCESSED |
ACH_EXTERNALLY_INITIATED_DEPOSIT_FAILED | The externally initiated ACH Deposit has FAILED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-03-31T21:21:39.732Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVED", "node": { "__typename": "AchExternallyInitatedDepositReceivedEvent", "id": "ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVED_EVENT_ID", "amount": { "currencyCode": "USD", "value": 60150 }, "companyEntryDescription": "ORDER", "companyIdentifier": "271111113", "companyName": "COMPANY COM INC", "createdAt": "2022-03-31T21:21:36.113Z", "financialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-01-29T05:00:00.000Z", "transactionId": "TRANSACTION_ID", "updatedAt": "2022-03-31T21:21:36.121Z" } } }, "extensions": { "signatureTimestamp": 1648761700155 } }
The ACH_FUNDS_WITHDRAWAL
events are triggered when an incoming NACHA file debit transaction is processed and fund out ACH payment transitions states.
Notification Event Name | Description |
---|---|
ACH_FUNDS_WITHDRAWAL_INITIATED | The externally initiated ACH withdrawal has been INITIATED |
ACH_FUNDS_WITHDRAWAL_PROCESSING | The externally initiated ACH withdrawal is PROCESSING |
ACH_FUNDS_WITHDRAWAL_PROCESSED | The externally initiated ACH withdrawal was PROCESSED |
ACH_FUNDS_WITHDRAWAL_FAILED | The externally initiated ACH withdrawal has FAILED |
ACH_FUNDS_WITHDRAWAL_RETURNED | The externally initiated ACH withdrawal has been RETURNED |
ACH_FUNDS_WITHDRAWAL_CANCELED | The externally initiated ACH withdrawal is CANCELED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-03-31T21:21:39.732Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_FUNDS_WITHDRAWAL_INITIATED", "node": { "__typename": "FundsWithdrawalInitiatedEvent", "id": "FUNDS_WITHDRAWAL_INITIATED_EVENT_ID", "transactionId": "TRANSACTION_ID", "amount": { "currencyCode": "USD", "value": 60150 }, "createdAt": "2022-03-31T21:21:36.113Z", "updatedAt": "2022-03-31T21:21:36.121Z", "companyEntryDescription": "ORDER", "companyIdentifier": "271111113", "companyName": "HIGHNOTE", "fromFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "toFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-01-29T05:00:00.000Z" } } }, "extensions": { "signatureTimestamp": 1648761700155 } }
The ACH_FUNDS_DEPOSIT
events are triggered when a fund in ACH transfer is initiated or transitions states.
Notification Event Name | Description |
---|---|
ACH_FUNDS_DEPOSIT_INITIATED | The fund in ACH transfer has been INITIATED |
ACH_FUNDS_DEPOSIT_PROCESSING | The fund in ACH transfer is PROCESSING |
ACH_FUNDS_DEPOSIT_PROCESSED | The fund in ACH transfer was PROCESSED |
ACH_FUNDS_DEPOSIT_FAILED | The fund in ACH transfer has FAILED |
ACH_FUNDS_DEPOSIT_RETURNED | The fund in ACH transfer has been RETURNED |
ACH_FUNDS_DEPOSIT_CANCELED | The fund in ACH transfer is CANCELED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-03-31T21:21:39.732Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_FUNDS_DEPOSIT_INITIATED", "node": { "__typename": "FundsDepositInitiatedEvent", "id": "FUNDS_DEPOSIT_INITIATED_EVENT_ID", "transactionId": "TRANSACTION_ID", "amount": { "currencyCode": "USD", "value": 60150 }, "createdAt": "2022-03-31T21:21:36.113Z", "updatedAt": "2022-03-31T21:21:36.121Z", "companyIdentifier": "271111113", "companyName": "HIGHNOTE", "fromFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "toFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-01-29T05:00:00.000Z" } } }, "extensions": { "signatureTimestamp": 1648761700155 } }
The ACH_FUNDS_WITHDRAWAL
events are triggered when a fund out ACH payment is initiated or transitions states.
Notification Event | Description |
---|---|
ACH_FUNDS_WITHDRAWAL_INITIATED | The fund out ACH transfer has been INITIATED |
ACH_FUNDS_WITHDRAWAL_PROCESSING | The fund out ACH transfer is PROCESSING |
ACH_FUNDS_WITHDRAWAL_PROCESSED | The fund out ACH transfer was PROCESSED |
ACH_FUNDS_WITHDRAWAL_FAILED | The fund out ACH transfer has FAILED |
ACH_FUNDS_WITHDRAWAL_RETURNED | The fund out ACH transfer has been RETURNED |
ACH_FUNDS_WITHDRAWAL_CANCELLED | The fund out ACH transfer is CANCELED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-03-31T21:21:39.732Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_FUNDS_WITHDRAWAL_INITIATED", "node": { "__typename": "FundsWithdrawalInitiatedEvent", "id": "FUNDS_WITHDRAWAL_INITIATED_EVENT_ID", "transactionId": "TRANSACTION_ID", "amount": { "currencyCode": "USD", "value": 60150 }, "createdAt": "2022-03-31T21:21:36.113Z", "updatedAt": "2022-03-31T21:21:36.121Z", "companyIdentifier": "271111113", "companyName": "HIGHNOTE", "fromFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "toFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-01-29T05:00:00.000Z" } } }, "extensions": { "signatureTimestamp": 1648761700155 } }
The ACH_REPAYMENT
events are triggered when an ACH Repayment transitions states.
Notification Event Name | Description |
---|---|
ACH_REPAYMENT_PROCESSING | The ACH Repayment is PROCESSING |
ACH_REPAYMENT_PROCESSED | The ACH Repayment is PROCESSED |
ACH_REPAYMENT_RETURNED | The ACH Repayment has been RETURNED |
ACH_REPAYMENT_FAILED | The ACH Repayment has FAILED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-03-11T03:51:32.418Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_REPAYMENT_PROCESSED", "node": { "__typename": "RepaymentProcessedEvent", "id": "REPAYMENT_PROCESSED_EVENT_ID", "amount": { "currencyCode": "USD", "value": 9900 }, "companyIdentifier": "1852922649", "companyName": "HIGHNOTEPLATFORM", "createdAt": "2022-03-11T03:06:22.843Z", "fromFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-03-11T03:06:22.840Z", "toFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "transactionId": "TRANSACTION_ID", "updatedAt": "2022-03-11T03:51:29.737Z" } } }, "extensions": { "signatureTimestamp": 1646970698504 } }
The ACH_SECURE_DEPOSIT
events are triggered when an ACH Secure Deposit transitions states.
Notification Event Name | Description |
---|---|
ACH_SECURE_DEPOSIT_INITIATED | The ACH Secure Deposit is INITIATED |
ACH_SECURE_DEPOSIT_CANCELED | The ACH Secure Deposit is CANCELED |
ACH_SECURE_DEPOSIT_PROCESSING | The ACH Secure Deposit is PROCESSING |
ACH_SECURE_DEPOSIT_PROCESSED | The ACH Secure deposit is PROCESSED |
ACH_SECURE_DEPOSIT_RETURNED | The ACH Secure Deposit has been RETURNED |
ACH_SECURE_DEPOSIT_FAILED | The ACH Secure Deposit has FAILED |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-05-02T15:17:39.303Z", "id": "NOTIFICATION_EVENT_ID", "name": "ACH_SECURE_DEPOSIT_PROCESSING", "node": { "__typename": "SecureDepositProcessingEvent", "id": "SECURE_DEPOSIT_PROCESSING_EVENT_ID", "amount": { "currencyCode": "USD", "value": 66000 }, "companyIdentifier": "1852922649", "companyName": "HIGHNOTEPLATFORM", "createdAt": "2022-05-02T15:14:24.606Z", "fromFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "settlementDate": "2022-05-02T15:14:24.603Z", "toFinancialAccountId": "FINANCIAL_ACCOUNT_ID", "transactionId": "TRANSACTION_ID", "updatedAt": "2022-05-02T15:14:24.606Z" } } }, "extensions": { "signatureTimestamp": 1651504665140 } }
The CARD_PRODUCT_APPLICATION
events are triggered when an Application transitions states.
Notification Event | Description |
---|---|
CARD_PRODUCT_APPLICATION_APPROVED | The Application is APPROVED |
CARD_PRODUCT_APPLICATION_IN_REVIEW | The Application is IN_REVIEW |
CARD_PRODUCT_APPLICATION_MANUAL_REVIEW | The Application is in MANUAL_REVIEW |
CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTED | An additional DOCUMENT_UPLOAD session has been REQUESTED on the application |
CARD_PRODUCT_APPLICATION_DENIED | The Application has been DENIED |
{ "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" } }
The AUTHORIZED_USER_CARD_PRODUCT_APPLICATION
events are triggered when an Authorized User's Application transitions states.
NOTIFICATION EVENT | DESCRIPTION |
---|---|
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_APPROVED | The Application is APPROVED |
AUTHORIZED_USER_CARD_PRODUCT_APPLICATION_DENIED | The Application has been DENIED |
{ "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" } }
The PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUED
events are triggered when the state of a provisional credit for a dispute case is updated.
Notification Event Name | Description |
---|---|
PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_ISSUED | A provisional credit has been ISSUED to the Financial Account for a disputed chargeback case. |
PAYMENT_CARD_TRANSACTION_CHARGEBACK_PROVISIONAL_CREDIT_REVOKED | A provisional credit has been REVOKED to the Financial Account for a disputed chargeback case. |
{ "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 } }
When the Collaborative Underwriting feature is enabled, you can subscribe to an event informing you an underwriting decision is requested.
Notification Event | Description |
---|---|
CARD_PRODUCT_APPLICATION_UNDERWRITING_DECISION_REQUESTED | An underwriting decision is 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 } }
The PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS
events are triggered when the state of a transaction's dispute case is updated.
Notification Event Name | Description |
---|---|
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_INITIATED | A dispute case for the transaction has been INITIATED . |
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_RESOLVED_WITH_DISPUTE_CREDIT | The dispute case has been RESOLVED_WITH_DISPUTE_CREDIT . A chargeback will not be filed with the network. |
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CASE_CARDHOLDER_WON | The dispute case was WON or PARTIALLY WON for the disputed transaction. |
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CASE_CARDHOLDER_LOST | The dispute case was LOST for the disputed transaction from the cardholder. |
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_REJECTED | The dispute case was REJECTED by the Issuer or Network. |
PAYMENT_CARD_TRANSACTION_DISPUTE_CASE_STATUS_CANCELLED | The dispute case for the transaction has been CANCELLED . |
{ "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 } }
Sent when a new document upload session is requested.
Notification Event | Description |
---|---|
CARD_PRODUCT_APPLICATION_DOCUMENT_UPLOAD_REQUESTED | An additional DOCUMENT_UPLOAD session has been REQUESTED on the application. |
{ "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 } }
The EXTERNAL_BANK_ACCOUNT
events are triggered when an external bank account is added or removed from an Account Holder.
Notification Event | Description |
---|---|
EXTERNAL_BANK_ACCOUNT_ADDED | The external bank account has been verified and added to the Account Holder. |
EXTERNAL_BANK_ACCOUNT_REMOVED | The external bank account has been removed from the Account Holder. |
{ "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 } }
FINANCIAL_ACCOUNT_ATTRIBUTE
events are triggered when Attributes are added or removed from a Financial Account.
Notification Event | Description |
---|---|
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT | A DELINQUENT Financial Account Attribute has been ADDED to the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENT | A DELINQUENT Financial Account Attribute has been REMOVED from the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT_SUSPENDED | A DELINQUENT_SUSPENDED Financial Account Attribute has been ADDED to the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENT_SUSPENDED | A DELINQUENT_SUSPENDED Financial Account Attribute has been REMOVED from the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_CHARGE_OFF | A CHARGE_OFF Financial Account Attribute has been ADDED to the Financial Account. |
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_CHARGE_OFF | A CHARGE_OFF Financial Account Attribute has been REMOVED from the Financial Account. |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2021-12-02T18:12:13.408Z", "id": "NOTIFICATION_EVENT_ID", "node": { "__typename": "FinancialAccountStatementReadyEvent", "id": "FINANCIAL_ACCOUNT_STATEMENT_READY_EVENT_ID", "financialAccountId": "FINANCIAL_ACCOUNT_ID" } } }, "extensions": { "signatureTimestamp": 1638843592782 } }
The FINANCIAL_ACCOUNT_STATEMENT
events are triggered at the end of a billing cycle, when a Financial Account's Billing Statement is available.
Notification Event | Description |
---|---|
FINANCIAL_ACCOUNT_STATEMENT_READY | A Financial Account's billing period has ended and the Statement is now READY . |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2021-12-02T18:12:13.408Z", "id": "NOTIFICATION_EVENT_ID", "node": { "__typename": "FinancialAccountStatementReadyEvent", "id": "FINANCIAL_ACCOUNT_STATEMENT_READY_EVENT_ID", "financialAccountId": "FINANCIAL_ACCOUNT_ID" } } }, "extensions": { "signatureTimestamp": 1638843592782 } }
ACCOUNT_STATUS
events are triggered when a Financial Account’s Status is updated.
Notification Event | Description |
---|---|
ACCOUNT_STATUS_ACTIVE | The Financial Account is ACTIVE . |
ACCOUNT_STATUS_UNDER_REVIEW | The Financial Account is UNDER_REVIEW . |
ACCOUNT_STATUS_SUSPENDED | The Financial Account is SUSPENDED . |
ACCOUNT_STATUS_PENDING_CLOSURE | The Financial Account is PENDING_CLOSURE . |
ACCOUNT_STATUS_CLOSED | The Financial Account is CLOSED . |
{ "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 } }
FINANCIAL_ACCOUNT_ATTRIBUTE
events are triggered when a Financial Account’s Attributes are added or removed.
Notification Event | Description |
---|---|
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT | A DELINQUENT Financial Account Attribute has been ADDED to the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENT | A DELINQUENT Financial Account Attribute has been REMOVED from the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_ADDED_DELINQUENT_SUSPENDED | A DELINQUENT_SUSPENDED Financial Account Attribute has been ADDED to the Financial Account |
FINANCIAL_ACCOUNT_ATTRIBUTE_REMOVED_DELINQUENT_SUSPENDED | A DELINQUENT_SUSPENDED Financial Account Attribute has been REMOVED from the Financial Account |
{ "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 } }
The INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT
events are triggered when the transfer between a Funding Financial Account and a Payment Card Financial Account transitions states.
Notification Event | Description |
---|---|
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDING | An Internal transfer from Funding Financial Account to Payment Card Financial Account has been initiated and is pending. |
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_COMPLETED | An Internal transfer from Funding Financial Account to Payment Card Financial Account has completed. |
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_FAILED | An Internal transfer from Funding Financial Account to Payment Card Financial Account has been initiated but failed. |
{ "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 }, "createdAt": "2022-08-22T20:11:32.302Z", "id": "ia_22dab11a1e0df343a89f7ecb53096bd32e", "internalTransferStatus": "PENDING", "updatedAt": "2022-08-22T20:11:32.302Z" } } }, "extensions": { "signatureTimestamp": 1661199096776 } }
The INTERNAL_TRANSFER_FROM_PAYMENT_CARD
events are triggered when a transfer between a Payment Card Financial Account and a Funding Financial Account transitions states.
Notification Event | Description |
---|---|
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_PENDING | An Internal transfer from Payment Card Financial Account to a Funding Financial Account has been initiated and is pending. |
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_COMPLETED | An Internal transfer from Payment Card Financial Account to a Funding Financial Account is completed. |
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_FAILED | An Internal transfer from Payment Card Financial Account to a Funding Financial Account has been initiated but failed. |
{ "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 }, "createdAt": "2022-08-19T23:11:51.931Z", "id": "ia_22e017a985a3034683aa55cef491902791", "internalTransferStatus": "PENDING", "updatedAt": "2022-08-19T23:11:51.931Z" } } }, "extensions": { "signatureTimestamp": 1660950715339 } }
This event will be sent to your webhook to verify it's been setup correctly. This event will fire on the initial creation as well as when you attempt to reactivate a webhook.
NOTIFICATION_ACTIVATION
will be ignored if provided as a subscription event name when adding a webhook.
{ "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 } }
The PAYROLL_ADVANCE_REPAYMENT_COMPLETED
event will be triggered when a payroll repayment is processed. The PAYROLL_ADVANCE_REPAYMENT_COMPLETED
event provides the repayment status of each payroll advance line item and repayment attempt count.
Payment Event Status | Description |
---|---|
NOT_REPAID | The state when nothing has been paid. |
FULLY_REPAID | The balance of the PayrollAdvance is fully repaid. |
PARTIALLY_REPAID | The balance of the PayrollAdvance is partially repaid. |
WRITTEN_OFF | The PayrollAdvance is written off on the Highnote platform because the 3 repayment AttemptCount was reached. |
{ "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 }, "amountApplied": { "currencyCode": "USD", "value": 10000 }, "amountBefore": { "currencyCode": "USD", "value": 80000 }, "balanceAfter": { "currencyCode": "USD", "value": 70000 }, "id": "PAYROLL_ADVANCE_ID", "paymentAdvanceStatus": "PARTIALLY_REPAID", "repaymentAttemptCount": 3 } } } }, "extensions": { "signatureTimestamp": 1663196658157 } }
The PAYMENT_CARD
events are triggered when a Payment Card transitions states.
Notification Event | Description |
---|---|
PAYMENT_CARD_ACTIVATED | Payment Card has been activated. |
PAYMENT_CARD_SUSPENDED | Payment Card has been suspended. |
PAYMENT_CARD_UNSUSPENDED | Payment Card has been unsuspended. |
PAYMENT_CARD_CLOSED | Payment Card has been closed. |
{ "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" } } }, "extensions": { "signatureTimestamp": 1638843592782 } }
The PAYMENT_CARD_AUTHORIZATION
events are triggered when an Authorization is created or transition states.
Notification Event | Description |
---|---|
PAYMENT_CARD_AUTHORIZATION_APPROVED | The Payment Card Transaction Authorization is APPROVED . |
PAYMENT_CARD_AUTHORIZATION_DECLINED | The Payment Card Transaction Authorization has been DECLINED . |
PAYMENT_CARD_AUTHORIZATION_REVERSED | The Payment Card Transaction Authorization has been REVERSED . |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-05-09T22:27:32.871Z", "id": "NOTIFICATION_EVENT_ID", "name": "PAYMENT_CARD_AUTHORIZATION_REVERSED", "node": { "__typename": "PaymentCardAuthorizationReversedEvent", "accountHolderId": "ACCOUNT_HOLDER_ID", "additionalNetworkData": { "__typename": "VisaData", "transactionIdentifier": "123456" }, "approvedAmount": { "currencyCode": "USD", "value": 100 }, "avsResponseCode": "NOT_PROVIDED", "cardId": "CARD_ID", "createdAt": "2022-05-09T22:27:31.636Z", "currentFinancialAccountAvailableToSpendAmount": { "currencyCode": "USD", "value": 500 }, "currentFinancialAccountMaximumBalanceAmount": { "currencyCode": "USD", "value": 30000 }, "cvvResponseCode": "NOT_PROVIDED", "id": "NOTIFICATION_EVENT_ID", "financialAccountId": "FINANCIAL_ACCOUNT_ID", "merchantDetails": { "merchantId": "000000000011111", "name": "Safeway", "description": "Safeway - SF", "category": "MISCELLANEOUS_SPECIALTY_RETAIL", "categoryCode": "5514", "address": { "postalCode": "94105", "region": "CA", "locality": "San Francisco", "countryCodeAlpha3": "USA" }, "pointofServiceDetails": { "category": "AUTOMATED_FUEL_DISPENSER", "panEntryMode": "MAGNETIC_STRIPE", "pinEntryMode": "PIN_VERIFIED_BY_TERMINAL_DEVICE", "terminalAttendance": "ATTENDED", "isCardHolderPresent": true, "isCardPresent": true, "terminalSupportsPartialApproval": true, "isRecurring": false }, "transactionProcessingType": "PAYMENT_DEBIT", "postalCodeResponseCode": "NOT_PROVIDED", "requestedAmount": { "currencyCode": "USD", "value": 100 }, "responseCode": "APPROVED", "transactionId": "TRANSACTION_ID", "partial": true, "issuerExpiredAuthorization": true } } }, "extensions": { "signatureTimestamp": 1652135254644 } } }
The PAYMENT_CARD_AUTHORIZATION_AND_CLEAR
events will be triggered when an Authorization and Clear transition states.
Notification Event | Description |
---|---|
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED | The Payment Card Transaction Authorization & Clear is APPROVED |
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_DECLINED | The Payment Card Transaction Authorization & Clear has been DECLINED . |
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-04-26T17:56:18.284Z", "id": "NOTIFICATION_EVENT_ID", "name": "PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED", "node": { "__typename": "PaymentCardAuthorizationAndClearApprovedEvent", "accountHolderId": "ACCOUNT_HOLDER_ID", "additionalNetworkData": { "__typename": "VisaData", "transactionIdentifier": "123456" }, "approvedAmount": { "currencyCode": "USD", "value": 0 }, "avsResponseCode": "NOT_PROVIDED", "cardId": "PAYMENT_CARD_ID", "createdAt": "2022-04-26T17:56:15.173Z", "currentFinancialAccountAvailableToSpendAmount": { "currencyCode": "USD", "value": 500 }, "currentFinancialAccountMaximumBalanceAmount": { "currencyCode": "USD", "value": 30000 }, "cvvResponseCode": "MATCH", "id": "PAYMENT_CARD_AUTHORIZATION_EVENT_ID", "financialAccountId": "FINANCIAL_ACCOUNT_ID", "merchantDetails": { "merchantId": "000000000011111", "name": "Safeway", "description": "Safeway - SF", "category": "MISCELLANEOUS_SPECIALTY_RETAIL", "categoryCode": "5514", "address": { "postalCode": "94105", "region": "CA", "locality": "San Francisco", "countryCodeAlpha3": "USA" }, "pointOfServiceDetails": { "category": "AUTOMATED_FUEL_DISPENSER", "panEntryMode": "MAGNETIC_STRIPE", "pinEntryMode": "PIN_VERIFIED_BY_TERMINAL_DEVICE", "terminalAttendance": "ATTENDED", "isCardHolderPresent": true, "isCardPresent": true, "terminalSupportsPartialApproval": true, "isRecurring": false }, "transactionProcessingType": "PAYMENT_DEBIT", "postalCodeResponseCode": "NOT_PROVIDED", "requestedAmount": { "currencyCode": "USD", "value": 0 }, "responseCode": "APPROVED", "transactionId": "TRANSACTION_ID", "partial": true } } }, "extensions": { "signatureTimestamp": 1650995780688 } } }
The PAYMENT_CARD_CLEARED
event will be triggered when a Payment Card Transaction has been Cleared.
In the Test Environment, you can trigger this event using the simulateClearing
mutation.
{ "data": { "node": { "__typename": "NotificationEvent", "createdAt": "2022-04-26T17:56:18.284Z", "id": "NOTIFICATION_EVENT_ID", "name": "PAYMENT_CARD_CLEARED", "node": { "__typename": "PaymentCardClearedEvent", "accountHolderId": "ACCOUNT_HOLDER_ID", "additionalNetworkData": { "__typename": "VisaData", "transactionIdentifier": "123456" }, "approvedAmount": { "currencyCode": "USD", "value": 0 }, "avsResponseCode": "NOT_PROVIDED", "cardId": "PAYMENT_CARD_ID", "createdAt": "2022-04-26T17:56:15.173Z", "currentFinancialAccountAvailableToSpendAmount": { "currencyCode": "USD", "value": 500 }, "currentFinancialAccountMaximumBalanceAmount": { "currencyCode": "USD", "value": 30000 }, "cvvResponseCode": "MATCH", "id": "PAYMENT_CARD_EVENT_ID", "financialAccountId": "FINANCIAL_ACCOUNT_ID", "merchantDetails": { "merchantId": "000000000011111", "name": "Safeway", "description": "Safeway - SF", "category": "MISCELLANEOUS_SPECIALTY_RETAIL", "categoryCode": "5514", "address": { "postalCode": "94105", "region": "CA", "locality": "San Francisco", "countryCodeAlpha3": "USA" }, "pointOfServiceDetails": { "category": "AUTOMATED_FUEL_DISPENSER", "panEntryMode": "MAGNETIC_STRIPE", "pinEntryMode": "PIN_VERIFIED_BY_TERMINAL_DEVICE", "terminalAttendance": "ATTENDED", "isCardHolderPresent": true, "isCardPresent": true, "terminalSupportsPartialApproval": true, "isRecurring": false }, "transactionProcessingType": "PAYMENT_DEBIT", "postalCodeResponseCode": "NOT_PROVIDED", "requestedAmount": { "currencyCode": "USD", "value": 0 }, "responseCode": "APPROVED", "transactionId": "TRANSACTION_ID", "partial": true } } }, "extensions": { "signatureTimestamp": 1650995780688 } } }
The PHYSICAL_PAYMENT_CARD
events are triggered when a Physical Payment Card shipment change occurs.
Notification Event | Description |
---|---|
PHYSICAL_PAYMENT_CARD_SHIPPED | Physical Payment Card has been shipped. |
PHYSICAL_PAYMENT_CARD_SHIP_FAILED | Physical Payment Card shipment has failed. |
{ "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 } }
The PAYMENT_CARD_VERIFICATION
events are triggered when a verification is decisioned.
Notification Event | Description |
---|---|
PAYMENT_CARD_VERIFICATION_APPROVED | The Payment Card Verification is APPROVED |
PAYMENT_CARD_VERIFICATION_DECLINED | The Payment Card Verification is DECLINED |
{ "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": 1 }, "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" }, "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": 1 }, "responseCode": "APPROVED", "transactionId": "TRANSACTION_ID" } } } }, "extensions": { "signatureTimestamp": 1652135254644 } }
The PHYSICAL_PAYMENT_CARD_GROUP_ORDER
events are triggered when a Group Order transition states.
Notification Event | Description |
---|---|
PhysicalPaymentCardGroupOrderShippedEvent | The physical Payment Card Group Order has been shipped. |
PhysicalPaymentCardGroupOrderShipFailedEvent | The physical Payment Card Group Order shipment has failed. |
{ "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 } }
Enhanced transaction data is delivered asynchronously.
Notification Event | Description |
---|---|
PAYMENT_CARD_ENHANCED_DATA_RECEIVED | A transaction has received Level 3 Data from the payment network. |
{ "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 } }