Home / Events & Notifications

Events Reference

ACH Externally Initiated Deposit

The ACH_EXTERNALLY_INITIATED_DEPOSIT events are triggered when an incoming NACHA file credit transaction, such as payroll direct deposit, is processed.

Notification Event NameDescription
ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVEDThe externally initiated ACH Deposit has been RECEIVED
ACH_EXTERNALLY_INITIATED_DEPOSIT_PROCESSEDThe externally initiated ACH Deposit has PROCESSED
ACH_EXTERNALLY_INITIATED_DEPOSIT_FAILEDThe externally initiated ACH Deposit has FAILED

Example Payload

ACH_EXTERNALLY_INITIATED_DEPOSIT_RECEIVED
{
  "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
  }
}

ACH Externally Initiated Withdrawal

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 NameDescription
ACH_FUNDS_WITHDRAWAL_INITIATEDThe externally initiated ACH withdrawal has been INITIATED
ACH_FUNDS_WITHDRAWAL_PROCESSINGThe externally initiated ACH withdrawal is PROCESSING
ACH_FUNDS_WITHDRAWAL_PROCESSEDThe externally initiated ACH withdrawal was PROCESSED
ACH_FUNDS_WITHDRAWAL_FAILEDThe externally initiated ACH withdrawal has FAILED
ACH_FUNDS_WITHDRAWAL_RETURNEDThe externally initiated ACH withdrawal has been RETURNED
ACH_FUNDS_WITHDRAWAL_CANCELEDThe externally initiated ACH withdrawal is CANCELED

Example Payload

ACH_FUNDS_WITHDRAWAL_INITIATED
{
  "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
  }
}

ACH Fund In

The ACH_FUNDS_DEPOSIT events are triggered when a fund in ACH transfer is initiated or transitions states.

Notification Event NameDescription
ACH_FUNDS_DEPOSIT_INITIATEDThe fund in ACH transfer has been INITIATED
ACH_FUNDS_DEPOSIT_PROCESSINGThe fund in ACH transfer is PROCESSING
ACH_FUNDS_DEPOSIT_PROCESSEDThe fund in ACH transfer was PROCESSED
ACH_FUNDS_DEPOSIT_FAILEDThe fund in ACH transfer has FAILED
ACH_FUNDS_DEPOSIT_RETURNEDThe fund in ACH transfer has been RETURNED
ACH_FUNDS_DEPOSIT_CANCELEDThe fund in ACH transfer is CANCELED

Example Payload

ACH_FUNDS_DEPOSIT_INITIATED
{
  "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
  }
}

ACH Fund Out

The ACH_FUNDS_WITHDRAWAL events are triggered when a fund out ACH payment is initiated or transitions states.

Notification EventDescription
ACH_FUNDS_WITHDRAWAL_INITIATEDThe fund out ACH transfer has been INITIATED
ACH_FUNDS_WITHDRAWAL_PROCESSINGThe fund out ACH transfer is PROCESSING
ACH_FUNDS_WITHDRAWAL_PROCESSEDThe fund out ACH transfer was PROCESSED
ACH_FUNDS_WITHDRAWAL_FAILEDThe fund out ACH transfer has FAILED
ACH_FUNDS_WITHDRAWAL_RETURNEDThe fund out ACH transfer has been RETURNED
ACH_FUNDS_WITHDRAWAL_CANCELLEDThe fund out ACH transfer is CANCELED

Example Payload

ACH_FUNDS_WITHDRAWAL_INITIATED
{
  "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
  }
}

ACH Repayment

The ACH_REPAYMENT events are triggered when an ACH Repayment transitions states.

Notification Event NameDescription
ACH_REPAYMENT_PROCESSINGThe ACH Repayment is PROCESSING
ACH_REPAYMENT_PROCESSEDThe ACH Repayment is PROCESSED
ACH_REPAYMENT_RETURNEDThe ACH Repayment has been RETURNED
ACH_REPAYMENT_FAILEDThe ACH Repayment has FAILED

Example Payload

ACH_REPAYMENT_PROCESSED
{
  "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
  }
}

ACH Secure Deposit

The ACH_SECURE_DEPOSIT events are triggered when an ACH Secure Deposit transitions states.

Notification Event NameDescription
ACH_SECURE_DEPOSIT_INITIATEDThe ACH Secure Deposit is INITIATED
ACH_SECURE_DEPOSIT_CANCELEDThe ACH Secure Deposit is CANCELED
ACH_SECURE_DEPOSIT_PROCESSINGThe ACH Secure Deposit is PROCESSING
ACH_SECURE_DEPOSIT_PROCESSEDThe ACH Secure deposit is PROCESSED
ACH_SECURE_DEPOSIT_RETURNEDThe ACH Secure Deposit has been RETURNED
ACH_SECURE_DEPOSIT_FAILEDThe ACH Secure Deposit has FAILED

