Notifications

Notifications are accessed from the Notifications Management page. From the Gotransverse Navigation bar, select Setup>>Notification Management and scroll to the type of Notification you wish to manage.

The Notification Management page contains various types of messaging in Gotransverse, including interactions with External Applications. For details, refer the following pages:

There are several types of notifications available for use. They are:

Notification Description
Account Notifications Information about customer accounts.
Payment Notifications Information about payment cancellations, refunds, retries, adjustments, auto-payments, one-time payments, and remaining payment amounts.
Payment Plan Notifications Information about Payment Plan status changes and upcoming and overdue payments.
SVS Prepaid Register Notifications Information about the prepaid register for the stored value service and its register balance.
Invoice Notifications Information about overdue invoices or to distribute invoices.
Sales Order Notifications Information associated with sales.
System Notifications Information about Gotransverse.
Bill Batch Notifications Information associated with bill batches.
Dunning Notifications Information about Dunning actions that includes the transitioning from one Dunning Plan tier to another.

Notifications must be enabled and set up with FTP, HTTP or Email actions, which indicates how to distribute the Notifications.

A Notification is an optional feature that triggers an FTP action, HTTP action, or email. Notifications can make HTTP calls that send information to an external web service when triggered. Another Notification could be configured to send customized information to customers through email. You can configure specific Notification tasks to an Action with several types of operations:

  • FTP - FTP actions allow you to send a notification to a system over FTP.
  • Email - Email notifications are sent to your customer or another individual. Use the email operation to send customized Notifications at specified intervals based on a template.
  • HTTP Post - HTTP calls send information or requests to a defined URL. You can configure a URL with a User ID and password to enable integration with web services outside Gotransverse.

FTP, HTTP, and Email calls are automated and configurable.

You can also set a notification’s Approval Operations to perform operations for the system through the Approval Operations pane. This does not affect notification generation and distribution that you may have configured.

Adding or Changing a Notification

You an add a Notification at any time. Existing Notifications can be changed or updated as needed.

To add or change Notifications, perform the following steps:

  1. From the Gotransverse Navigation Bar, select Setup>>Notification Management.
  2. Find the Notification that you want to enable or update and click the Friendly Name.

The Action Configuration page opens, showing the following areas:

  • Action Details
  • HTTP Request Operations
  • Email Operations
  1. Click Edit in the Action Detail section. The Configure window opens.
  2. Enter or change the following information:
Name Identifies the Notification Category that you selected. This field cannot be changed.
Friendly Name Enter a name more descriptive to you than the category name provided in Gotransverse. Maximum 40 characters.
Enable Action Indicates whether the Action is on and available for use. Select or deselect the check box to enable or disable this action as follows:
  • Check mark - Enabled, the Notification will occur.
  • No check mark - Disabled, the Notification will not occur. This Notification can be enabled later.
Description Enter a description, if needed. Maximum 40 characters.
  1. Click Finish. The Configure Action Details window closes.
  2. Enter the type of action used to distribute the Notifications in the following sections:
  1. Configure the Approval Operations pane, if needed.

  2. When finished on the Notification Configuration page, click your browser's Back button to return to the Notification Management page.

Configuring the FTP Operation

If available, an FTP Operation can be configured.

  1. In the FTP Request Operations area, click Add or Edit to configure FTP functions for this Action. The Configure FTP Request window opens.
  2. Enter the following information:
Enable Operation Indicates whether the FTP operation on and available for use. Select or deselect the check box to enable or disable this action as follows:
  • Check mark - Enabled, the FTP Request will occur.
  • No check mark - Disabled, the FTP Request will not occur. This FTP Request can be enabled at a later time. If you choose not to Enable the FTP Request at the time you create it, then the FTP Request is not is not used by Gotransverse. FTP Requests can be enabled at any time after they are created.
External Application Required. Select one of the third-party applications that was configured. For more information on third-party applications, see External Applications.
Distribution Folder The default folder in which your invoice will be housed for access by the third-party application.
  1. Click Finish. The Configure FTP Request window closes.

Configuring the HTTP Operation

  1. In the HTTP Request Operations area, click Add or Edit to configure API functions for this Action. The Configure HTTP Request window opens.
  2. Enter the following information:

Note: The set of fields differs per the Notification Template type.

 

Enable Operation Indicates whether the HTTP operation is on and available for use. Select or clear the check box to enable or disable this action as follows:
  • Check mark - Enabled, the HTTP Request will occur.
  • No check mark - Disabled, the HTTP Request will not occur. This HTTP Request can be enabled later HTTP Requests can be enabled at any time after they are created.
HTTP Request Type

