How to add, resend, test and remove notifications View Related Charge or Subscription to Notifications View Notification History and Notification events
Add New Notifications
Notifications inform you of all the activity on your account in real-time. Notifications can be delivered by Webhook, email or SMS 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.
To configure a new Notification:
- Go to Notifications > Add New.
- Select the Notification type:
- Choose an existing Template or add a new one.
- 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.
- Insert the details From (sender's email) and Subject (email's title).
- View the Template on the right-hand side. Click on Edit Template to update it.
SMS
- Choose an existing Template or add a new one.
- Fill in the Payload Destination (receiver's phone number). Or click on Payer phone to pull the Payer's phone into the Notification.
- View the Template on the right-hand side. Click on Edit Template to update it.
-
Webhook
- Choose an existing Template, add a new one or don't select a template.
- 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.
- Fill in the Payload Destination (receiver's URL address).
- Select the specific service from the User Auth drop-down menu.
- For Sandbox environment: You can use webhook.site as a webhook receiver.
3. Click Add Notification.
Test Notifications
To test a Notification:
- Go to Notifications > Notifications > Test.
Resend Notifications
To resend a Notification:
- Go to Notifications > History > Resend for the specified Notification. You can use the filter option or browse the list.
Remove Notifications
To remove a Notification:
- Go to Notifications > Notifications > Remove.
- Confirm with Delete.
OR
- Go to Notifications > History > Actions > Remove for the specified Notification. You can use the filter option or browse the list.
- Confirm with OK.
View Related Charge or Subscription to Notifications
To review the Charge or Subscription related to the particular Notification:
- Go to Notifications> History > Actions > Related Item for the specified Notification. You can use the filter option or browse the list.
Note: (only for Failed) You can sort all Failed notifications by Parent ID by clicking the Show List By Parent button.
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 re-sent Notifications, 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, SMS 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
To review the history of sent Notifications:
- 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, SMS 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 events
Notifications inform you of all the activity on your account in real-time. Notifications can be delivered by Webhook, email, or SMS and are customizable 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 Events | Description |
|---|---|
| Transaction Success | a transaction has been processed successfully |
| Transaction Failure | a transaction has failed |
| Subscription Creation Success | a new subscription has been successfully created |
| Subscription Creation Failure | an attempt to create a new subscription has failed |
| Subscription Finished | a subscription plan has expired, either due to finalised recurring payments or the reached target amount |
| Subscription Updated | an existing subscription has been updated |
| Subscription Failed | a subscription payment has failed |
| Transaction by Subscription Complete | a subscription transaction has been successfully processed, separately from any one-off transactions. |
| Transaction by Subscription Failure | a subscription transaction has failed, separately from any one-off transactions. |
| Subscription Updated | a subscription has changed its amount, date, frequency, or any other element of the original plan |
| Refund Requested | a requested refund for a specified transaction |
| Refund Successful | a processed refund for a specified transaction |
| Refund Failed | a refund request has failed |
| Customer Card Expiration Warning (-1 month) | your customer’s stored card is 1 month away from expiring |
| Transfer Pending | a transfer has been created but not yet processed |
| Transfer Requested | a transfer has been created and processed at once |
| Transfer Partially Approved | a transfer has been partially approved |
| Transfer Partially Declined | a transfer has been partially declined |
| Transfer Declined | a transfer has been declined |
| Transfer Approved | a transfer has been approved |
| Reversal Transaction Success | a transaction has been successfully reversed |
| Reversal Transaction Failure | a transaction has not been reversed/the reversal of the transaction failed |
| Report Generated Successfully | a charge report has been created |
| Report Failed | a charge report request has failed |
| Fraud Check In Review Async Approved | a fraud transaction has been approved |
| Fraud Check In Review Async Declined | a fraud transaction has been declined |
| Fraud Check In Review | a fraud transaction is in review |
| Fraud Check Success | a fraud check has been successful |
| Fraud Check Failed | a fraud check has failed |
| Fraud Check Transaction In Review Approved | a fraud transaction has been approved |
| Fraud Check Transaction In Review Declined | a fraud transaction has been declined |
| Fraud Check Transaction In Review Async Approved | a fraud transaction has been approved |
| Fraud Check Transaction In Review Async Declined | a fraud transaction has been declined |
| Standalone Fraud Check In Review | a standalone fraud transaction is in review |
| Standalone Fraud Check In Success | a standalone fraud transaction has been processed successfully |
| Standalone Fraud Check Failed | a standalone fraud transaction has failed |
| Standalone Fraud Check In Review Approved | a standalone fraud transaction has been approved |
| Standalone Fraud Check in Review Declined | a standalone fraud transaction has been declined |
| Standalone Fraud Check In Review Async Approved | a standalone fraud transaction has been approved |
| Standalone Fraud Check In Review Async Declined | a standalone fraud transaction has been declined |