Skip to main content

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).
    • For webhooks, you must provide the callbackURL.
    • For emails, you must provide the recipientDetails.preferredLanguage and recipientDetails.emailAddress.
  • Webhooks are sent to the callbackURL and emails are sent to the recipientDetails.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.

Attention
A few things to keep in mind when you are subscribing to a notification:
  • If the callbackURL has query parameters, it must be encoded.
  • The callbackURL will be active after a buffer of 60 mins.

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:

Payment transaction event subtypes
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.

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:

Token event subtypes
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:

Pay by Bank event subtypes
Subtype Description
AccountLinkSuccess Notifies you when an account link is successful.
AccountLinkException Notifies you when an account link fails.
Note

In the initial callback notification for account link success, the account holder’s Personal Identifiable Information (PII) details like firstName, middleName, lastName, and address details are masked. To unmask an account holder’s PII, you must send a GET request to the /notifications endpoint using the notificationId provided in the initial notification to retrieve the complete PII details. 

For additional information regarding Pay by Bank, refer to Pay by Bank API.

Account updater events

Account updater events (accountUpdaterStatus) 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:

Account updater event subtypes
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:

Consumer profile event subtypes
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:

Entity event subtypes
Subtype Description Channel   
EntityScreening Notifies you when the status of an entity changes during the merchant screening process. Webhook
EntityOnboarding Notifies you when the status of an entity changes during the onboarding process. Webhook
EntityOnboardingReviewInProgress  Notifies you when the entity review is under progress during the onboarding process. You can enable this by default by providing your email address in your onboarding request. Email
EntityOnboardingInformationRequested  Notifies you when the entity review requires additional information to be processed during the onboarding process. You can enable this by default by providing your email address in your onboarding request. Email
EntityOnboardingNew (coming soon) Notifies you when a new entitiy is submitted for the onboarding process. Email
EntityOnboardingApproved (coming soon) Notifies you when the onboarding process completes successfully. Email
EntityOnboardingDeclined (coming soon) Notifies you when the onboarding process fails. Email

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 following happens:

  • Status of the onboarding process changes
  • Status of the merchant account changes

Supported subscription channel: Webhook, Email

When subscribing to this event, you can choose all, some, or one of the following subtype notifications:

Merchant status events
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.
MerchantSuspendedAutoblock Notifies you when the merchant account is suspended with autoblock.
MerchantSuspendedWithFundHold Notifies you when the merchant account is suspended with the funds on hold.
MerchantSuspendedWithoutFundHold Notifies you when the merchant account is suspended without the funds on hold.

Payout events

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:

Payout event subtypes
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.
PayoutDenied Notifies you when a payout is denied.
PayoutCompleted Notifies you when a payout processing is completed.
PayoutRejected Notifies you when a payout is rejected.
PayoutFailureResolved Notifies you when a payout which had an issue is resolved and released for deposit.
PayoutUnderReviewReleased Notifies you when a payout which was held is released.
PayoutRejectedResolved Notifies you when a rejected payout which was resubmitted and released for deposit.

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:

Report status event subtypes
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:

3DS event subtypes
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:

Recommendation event subtypes
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:

Dispute event subtypes
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 network.
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:

Refund event subtypes
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.

QR code events

QR code events (qrCodeStatusNotification) notify you when the status of a QR code changes in the payment life cycle.

Supported subscription channel: Webhook

When subscribing to this event, you can choose all, some, or one of the following subtype notifications:

QR code event subtypes
Subtype Description
All Notifies you of all events related to QR code notifications.
QRCodeCreated Notifies you when a QR code is created.
QRCodeExpired Notifies you when a QR code expires.
QRCodePaid Notifies you when a payment is made using the QR code.
QRCodeSettlementProcessing Notifies you when a payment that was made using the QR code is under processing for settlement.
QRCodeCancelled Notifies you when a QR code is cancelled.

For additional information regarding QR code, refer to Pay via QR code.

Subscribe to notifications