Select the HTTP Request Type:

  • User Defined—Select this option to display a default list of fields in the Configure HTTP Request window.
  • Webhook - Status Change—Select this option to display a predefined set of fields designed for configuring notifications on bill cycle status change when adding external charges to invoices. You can set up these notifications for Paused and Resumed bill cycle statuses.
    When you select this option, the additional Triggers field appears. Also, the following fields become disabled: URL, HTTP Method, Content Type, Date Format, and Payload.
Triggers Required if you selected the Webhook – Status Change option in the HTTP Request Type field. Used to configure notifications about bill cycle status change for adding external charges to invoices.

This field consists of two parts— radio buttons with Inclusive and Exclusive options and bill cycle statuses for which you can configure notifications.

Configure a notification trigger by selecting the following options:

  • InclusiveDefault. Select to receive notifications when a bill cycle changes status to the one selected from a list:
    • Select External Charges Paused to receive notifications when the bill cycle statuses changes to Paused.
    • Select External Charges Resumed to receive notifications when the bill cycle status changes to Resumed.
  • Exclusive—Select to exclude a certain bill cycle status change from notifications:
    • Select External Charges Paused to receive notifications when a bill cycle status changes to Resumed.
    • Select External Charges Resumed to receive notifications when a bill cycle statuschanges to Paused.

Note: You can select both External Charges Paused and External Charges Resumed options by holding the Shift key.

Note: Another way of configuring notifications for bill cycle status change (Paused and Resumed) is selecting the User Defined option in the HTTP Request Type field. It allows you to configure more fields for your notification such as associated URL, HTTP Method, Date Format, Content Type, and Payload settings. To set up notifications for adding external charges, fill in the required fields and set up the Trigger and Step Trigger fields.

Trigger

Available if you selected User Defined in the HTTP Request Type field.

Depending on the Notification type, you might need a Trigger that initiates the Notification action. If a Trigger is required, choose the condition on which the Notification is based: Running, Completed, Paused, or Resumed.

For example, for adding external charges you might want to set up notifications when the bill cycle status changes. To configure it, select Paused or Resumed depending on when emails should be sent out. Then, in the Step Trigger field, select Include External Charges.

Note: Another way of configuring notifications for bill cycle status changes (Paused and Resumed) is selecting the Webhook - Status Change option in the HTTP Request Type field. It has fewer configuration requirements and allows you to configure multiple triggers within a single notification request. When you select this option, the additional Triggers field appears.
Step Trigger

Available if you selected User Defined in the HTTP Request Type field. Depending on the Notification type, you might need a Step Trigger to indicate what type of action must occur to trigger the notification. The possible values include: Distribute Invoices, Render Invoices, and Include External Charges.

For example, to set up notifications for bill cycle status change when adding external charges, select Include External Charges. Then, in the Trigger field, select on which status change you want to receive notifications—Paused or Resumed.

Note: Another way of configuring notifications for bill cycle status changes (Paused and Resumed) is selecting the Webhook - Status Change option in the HTTP Request Type field. It has fewer configuration requirements and allows you to configure multiple triggers within a single notification request. When you select this option, the additional Triggers field appears.

Dunning Plan Required for Dunning Notification type. Select the Dunning Plan from the list.
From Dunning Tier Select a source tier associated with the selected Dunning Plan. The default value is Any.
To Dunning Tier Required for Dunning Notification type. Select the destination tier within the same Dunning Plan.
Account Category For multi-entity tenants only. Select the account category from the list.
URL Required. The URL of the website to access.
External Application Required. Select the necessary External Application from the list.
Http Method

Required. Select the HTTP method for completing the necessary action.

  • POST-Defines the items to deliver.
  • PUT-Defines the items to update.
  • DELETE-Defines the items to delete.
Content Type Required. Select the content type for the Payload such as application/json or text/plain.
Date Format Required. Select the necessary Date Format such as mm/dd/yyyy.
Register Balance Status Depending on the notification type, you can select a stored value service prepaid register balance status that triggers the notification. When the customer's register balance moves into the selected status, a notification is triggered. You can set the thresholds using the Gotransverse API when creating a prepaid register type.
  • Green - Register balance is above the top threshold.
  • Yellow - Register balance is between the top threshold and the middle threshold.
  • Orange - Register balance is between the middle threshold and the bottom threshold.
  • Red - Register balance is below the bottom threshold.
Register Type Depending on the notification type, select the register type that is tracked for this notification.
Application Identifies the system to which the request is made. This specifies an application login that you have already entered in Gotransverse under Admin >> Applications. See Applications for more information.
Payload

Specifies the payload for the defined Http Method that should match the structure of the expected request body and the Content Type.

Use the necessary parameters from the Palette on the right to compose the required request body.

  1. Click Add New Header Name/Value to add a new field with a certain name and value. The newly added Name and Value fields become required once added. Alternatively, click Remove Last Header Name/Value to remove the last set of Name and Value fields.
  2. To save your changes, click Finish.

