Notifications

Add New Notifications

Notifications inform you of all the activity on your account in real-time. Notifications can be delivered by Webhook or email and are customisable based on the Customer and a range of other parameters. For example, send receipts or alerts and trigger other business processes, such as shipping or correspondence.

Add new notifications

To configure a new Notification:

  1. Go to Notifications > Add New
  2. Select the Notification type:

Email

a. Choose an existing Template or add a new one.
b. Fill in the Payload Destination (receiver's email address). Or click on Payer's email to pull the Payer's email address into the Notification.
c. Insert the details From (sender's email) and Subject (email's title).
d. View the Template on the right-hand side. Click on Edit Template to update it.

Webhook

a.Choose an existing Template, add a new one or don't select a template.
b.If you mark the option Pass Transaction Payload, a Notification will be sent only for this particular event for the Transaction, not for every event.
c.Fill in the Payload Destination (receiver's URL address).
d.Select the specific service from the User Auth drop-down menu.
e.For Sandbox environment: You can use webhook.site as a webhook receiver.

  1. Click Add Notification.

Notification events

Notifications inform you of all the activity on your account in real time. Notifications can be delivered by Webhook or email and are customisable based on the Customer and a range of other parameters. For example, send receipts or alerts and trigger other business processes, such as shipping or correspondence.

Here are the Notification key parameters:

  • Event: a type of action on your account
  • Template: a saved draft for a type of action
  • Notification: communication supported by a template and triggered by an event

Notification events help diagnose any issues and act on amendments:

Notification EventDescription
Transaction Successa transaction has been processed successfully
Transaction Failurea transaction has failed
Subscription Creation Successa new subscription has been successfully created
Subscription Creation Failurean attempt to create a new subscription has failed
Subscription Finisheda subscription plan has expired, either due to finalized recurring payments or the reached target amount
Subscription Updatedan existing subscription has been updated
Subscription Faileda subscription payment has failed
Transaction by Subscription Completea subscription transaction has been successfully processed, separately from any one-off transactions.
Transaction by Subscription Failurea subscription transaction has failed, separately from any one-off transactions.
Subscription Updateda subscription has changed its amount, date, frequency, or any other element of the original plan
Refund Requesteda requested refund for a specified transaction
Refund Successfula processed refund for a specified transaction
Refund Faileda refund request has failed
Customer Card Expiration Warning (-1 month)your customer’s stored card is 1 month away from expiring
Reversal Transaction Successa transaction has been successfully reversed
Reversal Transaction Failurea transaction has not been reversed/the reversal of the transaction failed
Report Generated Successfullya charge report has been created
Report Faileda charge report request has failed

Remove Notifications

To remove a Notification:

  1. Go to Notifications > Notifications > Remove
  2. Confirm with Delete
Remove notifications

OR

  1. Go to Notifications> History > Remove for the specified Notification. You can use the filter option or browse the list
  2. Confirm with OK.
Remove notifications confirmation

Add new Notification Templates

Add notification template

To customize how you notify Customers about specific events:

  1. Go to Notifications > Templates > Add Template
  2. Select Email, or Webhook from the drop-down menu.

Email

a.Choose between Template builder or Raw HTML.
b.Name the template in Label and choose a Notification Event from the drop-down menu.
c. Patterns - select General.
d. Logo Source URL - insert the Logo image URL address. Choose the visibility (show or hide).
e. Title - insert the email’s title in a text format. Choose the alignment (left, right, or centre).
f. Paragraph - insert the email’s main section in a text format. Choose the alignment (left, right, or centre). Click on + Add Paragraph to create an extra paragraph.
g. Footer - insert the email’s footer in a text format. Choose the alignment (left, right, or centre).
h. Use Variables, all related to the event, to automatically insert specified information. Copy the Variables by clicking on them and paste them into the Title/Paragraph/Footer sections.
i. Check the template’s format in Preview (HTML) space on the right-hand side.
j. Select Save Template.

Webhook

a.Name the template in Label and choose a Notification Event from the drop-down menu.
b.Use Variables, all related to the event, to automatically insert specified information. Copy the Variables by clicking on them.
c.Check the template’s format in Preview space on the right-hand side.
d.Select Save Template.


Edit Notification Templates

To edit the Notification Templates:

  1. Go to Notifications > Templates > Actions > Edit for the specified template. You can use the filter option or browse the list.
  2. Make changes and click Update Template.
Edit notification template

Notification History

To review the history of sent Notifications:

  1. Go to Notifications> History > Actions > See Details for the specified Notification. You can use the filter option or browse the list.

Here are the Notification's key parameters:

  • Notification Event ID - the Event ID of the Notification.
  • Parent ID - the Parent ID of the Notification. For a re-sent Notification, it will show the ID of the Initial Notification. For an Initial Notification, the value will be blank.
  • Notification ID - the ID of the Notification.
  • Created - the time and date of creation of the Notification.
  • Event - the name of the Event (e.g. Transaction Success or Subscription Failed).
  • Type - the type of Notification (Email or Webhook).
  • Status - the status of the Notification (e.g. Success or Failure).
  • Response status - the status of the network response (e.g. OK or 404).
Notification history

View Related Charge or Subscription to Notifications

To review the Charge or Subscription related to the particular Notification:

  1. Go to Notifications> History > Actions > Related Item for the specified Notification. You can use the filter option or browse the list.
View related charge or subscription

Setup User Authentication

The User Authentication feature elevates your account's security by supporting Basic Authentication protocols for encoding webhook headers. The authorisation header is passed through a username and password in the Webhook notifications.

The authentication works by prompting a Web site visitor for a username and password. You can connect to 'Mulesoft', where Basic Auth is a must for receiving HTTPS POST requests.

To set up a new User Authentication:

  1. Go to Notifications> User Auth > Add New
  2. Fill out the name under the Label, the Username and the Password
  3. Click Add new.
Setup user authentication

Edit User Authentication

To edit an existing User Authentication:

  1. Go to Notifications > User Auth > Actions > Edit Details for the specified user authentication
  2. Click Edit Details
  3. Press Confirm.

Note: The update will affect all related notifications