Documentation Index

Fetch the complete documentation index at: https://help.idibilling.com/llms.txt

Use this file to discover all available pages before exploring further.

IDI version 26.8 is now available.  Click here for details: IDI Updates.

Notifications on E-Pay Transactions

Prev Next

This release (AR 8047), provides the ability to automatically notify customers when an E-Pay payment is successful, or when an E-Pay payment is not made due to a processing problem using IDI platform Notifications.

A new data source and sample template support this functionality:

  • Data source: E-Pay Transaction Notifications

  • Notification Template: Sample SMS (SMPP) E-Pay Transaction Notification

These are intended to be used with Workflow triggers, using the Send Notification action. You can use this functionality to notify customers of failed payments, successful payment or both.

Setup

To use this functionality, you need to set up:

  • A custom notification template, based on the new sample template, with contents from the new E-Pay Transaction Notification data source

  • Workflow trigger(s) with the Send Notification Workflow action, that use the custom template

Note:

It is assumed that Customer Notifications and Workflow have been configured for your environment.

Template Setup

The sample notification template – Sample SMS (SMPP) EPay Transaction Notification – works with the new E-Pay Transaction Notifications data source. This is a protected template. Make a copy and update the copy with custom information to meet your specific requirements.

The sample template produces a generic notification to the primary service number. The contents of the notification vary based on the contents of the ErrorString field.

When an E-Pay transaction is successful:

<Company Name> Alert: E-Pay transaction forAmount has processed successfully.

When an E-Pay transaction receives an error:

<Company Name> Alert: Failed E-Pay transaction forAmount. Error message: ErrorString. Please contact customer service at <###-###-####>.

Data Source

The E-Pay Transaction Notification data source contains customer and E-Pay transaction information. This data source can be used with both text and email notifications. You are not limited to a text notification. The fields included in this data source are available to your template, and include:

Template

Note that an IDI resource can assist with template setup.

To access the template, go to:

Applications > Back Office Management > Customer Notifications > Manage Templates

To see the sample template check ShowProtected Templates.

Right click on Sample SMS (SMPP) EPay Transaction Notification and click Copy.

Then save the new template.

Notes:

  • The Source will default and should not be changed.

  • The Template Name you specify must be used in the Workflow trigger configuration.

Right-click on the newly saved template, and select Edit.

Edit the template based on your requirements for the notification, updating the <Company Name> and <###-###-####> at a minimum, and save.

Note that the sample template is designed for SMPP, with the notification going to the primary service number (“To” variable):

This can be changed to Primary Contact Email1 for an email notification.

Workflow Setup

Manual configuration in Workflow is required to send notifications for E-Pay transactions.

If notifications for both successful and failed payments are required, you’ll need to configure a separate trigger for each notification.

Note:

The Template Name on the Workflow triggers must match the template name in CostGuard client.

To Send Notifications for E-Pay transactions with errors:

  • Trigger: Payment Provider Transaction Error

  • Action: Send Notification

    Template Name: must match the ‘Template Name’ of your custom notification template

    Type: other

    ObjectID: @[PaymentAccountTransactionID]

    Delivery Type: choose the delivery method you are using for customer notifications

    sms_smpp

    sms_smtp

    email

Example:

To Send Notifications for Successful E-Pay Transactions:

  • Trigger: Payment Created with condition PaymentAccountTransactionID > 0

  • Action: Send Notification

    Template Name: must match the ‘Template Name’ of your custom notification template

    Type: other

    ObjectID: @[PaymentAccountTransactionID]

    Delivery Type: choose the delivery method you are using for customer notifications

    sms_smpp

    sms_smtp

    email

Example: