You can create an alert that notifies you when one of your new merchants is onboarded or when a merchant’s onboarding status changes. To receive notifications about merchant onboarding, you can set up email alerts or web alerts (also known as webhooks) in the Payrix Pro portal. This tutorial shows you how to configure an email or web alert for Merchant Onboarding events.
Audience: Partner
Enable Merchant Boarding Alerts
Ensure that you complete the prerequisites and all steps in a section to enable that alert type.
Note
By default, creating a new merchant account triggers an email alert. All other custom email and web alerts are disabled by default.
Prerequisites
Before attempting this tutorial, you must:
Meet the general prerequisites described in Get Started with Use Case Tutorials.
Enable Email Alerts for a Merchant Boarding Event
Complete all steps in the following sections to enable email alerts for a Merchant Boarding event.
Open the Email Alerts Merchants Tab
Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.
Click the Merchants tab at the top of the page.
Create a New Email Alert
Locate the merchant event type on the Merchants tab. Choose from the following types:
Merchant Created
Merchant Boarding
Merchant Boarded
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
Merchant Fully Boarded
Merchant Reserved
Merchant Held
Merchant Denied
Merchant Conditionally Approved
Click the switch on the right side of the Merchant Boarding event to activate the alert. When not subscribed, the switch will display a minus symbol. When subscribed, the switch will display a check.
Click the triangle icon to the left of the Merchant Boarding event title to open the event type options section.
Enter the email address of the alert recipient in the email field.
(Optional) Click the Plus icon to add fields for additional recipients and enter their email addresses. Click the Minus icon to remove email recipients.
Click SAVE in the upper-right corner of the section to finish setting up the alert.
Result: The recipients receive an email alert when the specific Merchant Boarding event type occurs.
Enable Web Alerts (Webhook Notifications) for a Merchant Boarding Event
Complete all steps in the following sections to enable web alerts for a Merchant Boarding event.
Open the Web Alerts Page
Under Admin in the left navigation panel, select Web Alerts.
Click ADD ALERT in the upper-right corner of the page to open the Add Alert dialog.
Name the New Web Alert
Enter the name of the new alert in the Name field in the first section of the Add Alert dialog.
(Optional) Enter a description of the alert in the Description field.
(Optional) Click Advanced Options to enter information about the login ID, Team, or Division associated with the alert.
Tip
You can enter the optional advanced options during any step of the setup process.
Click Next in the lower-right corner of the dialog to move to the next section.
Attach your Endpoints Receiving the Web Alert
Enter the endpoint in the Endpoint field. The endpoint is the URL address on your server that receives the alert from Payrix Pro.
(Optional) Enter the header name and header value in the open fields under the Endpoint field.
(Optional) Click Add Another Endpoint to add additional endpoints. Click the trashcan icon to remove an endpoint.
Click Next in the lower-right corner of the dialog to move to the next section.
Set Merchant Event Web Alert Triggers (Alert Resources)
Select Merchants from the Resource dropdown menu.
Select the type of event that triggers the alert from the Event dropdown menu. Choose from the following event types:
Merchant Created
Merchant Boarding
Merchant Boarded
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 Denied
Merchant Manual Review
Merchant Fully Boarded
Merchant Reserved
Merchant Held
Merchant Conditionally Approved
Create
Update
Delete
(Optional) Enter a name and description in the fields below the Resource and Event fields.
(Optional) Click Add Another Trigger to add additional alert triggers. Remove a trigger by clicking the trashcan icon to the right of the trigger.
Click Add to finish setting up the new web alert.
Result: The web alert automatically triggers when the specific Merchant Onboarding event occurs.
Next Steps
After enabling the Merchant Onboarding alert, review the following guides on enabling other alerts:
Enable Invoice Event Alerts: Create an email or web alert that triggers when an invoice is created or updated by you or one of your users.
Enable Chargeback Event Alerts: Create an email or web alert that triggers when a chargeback update, creation, or final decision occurs under your portfolio.
Enable Transaction Event Alerts: Create an email or web alert that triggers when a transaction status changes.
Enable Disbursement Event Alerts: Create an email or web alert that triggers when withdrawals or negative disbursement events occur or change status.
Enable Subscription Event Alerts: Create an email or web alert that triggers when a merchant customer's subscription changes status.