You can receive notifications when invoices associated with your account are created or change statuses by setting up alerts in the Portal. To receive notifications about invoice status changes, you can set up email alerts or web alerts (also known as webhooks) for your account. This tutorial walks you through the steps required to configure an email or web alert for invoice creation or status change events.
Objective
Create a new alert that notifies you when an update to a Merchant’s customer invoice event occurs.
Audience
Partners
Merchants
Environment
Portal (Sandbox)
Portal (Production)
Prerequisites
Note
You must have a fully boarded Payrix Pro account to perform any of the actions described in the use case guides.
Tips
Tip
By default, all custom email and web alerts are disabled. The platform provides a set of default email alerts when a Merchant is boarded to cover critical notifications. To learn more about boarding alerts, see the Enable Merchant Boarding Alerts use case.
Additional Resources
See the tips below to help you get started.
For more information, see the portal guides for the Email Alerts (Merchant or Partner) and Web Alerts pages (Merchant or Partner).
Read Setting Up Email Alerts for more details about configuring email alert notifications.
Read Setting Up Web Alerts (Webhooks) for more details about the web alert system and setup.
Enable Invoice Event Alerts
Ensure that you complete all steps in a section to enable that alert type.
Enable Email Alerts for an Invoice Event
Open the Email Alerts Invoices Tab
Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.
Click the Invoices tab at the top of the page.
Create a New Email Alert
Locate the invoice event type on the Invoices tab. Choose from the following types:
Invoice Created
Invoice Cancelled
Invoice Expired
Invoice Viewed
Invoice Paid
Invoice Emailed
Invoice Result Failure
Click the switch on the right side of the invoice 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 invoice event title to open the event type options section.
Enter the email address of the alert recipient in the email field.
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.
Tip
Use the admin or account manager’s email address to ensure notifications are not missed and that alerts are confidential.
(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 invoice event type occurs.
Enable Web Alerts (Webhook Notifications) for an Invoice Event
Open the Web Alerts Page
Click Web Alerts under the Admin category in the left navigation panel to open the Web Alerts page.
Click ADD ALERT in the upper-right corner of the page to open the Add Alert lightbox on the page.
Name the New Web Alert
Enter the name of the new alert in the Name field in the first section of the Add Alert lightbox.
(Optional) Enter an optional description of the alert in the Description field.
(Optional) Click Advanced Options to enter information about the login ID, Team, partition, 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 lightbox to move to the next section.
Tip
Click Prev in the lower-right corner to go back to a previous section at any time.
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 lightbox to move to the next section.
Set Invoice Event Web Alert Triggers (Alert Resources)
Select Invoices from the Resource dropdown menu.
Select the type of event that triggers the alert from the Event dropdown menu.
Invoice Created
Invoice Cancelled
Invoice Expired
Invoice Viewed
Invoice Paid
Invoice Emailed
Tip
Alternatively, you can use the InvoiceResults resource for web alerts for invoices that return in a Failed status.
(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 new web alert triggers when the resource and event occur.
Next Steps
After enabling the new alert, review the following use case guides for additional information on related topics:
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 Merchant Boarding Event Alerts: Create an email or web alert that triggers when Merchants' boarding 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.
Conclusion
After the alert is enabled, it automatically sends a notification when an invoice event occurs.