Email alerts help you to manage important system notifications by defining who receives them and when they are delivered. This article explains how to configure custom email alerts and describes the default system alerts, which are automatically available based on platform events.
When setting up email alerts, we recommend that you use the Admin’s login email or Account Manager’s email address to ensure notifications aren’t missed and that alerts are confidential from portfolio merchants and other users.
Note
If you prefer to receive notifications using webhooks rather than through email alerts, see Set Up Webhooks for guidance on setting up webhooks.
Set Up Custom Email Alerts
By default, all custom email alerts are disabled. The platform provides a set of default email alerts when a merchant is boarded to cover critical notifications.
Important!
Email alerts are not sent to a newly provided email address until it is verified. You can verify a new email address by following the instructions in the initial enrollment email sent to the user.
To set up a custom Email Alert, log in to the portal as a user or Admin, then follow the steps outlined below:
Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.
Locate the desired event type. Alerts are organized by notification type. See Available Email Alerts for a list of available email alerts.
Click the switch on the right side of the event to activate the alert. When not subscribed, the switch displays a minus symbol. When subscribed, the switch will display a check.
Enter the email address of the alert recipient in the email field.
Click SAVE in the upper-right corner of the section to finish setting up the alert.
When the selected event takes place in your portfolio, the designated recipients receive email notifications.
Available Email Alerts
The following sections list the available email alerts by alert notification type.
Disbursement Alerts
Each alert is related to different disbursement (also called a withdrawal) actions:
Disbursement Requested: A disbursement has been requested by a user.
Disbursement Processing: A requested disbursement is processing.
Disbursement Processed: A requested disbursement has finished processing.
Disbursement Failed: A requested disbursement has failed.
Disbursement Denied: A requested disbursement has been denied.
Disbursement Returned: A requested disbursement has been returned.
Debit Disbursement Recovery: A debit disbursement recovery is processing.
Upcoming Debit Disbursement: A debit disbursement recovery is scheduled.
Merchant Alerts
Each alert is related to different merchant actions:
Merchant Created: A new merchant account was created.
Merchant Boarding: A new merchant submitted an onboarding signup form.
Merchant Boarded: A new merchant was successfully boarded to the platform.
Note
If you also enable alerts for the Merchant Conditionally Approved event, you’ll receive duplicate notifications when a merchant is onboarded with conditions. To prevent duplicate notifications, contact Partner Services or your Partner Experience Manager to request the configuration of a custom parameter that triggers the Merchant Boarded event only when merchants are onboarded without restrictions at any point during onboarding.
Merchant Manual Review: A merchant attempting to board was flagged for manual review.
Merchant Fully Boarded: A merchant that was conditionally approved is now fully boarded.
Merchant Reserved: A reserve was created for a conditionally approved merchant.
Merchant Held: A hold has been placed on a merchant attempting to board.
Merchant Denied: A merchant attempting to board was denied.
Merchant Conditionally Approved: A merchant was onboarded with conditions.
Chargeback Alerts
Each alert is related to different chargeback actions:
Chargeback Opened: A chargeback has been opened through customer dispute.
Chargeback Closed: A chargeback has been closed after being won or lost.
Chargeback Created: A new chargeback has been created through the portal.
Chargeback Lost: A chargeback has been lost.
Chargeback Won: A chargeback has been won.
Transaction Alerts
Each alert is related to different transaction actions:
Transaction Created: A transaction has been created.
Transaction Approved: A transaction was approved.
Transaction Failed: A transaction failed to receive authorization.
Transaction Captured: A transaction’s funds have been captured.
Transaction Settled: A transaction’s funds have been settled.
Transaction Returned: An attempted transaction was returned.
Transaction Echeck Funded: An ACH/eCheck payment transaction has been funded.
Terminal Transaction Created: A terminal transaction has been created.
Terminal Transaction Approved: A terminal transaction was approved.
Terminal Transaction Failed: A terminal transaction failed to receive authorization.
Invoice Alerts
Each alert is related to different invoice actions:
Invoice Created: An invoice has been created.
Invoice Cancelled: An invoice was canceled.
Invoice Expired: An invoice has exceeded its expiration date.
Invoice Viewed: An invoice has been viewed by the customer.
Invoice Paid: An invoice was paid by a customer.
Invoice Emailed: An invoice has been emailed to the customer.
Invoice Result Failure: An invoice payment resulted in a failed authorization.
Subscription Alerts
Each alert is related to different subscription actions:
Subscription Created: A subscription has been created.
Subscription Approved: A subscription was approved.
Subscription Failed: A subscription payment resulted in a failed authorization.
VAS EFE Offer Alerts
Each alert is related to different EFE offer actions:
VAS EFE Offer Created: An offer was created for a merchant.
VAS EFE Offer Expiring: An offer is expiring in seven days.
VAS EFE Offer Approved: An offer was approved.
Default Email Alerts
When a merchant first boards onto the Platform, there are predefined email alerts that are enabled for the merchant by default, to keep them informed of critical events that take place within their portfolio, even if they haven’t set up their own email alerts.
See the table below for a list of the default emails, their triggers, and destinations.
Alert Trigger | Destination Email(s) | Email Message |
|---|---|---|
Password Reset | Login Account Email | Your password has been reset. |
Blocked Transaction | Login Account Email | This transaction has been blocked. |
Released Transaction | Login Account Email | This transaction has been released from a hold. |
Transaction on Hold | Login Account Email | A hold has been placed on this transaction. |
Entity Blocked from Boarding | Login Account Email | This entity has been blocked from boarding. |
Entity Boarding on Hold | Login Account Email | A hold on boarding this entity has been placed until further review. |
Account Blocked | Login Account Email | This bank account has been blocked. |
Account on Hold | Login Account Email | A hold has been placed on this bank account. |
Invoice (after saving) | Email(s) listed on Invoice | {Copy of saved Invoice} |
Updated Account Field(s) | Related Entity Email | This bank account information has been updated. |
Chargeback Created | Login Account Email | A chargeback has been created. |
Chargeback Opened | Login Account Email | A chargeback has been opened. |
Chargeback Won | Login Account Email | This chargeback has been won. |
Chargeback Lost | Login Account Email | This chargeback has been lost. |
Chargeback Closed | Login Account Email | This chargeback has been closed. |
Login Email Change Request | Login Account Email | A request has been made to change your login account Email. |
Login Email Change Complete | Login Account Email | Your login account email change is complete. |
First Time Email Confirmation Code Sent | Account Signup Email | Click the link below to confirm your email. |
First Time Email Change Confirmation Sent | Updated Login Account Email | Click the link below to confirm your email change. |
Portal Message Sent - Transaction Hold | Login Account Email | A message has been sent in the Portal to notify users that a hold has been placed on this transaction. |
Portal Message Sent - Entity Boarding Hold | Login Account Email | A message has been sent in the Portal to notify users that a hold on boarding this entity has been placed until further review. |
Portal Message Sent - Account Hold | Login Account Email | A message has been sent in the Portal to notify users that a hold has been placed on this bank account. |
Portal Message Sent - No Refund | Login Account Email | A message has been sent in the Portal to notify users that no refund was issued. |
Portal Message Sent - Entity Return | Login Account Email | A message has been sent in the Portal to notify users that an entity return was issued. |
Portal Message Hold | Login Account Email | A hold has been placed on this Portal message. |