Example Payload

ACH_SECURE_DEPOSIT_PROCESSING
{
  "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
  }
}

Application Status

The CARD_PRODUCT_APPLICATION events are triggered when an Application transitions states.

Notification EventDescription
CARD_PRODUCT_APPLICATION_APPROVEDThe Applications is APPROVED
CARD_PRODUCT_APPLICATION_IN_REVIEWThe Applications is IN_REVIEW
CARD_PRODUCT_APPLICATION_MANUAL_REVIEWThe Applications is in MANUAL_REVIEW
CARD_PRODUCT_APPLICATION_DENIEDThe Applications has been DENIED
CARD_PRODUCT_APPLICATION_CLOSEDThe Applications has been CLOSED

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"
  }
}

External Bank Account

The EXTERNAL_BANK_ACCOUNT events are triggered when an external bank account is added or removed from an Account Holder.

Notification EventDescription
EXTERNAL_BANK_ACCOUNT_ADDEDThe external bank account has been verified and added to the Account Holder.
EXTERNAL_BANK_ACCOUNT_REMOVEDThe external bank account has been removed from the Account Holder.

Example Payload

EXTERNAL_BANK_ACCOUNT_CLOSED
{
  "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 Statement

The FINANCIAL_ACCOUNT_STATEMENT events are triggered at the end of a billing cycle, when a Financial Account's Billing Statement is available.

Notification EventDescription
FINANCIAL_ACCOUNT_STATEMENT_READYA Financial Account's billing period has ended and the Statement is now READY.

Example Payload

FINANCIAL_ACCOUNT_STATEMENT
{
  "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 }
}

Financial Account Status

ACCOUNT_STATUS events are triggered when a Financial Account’s Status is updated.

Notification EventDescription
ACCOUNT_STATUS_ACTIVEThe Financial Account is ACTIVE.
ACCOUNT_STATUS_UNDER_REVIEWThe Financial Account is UNDER_REVIEW.
ACCOUNT_STATUS_SUSPENDEDThe Financial Account is SUSPENDED.
ACCOUNT_STATUS_PENDING_CLOSUREThe Financial Account is PENDING_CLOSURE.
ACCOUNT_STATUS_CLOSEDThe Financial Account is CLOSED.

Example Payload

ACCOUNT_STATUS
{
  "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
  }
}

Internal Transfer from Funding Financial Account

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 EventDescription
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_PENDINGAn 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_COMPLETEDAn Internal transfer from Funding Financial Account to Payment Card Financial Account has completed.
INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT_FAILEDAn Internal transfer from Funding Financial Account to Payment Card Financial Account has been initiated but failed.

Payload Example

INTERNAL_TRANSFER_FROM_FUNDING_FINANCIAL_ACCOUNT_TO_PAYMENT_CARD_FINANCIAL_ACCOUNT
{
  "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
  }
}

Internal Transfer from Payment Card Financial Account

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 EventDescription
INTERNAL_TRANSFER_FROM_PAYMENT_CARD_FINANCIAL_ACCOUNT_TO_FUNDING_FINANCIAL_ACCOUNT_PENDINGAn 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_COMPLETEDAn 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_FAILEDAn Internal transfer from Payment Card Financial Account to a Funding Financial Account has been initiated but failed.

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
        },
        "createdAt": "2022-08-19T23:11:51.931Z",
        "id": "ia_22e017a985a3034683aa55cef491902791",
        "internalTransferStatus": "PENDING",
        "updatedAt": "2022-08-19T23:11:51.931Z"
      }
    }
  },
  "extensions": {
    "signatureTimestamp": 1660950715339
  }
}

Notification Activation

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.

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
  }
}

Payroll Advance Repayment Status

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 StatusDescription
NOT_REPAIDThe state when nothing has been paid.
FULLY_REPAIDThe balance of the PayrollAdvance is fully repaid.
PARTIALLY_REPAIDThe balance of the PayrollAdvance is partially repaid.
WRITTEN_OFFThe PayrollAdvance is written off on the Highnote platform because the 3 repayment AttemptCount was reached.

Example Payload

PAYROLL_ADVANCE_REPAYMENT
{
  "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
  }
}

Payment Card

The PAYMENT_CARD events are triggered when a Payment Card transitions states.

