Use Case: Enable Disbursement Event Alerts

Owned by Miles Graves
Last updated: Dec 24, 2024 by Ada Li
4 min read

You can receive notifications when withdrawals or negative disbursement charges are created or change statuses associated with your account by setting up alerts in the portal. To receive notifications about disbursement 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 disbursement creation or status change events.

Objective

Create a new notification alert that notifies you when an update to a withdrawal or negative disbursement charge event occurs.

Audience

  • Facilitators

  • Referrers

  • Merchants

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

Enable Disbursement Event Alerts

Enable Email Alerts for a Disbursement Event

1. Open the Email Alerts Disbursements Tab

  1. Click Email Alerts under the Admin category in the left navigation panel to open the Email Alerts page.

  2. Click the Disbursements tab at the top of the page.

2. Create a New Email Alert

  1. Locate the disbursement event type on the Disbursements tab. Choose from the following types:

    • Disbursement Requested

    • Disbursement Processing

    • Disbursement Processed

    • Disbursement Failed

    • Disbursement Denied

    • Disbursement Returned

    • Debit Disbursement Recovery

    • Upcoming Debit Disbursement

  2. Click the Minus icon on the right side of the disbursement event to activate the alert.

  3. Click the Triangle icon to the left of the disbursement event title to open the event type options section.

  4. Enter the email address of the alert recipient in the email field.

  1. (Optional) Click the Plus icon to add fields for additional recipients and enter their email addresses. Click the Minus icon to remove email recipients.

  2. 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 disbursement event type occurs.

Enable Web Alerts (Webhook Notifications) for a Disbursement Event

1. Open the Web Alerts Page

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

  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

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

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

  3. (Optional) Click Advanced Options to enter information about the login ID, team, partition, or division associated with the alert.

  1. Click Next in the lower-right corner of the lightbox to move to the next section.

3. Attach your Endpoints receiving the Web Alert

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

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

  3. (Optional) Click Add Another Endpoint to add additional endpoints. Click the Trashcan icon to remove an endpoint.

  4. Click Next in the lower-right corner of the lightbox to move to the next section.

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

  1. Select Disbursements from the Resource drop-down menu.

  2. Select the type of event that triggers the alert from the Event drop-down menu.

    • Disbursement Requested

    • Disbursement Processing

    • Disbursement Processed

    • Disbursement Failed

    • Disbursement Denied

    • Disbursement Returned

    • Disbursement Entries Processed

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

  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.

  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 disbursement event occurs.

References

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