Use Case: Enable Merchant Boarding Alerts

Owned by Miles Graves
Feb 09, 2024
5 min read

You can receive a notification when one of your new Merchants is boarded, or when an existing Merchant’s status changes. To receive notifications about new Merchant boarding, you can set up email alerts or web alerts (webhooks) for your account. This tutorial will walk you through the steps required to configure an email or web alert for Merchant boarding events.

Objective

Create a new alert that notifies you when a Merchant boarding event occurs.

Audience

  • Facilitators

  • Referrers

Environment

  • Portal (Sandbox)

  • Portal (Production)

Prerequisite

Prerequisite:

  • You must have a fully boarded Payrix account to perform any of the actions described in the use case guides.

Tips

Tips will provide suggestions to streamline or better prepare you to apply this use case tutorial.

Tip: By default, when a new Merchant account is created an email alert triggers. All other custom email and web alerts are disabled by default.

Additional Resources

Enable Merchant Boarding Alerts

Enable Email Alerts for a Merchant Boarding Event

1. Open the Email Alerts Merchants Tab

  • Step 1: Click EMAIL ALERTS under the Admin category in the left-hand navigation panel to open the Email Alerts page.

  • Step 2: Click MERCHANTS in the tab menu at the top of the page.

Screenshot 2024-01-26 123125 uc email merch.png
Partial view of the Email Alerts Merchants tab.

2. Create a New Email Alert

  • Step 1: Locate the transaction event type in the Transactions tab. Choose from the following types:

    • Merchant Created

    • Merchant Boarding

    • Merchant Boarded

    • Merchant Manual Review

    • Merchant Held

    • Merchant Denied

  • Step 2: Click the MINUS icon on the right hand side of the Merchant boarding event to activate the alert.

  • Step 3: Click the TRIANGLE icon to the left of the Merchant boarding event title to open the event type options section.

  • Step 4: Enter the email address of the alert recipient in the email field.

  • Step 5 (Optional): Click the PLUS icon to add fields for additional recipients and enter their email addresses. Click the MINUS icon to remove email recipients.

  • Step 6: Click SAVE in the upper right-hand 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

1. Open the Web Alerts Page

  • Step 1: Click WEB ALERTS under the Admin category in the left-hand navigation panel to open the Web Alerts page.

  • Step 2: Click the ADD ALERT button in the upper right-hand corner of the page to open the Add Alert Setup lightbox on the page.

2. Name the New Web Alert

  • Step 1: Click ADD ALERT in the upper right-hand corner of the page to open the Add Alert Setup lightbox on the page.

  • Step 2: Type the name of the new alert in the Name field in the first section of the Add Alert Setup lightbox.

  • Step 3 (Optional): Type an optional description of the alert in the Description field.

  • Step 4 (Optional): Click ADVANCED OPTIONS to enter information about the login ID, Team, Partition, or Division associated with the alert.

  • Step 5: Click NEXT in the lower right-hand corner of the lightbox to move to the next section.

3. Attach your Endpoints receiving the Web Alert

  • Step 1: Enter the endpoint in the Endpoint field. The endpoint is the URL address on your server that receives the alert from Payrix.

  • Step 2 (Optional): Enter the header name and header value in the open fields under the Endpoint field.

  • Step 3 (Optional): Click ADD ANOTHER ENDPOINT to add additional endpoints. Click the TRASHCAN icon to remove an endpoint.

  • Step 4: Click NEXT in the lower right-hand corner of the lightbox to move to the next section.

4. Set Merchant Event Web Alert Triggers (Alert Resources)

  • Step 1: Select MERCHANTS from the Resource drop-down menu.

  • Step 2: Select the type of event that triggers the alert from the Event drop-down menu. Choose from the following event types:

    • Merchant Created

    • Merchant Boarding

    • Merchant Boarded

    • Merchant Manual Review

    • Merchant Held

    • Merchant Denied

    • Create

    • Update

    • Delete

  • Step 3 (Optional): Enter a name and description in the fields below the Resource and Event fields.

  • Step 4 (Optional): Click ADD ANOTHER TRIGGER to add additional alert triggers. Remove a trigger by clicking the TRASHCAN icon to the right of the trigger.

  • Step 5: Click ADD to finish setting up the new web alert.

Result: The new web alert triggers when the resource and event occur.

Next Steps

Once the new alert is enabled, review the following use case guides for additional information on related topics:

  • 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 using the Enable Invoice Event Alerts use case.

  • Enable Chargeback Event Alerts: Create an email or web alert that triggers when a chargeback update, creation, or final decision occurs under your portfolio using the Enable Chargeback Event Alerts use case.

  • Enable Transaction Event Alerts: Create an email or web alert that triggers when various transaction status changes using the Enable Transaction Event Alerts use case.

  • Enable Disbursement Event Alerts: Create an email or web alert that triggers when withdrawals or negative disbursement events occur or change status using the Enable Disbursement Event Alerts use case.

  • Enable Change Request Event Alerts: Create an email or web alert that triggers when users in your portfolio update their bank account information manually using the Enable Change Request Event Alerts use case.

  • Enable Subscription Event Alerts: Create an email or web alert that triggers when a Merchant customer's Subscription changes status using the Enable Subscription Event Alerts use case.

Conclusion

Once the alert is enabled, it automatically sends a notification when a Merchant boarding event occurs.

References

Click the links or items below to access any of the following pages: