Notification types
Notifications are generated and sent to you when an event, that you are subscribed to, occurs.
- You can subscribe to notifications by providing the event type, subtype, and subscription channel (webhook, email).
- Webhooks are sent to the
callbackURL
and emails are sent to therecipientDetails.emailAddress
you provide during the onboarding process.- You can subscribe to either one channel type or both depending on the event type.
- You can also choose which events you want to enable during the onboarding process.
- To learn more about the process of subscribing using the Notifications API, refer to how to subscribe to notifications.
Notifications API supports the following event types and subtypes.
Payment transaction events
Payment transaction events (paymentUpdateNotification
) notify you of the status of asynchronous transaction statuses in the Online Payments API.
Supported subscription channel: Webhook
When subscribing to this event, you can choose one, some, or all of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all transactions regardless of status. |
PaymentApproved | Notifies you when a transaction is successfully approved. |
PaymentDeclined | Notifies you when a transaction is declined. |
PaymentErrored | Notifies you when a transaction fails with an error code. |
PaymentVoid | Notifies you when a transaction is voided by the merchant. |
Managed recurring payment events
Managed recurring payment events (recurringProgramNotification
) notify you of updates to the Managed Recurring Payments, which is offered by J.P. Morgan. Recurring payment events notify you of activities such as plan or program updates, payment dispositions, and consumer communications.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all transactions related to a recurring payment. |
PlanUpdated | Notifies you when a recurring payment plan is created or updated. |
ProgramUpdated | Notifies you when a recurring payment program is created or updated. |
PaymentApplied | Notifies you when a recurring payment amount is collected successfully during the billing period. |
PaymentNotApplied | Notifies you when a recurring payment amount was collected unsuccessfully during the billing period. |
ConsumerCommunicationUpdated | Notifies you when an email is sent to the consumer from Managed Recurring Payments. |
For additional information regarding recurring payments, refer to Managed Recurring Payments API.
Token events
Token events (tokenLifecycleNotification
) notify you when a token or tokenized data event occurs. The information related to the token is sent by the token service provider.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all token-related events. |
CardDetailsUpdate | Notifies you of any metadata changes that occurred for the tokenized card product. |
TokenStateChange | Notifies you about potential changes in the token and its state. |
TokenProvisionUpdate | Notifies you about the asynchronously provisioned token information for future processing. |
BulkTokenUpdate | Notifies you about the status information of bulk tokenization files. |
For additional information regarding tokenization and token lifecycle management, refer to Tokenization API.
Pay by Bank events
Pay by Bank events (accountUpdateNotification
) notify you when linking a Pay by Bank account succeeds or fails.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, or one of the following subtype notifications:
Subtype | Description |
---|---|
AccountLinkSuccess | Notifies you when an account link is successful. |
AccountLinkException | Notifies you when an account link fails. |
For additional information regarding Pay by Bank, refer to Pay by Bank API.
Account updater events
Account updater events (accountUpdateNotification
) notify you with the details of an updated card account.
Supported subscription channel: Webhook
When subscribing to this event, you can choose the following subtype notification:
Subtype | Description |
---|---|
AccountUpdaterStatus | Notifies you when an update is made to the account information. |
For additional information regarding account updater, refer to Account updater API..
Consumer profile events
Consumer profile events (consumerProfileNotification
) notify you when a consumer profile is created.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to a consumer profile. |
Created | Notifies you when a consumer profile is created. |
For additional information regarding consumer profiles, refer to Consumer Profile API.
Digital onboarding events
Digital onboadring events help notify you of any change during the screening and onboarding process.
Supported subscription channel: Webhook, Email
Entity events
Entity events (entityOnboardingNotification
) notify you when the status of an entity changes during the screening and onboarding process. When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to digital onboarding. |
EntityScreening | Notifies you when the status of an entity changes during the merchant screening process. |
EntityOnboarding | Notifies you when the status of an entity changes during the onboarding process. |
For additional information regarding digital onboarding and merchant screening, refer to Digital Onboarding API.
Merchant status events
Merchant status events (merchantStatusNotification
) notify you when the status of the onboarding process changes.
Supported subscription channel: Webhook, Email
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
all | Notifies you of all events related to digital onboarding. |
MerchantOnboardingInProgress | Notifies you when the merchant onboarding process in progress. |
MerchantOnboardingDeclined | Notifies you when the merchant onboarding process declines. |
MerchantOnboardingCompleted | Notifies you when the merchant onboarding process is completed. |
Payout events (coming soon)
Payout events (payoutNotification
) notify you when the status of a payout changes after it's posted for processing.
Supported subscription channel: Webhook, Email
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to payout. |
PayoutFailure | Notifies you when a payout fails during processing. |
PayoutUnderReview | Notifies you when a payout is put under review during processing. |
PayoutCreated | Notifies you when a payout is created. |
PayoutDeclined | Notifies you when a payout is declined. |
PayoutCompleted | Notifies you when a payout processing is completed. |
Report status events
Report status events (reportStatusNotification
) notify you when the status of a report changes.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to reporting. |
DailyCompleted | Notifies you when a daily report generation process completes successfully. |
WeeklyCompleted | Notifies you when a weekly report generation process completes successfully. |
MonthlyCompleted | Notifies you when a monthly report generation process completes successfully. |
AdhocRunCompleted | Notifies you when an adhoc report generation process completes successfully. |
DailyErrored | Notifies you when a daily report generation process fails due to an error. |
WeeklyErrored | Notifies you when a weekly report generation process fails due to an error. |
MonthlyErrored | Notifies you when a monthly report generation process fails due to an error. |
AdhocRunErrored | Notifies you when an adhoc report generation process fails due to an error. |
For additional information regarding reporting, refer to Reporting API.
3-D secure events
3DS events (authenticationUpdateNotification
) notify you when the authentication process completes.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to 3DS. |
AutheticationComplete | Notifies you when the authentication process completes for 3DS authentication. |
For additional information regarding 3-D secure, refer to 3DS API.
Recommendation events
Recommendation events (recommendationNotification
) notify you when a soft decline occurs on a transaction.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to recommendations. |
PaymentRetry | Notifies you when a transaction is soft declined and payment retry is recommended. |
Dispute events
Dispute events (disputeNotification
) notify you when there is a state change in the dispute case. The payment network sends the dispute information via the Disputes Management platform. (limited availability with a full rollout to follow later in 2025)
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to dispute notifications. |
DisputeClosed | Notifies you when the dispute case is closed on the payment network. |
DisputeReceived | Notifies you when the dispute case is received on the payment networ. |
DisputeMerchantResponseRequested | Notifies you when the dispute case requires a response from the merchant. |
Refund events
Refund events (refundUpdateNotification
) notify you when there is a change in the status of a refund.
Supported subscription channel: Webhook
When subscribing to this event, you can choose all, some, or one of the following subtype notifications:
Subtype | Description |
---|---|
All | Notifies you of all events related to refund notifications. |
RefundApproved | Notifies you when the refund is approved. |
RefundDeclined | Notifies you when the refund is declined. |
RefundErrored | Notifies you when the refund fails due to an error. |