Notification EventDescription
PAYMENT_CARD_ACTIVATEDPayment Card has been activated.
PAYMENT_CARD_SUSPENDEDPayment Card has been suspended.
PAYMENT_CARD_UNSUSPENDEDPayment Card has been unsuspended.
PAYMENT_CARD_CLOSEDPayment Card has been 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"
      }
    }
  },
  "extensions": { "signatureTimestamp": 1638843592782 }
}

Payment Card Authorization

The PAYMENT_CARD_AUTHORIZATION events are triggered when an Authorization is created or transition states.

Notification EventDescription
PAYMENT_CARD_AUTHORIZATION_CREATEDThe Payment Card Transaction Authorization is CREATED.
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_REVERSEDThe Payment Card Transaction Authorization has been REVERSED.

Example Payload

PAYMENT_CARD_AUTHORIZATION_REVERSED
{
  "data": {
    "node": {
      "__typename": "NotificationEvent",
      "createdAt": "2022-05-09T22:27:32.871Z",
      "id": "MC4yMC5uZWVfZGM1Y2VhM2VlYjE4MjNkMzY5YWM1NzM0NjY4Yjk0ZjY=",
      "name": "PAYMENT_CARD_AUTHORIZATION_REVERSED",
      "node": {
        "__typename": "PaymentCardAuthorizationReversedEvent",
        "accountHolderId": "MC4xMi5vZ19haDAyMzA1N2MyNjFkMGMwNDNhOTgyNTYyNmJkNzZmYTI2Zjg=",
        "additionalNetworkData": {
          "__typename": "VisaData",
          "transactionIdentifier": "123456"
        },
        "approvedAmount": {
          "currencyCode": "USD",
          "value": 100
        },
        "avsResponseCode": "NOT_PROVIDED",
        "cardId": "MC43LmNkXzE=",
        "createdAt": "2022-05-09T22:27:31.636Z",
        "currentFinancialAccountAvailableToSpendAmount": {
          "currencyCode": "USD",
          "value": 500
        },
        "currentFinancialAccountMaximumBalanceAmount": {
          "currencyCode": "USD",
          "value": 30000
        },
        "cvvResponseCode": "NOT_PROVIDED",
        "id": "MC45LnRlXzk4MmY0YjEwZmM2MjQxNTg4M2MzZDExMzg4MWE2Mzcz",
        "financialAccountId": "MC40LmFjX2MwMjJhODdlYTcwNjkzYzg0OTNmOWE0YTlmMWQ0MmIyNTI5MA==",
        "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": "MC44LnR4XzIyNDFhZjhlMThkMzBiNGRjMmIwMzRhMmM1MjY4NDI5OTQ="
        }
      }
    },
    "extensions": {
      "signatureTimestamp": 1652135254644
    }
  }
}

Payment Card Authorization & Clear

The PAYMENT_CARD_AUTHORIZATION_AND_CLEAR events will be triggered when an Authorization & Clear transition states.

Notification EventDescription
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVEDThe Payment Card Transaction Authorization & Clear is APPROVED
PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_DECLINEDThe Payment Card Transaction Authorization & Clear has been DECLINED.

Example Payload

PAYMENT_CARD_AUTHORIZATION_AND_CLEAR_APPROVED
{
  "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"
        }
      }
    },
    "extensions": {
      "signatureTimestamp": 1650995780688
    }
  }
}

Payment Card Cleared

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.

Example Payload

PAYMENT_CARD_CLEARED
{
  "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"
        }
      }
    },
    "extensions": {
      "signatureTimestamp": 1650995780688
    }
  }
}

Physical Card Fulfillment

The PHYSICAL_PAYMENT_CARD events are triggered when a Physical Payment Card shipment change occurs.

Notification EventDescription
PHYSICAL_PAYMENT_CARD_SHIPPEDPhysical Payment Card has been shipped.
PHYSICAL_PAYMENT_CARD_SHIP_FAILEDPhysical Payment Card shipment has 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
  }
}

Payment Card Verification

The PAYMENT_CARD_VERIFICATION events are triggered when a verification is decisioned.

Notification EventDescription
PAYMENT_CARD_VERIFICATION_APPROVEDThe Payment Card Verification is APPROVED
PAYMENT_CARD_VERIFICATION_DECLINEDThe Payment Card Verification is DECLINED

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": 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
    }
  }
}

Physical Card Group Order

The PHYSICAL_PAYMENT_CARD_GROUP_ORDER events are triggered when a Group Order transition states.

Notification EventDescription
PhysicalPaymentCardGroupOrderShippedEventThe physical Payment Card Group Order has been shipped.
PhysicalPaymentCardGroupOrderShipFailedEventThe physical Payment Card Group Order shipment has failed.

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
  }
}

Provide Feedback

Was this content helpful?