Versions Compared

Old Version 1

changes.mady.by.user Miles Graves

Saved on

compared with

New Version 4

changes.mady.by.user Ada Li

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can receive notifications when withdrawals or negative disbursment disbursement charges are created or change statuses associated with your account by setting up alerts in the Portalportal. 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 will walk 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 disbursment disbursement charge event occurs.

Audience

  • Facilitators

  • Referrers

  • Merchants

Environment

  • Portal (Sandbox)

  • Portal (Production)

 

Prerequisite

Info

Prerequisite:

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

Tips

Tip

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

Expand
titleClick here to enable email alerts for an invoice event.

1. Open the Email Alerts Disbursements Tab

Step 1: Click EMAIL ALERTS

  1. Click Email Alerts under the Admin category in the left

-hand

  1. navigation panel to open the Email Alerts page.

Step 2:

  1. Click the Disbursements

in the

  1. tab

menu

  1. at the top of the page.

2. Create a New Email Alert

Step 1:

  1. Locate the

Disbursement

  1. disbursement event type

in

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

Step 2:

  1. Click the

MINUS

  1. Minus icon on the right

-hand

  1. side of the

Disbursement

  1. disbursement event to activate the alert.

Step 3:

  1. Click the

TRIANGLE

  1. Triangle icon to the left of the

Disbursement

  1. disbursement event title to open the event type options section.

Step 4:

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

Note

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

Tip: Use the admin or account manager’s email address to ensure notifications are not missed and that alerts are confidential.

Step 5

  1. (Optional)

:

  1. Click the

PLUS

  1. Plus icon to add fields for additional recipients and enter their email addresses. Click the

MINUS

  1. Minus icon to remove email recipients.

Step 6:

  1. Click SAVE in the upper-right

-hand

  1. corner of the section to finish setting up the alert.

Result: The recipients receive an email alert when the specific Disbursement disbursement event type occurs.

Enable Web Alerts (Webhook Notifications) for a Disbursement Event

Expand
titleClick here to enable web alerts for an invoice event.

1. Open the Web Alerts Page

Step 1: Click WEB ALERTS

  1. Click Web Alerts under the Admin category in the left

-hand

  1. navigation panel to open the Web Alerts page.

Step 2:

  1. Click

the

  1. ADD ALERT

button

  1. in the upper-right

-hand

  1. corner of the page to open the Add Alert

Setup

  1. lightbox on the page.

2. Name the New Web Alert

Step 1: Type

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

Setup

  1. lightbox.

Step 2

  1. (Optional)

: Type

  1. Enter an optional description of the alert in the Description field.

Step 3

  1. (Optional)

:

  1. Click

ADVANCED OPTIONS

  1. Advanced Options to enter information about the

Login

  1. login ID,

Team

  1. team,

Partition

  1. partition, or

Division

  1. division associated with the alert.

Tip

Tip: You can enter the optional advanced options during any step of the setup process.

Step 5:

  1. Click

NEXT

  1. Next in the lower-right

-hand

  1. corner of the lightbox to move to the next section.

Tip

Tip: Click PREVIOUS Prev in the lower-right hand corner of the lightbox to go back to a previous section at any time.

3. Attach your Endpoints receiving the Web Alert

Step 1:

  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

  1. (Optional)

:

  1. Enter the header name and header value in the open fields under the Endpoint field.

Step 3

  1. (Optional)

: Click ADD ANOTHER ENDPOINT

  1. Click Add Another Endpoint to add additional endpoints. Click the

TRASHCAN

  1. Trashcan icon to remove an endpoint.

Step 4:

  1. Click

NEXT

  1. Next in the lower-right

-hand

  1. corner of the lightbox to move to the next section.

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

Step 1:

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

Step 2:

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

Step 3

  1. (Optional)

:

  1. Enter a name and description in the fields below the Resource and Event fields.

Step 4

  1. (Optional)

: Click ADD ANOTHER TRIGGER

  1. Click Add Another Trigger to add additional alert triggers. Remove a trigger by clicking the

TRASHCAN

  1. Trashcan icon to the right of the trigger.

Step 5:

  1. Click

ADD

  1. Add to finish setting up the new web alert.

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

Next Steps

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

Conclusion

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