Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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 (also known as webhooks) for your account. This tutorial walks 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

Tip: By default, creating a new Merchant account triggers an email alert. 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

 Click here to 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 navigation panel to open the Email Alerts page.

  • Step 2: Click the Merchants tab at the top of the page.

Screenshot 2024-01-26 123125 uc email merch.png

2. Create a New Email Alert

  • Step 1: Locate the transaction event type on the Merchants 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 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.

Warning: 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.

  • 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 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

 Click here to enable web alerts for a Merchant boarding event.

1. Open the Web Alerts Page

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

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

2. Name the New Web Alert

  • Step 1: Enter the name of the new alert in the Name field in the first section of the Add Alert lightbox.

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

  • Step 3 (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.

  • Step 4: 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.

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 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

After enabling the new alert, review the following use case guides for additional information on related topics:

Conclusion

After 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:

 

 

 

 

 

  • No labels