Configuring the Email Operation

  1. In the Email Operation area, click Add or Edit email functions for this Notification. The Configure Email window opens.
  2. Enter the following information:
  3. Note: The set of fields differs per the Notification Template type.


Enable Operation Indicates whether the Email operation is on and available for use. Select or clear the check box to enable or disable this action as follows:
  • Check mark - Enabled, the Email will be sent.
  • No check mark - Disabled, the Email will not be sent. This HTTP Request can be enabled at a later time. If you choose not to Enable the HTTP Request at the time you create it, then the HTTP Request is not is not used by Gotransverse. HTTP Requests can be enabled at any time after they are created.
Dunning Plan Required for Dunning Notification type. Select the Dunning Plan from the list.
From Dunning Tier Select a source tier associated with the selected Dunning Plan. The default value is Any.
To Dunning Tier Required for Dunning Notification type. Select the destination tier within the same Dunning Plan.
Account Category For multi-entity tenants only. Select the account category from the list.
Trigger Information Depending on the Notification type, you might need a Trigger that initiates the Notification action. If a Trigger is required, choose the conditions on which the Notification is based.
Payment Method Depending on the Notification type, you can select all configured payment methods or a single configured payment method. The notification will only be triggered if the selected payment method is used.
Auto Payment Method

For Invoice Overdue notifications, you can select the default payment method type set for the associated billing account. The notification will only be triggered when the billing account has a default payment method that matches the selected Auto Payment Method.

For example, if you select a Credit Card payment method type for the Invoice Overdue notifications, the notification will only get triggered when the billing account’s default payment method is also of the Credit Card type.

Invoice Type Depending on the Notification type, you can configure the email operation to send an email under the following conditions:
  • All Invoices - When an invoice of any type is created.
  • Standard Invoices Only - When a standard (non-manual) invoice is created.
  • Manual Invoices Only - When a manual invoice is created.
Manual Invoice Reason Available if you select Manual Invoices Only for Invoice Type. Select one of the following:
  • Inclusive - Includes only invoices with the selected manual invoice reasons for the email operation.
  • Exclusive - Excludes invoices with the selected manual invoice reasons from the email operation.
Select manual invoice reasons from the displayed list.
Register Balance Status Depending on the notification type, you can select a stored value service prepaid register balance status that triggers the notification. When the customer's register balance moves into the selected status, a notification is triggered. You can set the thresholds using the Gotransverse API when creating a prepaid register type.
  • Green - Register balance is above the top threshold.
  • Yellow - Register balance is between the top threshold and the middle threshold.
  • Orange - Register balance is between the middle threshold and the bottom threshold.
  • Red - Register balance is below the bottom threshold.
Register Type Depending on the notification type, select the register type that is tracked for this notification.
Email Template Required. Click the drop down box and select the email template. Gotransverse provides you with a Default Invoice email template See The Email Templates Page in this documentation in the Advanced Documentation section if you want to customize or create your own Invoice email template.
Attach Depending on the notification type, you have the option of attaching a statement to the email. When you select this option, the Attachment Template drop down menu is displayed so that you can select the statement template that you want to attach to the email.
Account Email Specifies whether to use the Customer's email address from their Account. Select or deselect the check box to enable or disable this action as follows:
  • Check mark - Yes. Use the email address of the Billing Account.
  • No check mark - No. Do not use the email address of the Account.
Recipient Email Required. if you chose not to use the Account email address. The alternate Customer email address to which to the notification is sent.
Contact Category The group of contacts to which these invoices are sent. Contact Categories can be managed on the Setup>>Categories page or added here as needed.
  1. Click Finish. The Configure Email window closes.

Configuring the Approval Operation

You can configure approvals to perform operations that affect parts of the GTV system through notifications. For example, you can enable the Payment External Review operation for the Sales Order notification in the Sales Order Notifications panel on the Notification Management page. This will trigger approvals for sales orders in the GTV billing platform when an associated payment is held for external review by a bank.

To configure an approval operation:

  1. In the Navigation menu, select Setup, then Notification Management.
  2. Select the notification you want to configure. For example, Sales Order in the Sales Order Notifications panel.
  3. In the Approval Operations pane on the Action Configuration page, click Edit.

    Note: GTV Support may need to enable system settings to make the Approval Operations pane visible for some notifications.

  4. Enable or disable the approval action.
  5. Select Finish.

Disabling a Notification

You can enable or disable a notification at any time.

  1. From the Gotransverse Navigation Bar, select Setup>>Notification Management.
  2. Find the Notification that you want to disable or update and click the Friendly Name.

The Action Configuration page opens showing the following three areas:

  1. In the Action Details area, click Edit. The Configure Action Details window opens.
  2. Clear the Enable check box. No check mark means that the Notification will not occur.
  3. Click Finish. The Configure Action Details window closes. The Notification is disabled.