Setup

The following setup is required:

• Working with Paymentus to support integration with the IDI platform.

• Completing Paymentus configuration in Customer Care.

• Customer accounts must have a valid email address.

The following setup may also be needed depending on your business requirements:

• Surcharges

• Checking/ACH payments

• Tendering retail transactions in web orders

• Scheduling payments in OnlineBill

• AdvancePay

Working with Paymentus

Integrating Paymentus with Your IDI Platform Environment

This is done on an individual environment basis. A separate setup is required for each IDI platform environment where you’ll be using the Paymentus Agent Dashboard and Customer Portal applications.

Submit a service request to have IDI coordinate with Paymentus to arrange for this. Paymentus will provide IDI with the Subdomain, TLA, and encryption keys that you’ll need to configure Paymentus configuration in the IDI platform as described in Paymentus Configuration in Customer Care later in this article.

How SSO Navigation Works

Two user classes are created in Paymentus to support SSO navigation from Customer Care and IDI self-service portal to the Paymentus Agent Dashboard and Customer Portal respectively. These users exist in Paymentus and are transparent to IDI platform users.

Users

Users represent users who navigate to the Paymentus Agent Dashboard from Customer Care. The first time a user navigates to the Agent Dashboard that user is automatically created in Paymentus. SSO ensures the user is assigned to the User Group specified in the Paymentus configuration in Customer Care. As a result, the user has limited access to specific actions in the Paymentus Agent Dashboard.

If a user needs to do more in the Agent Dashboard than what is supported through the integration, that user will require a separate User ID that provides access to additional Agent Dashboard actions. These separate Paymentus User IDs can match the user’s assigned user names; however, the IDI platform will not support SSO integration for these separately created users because it only supports SSO navigation for users in the User Group specified in Paymentus configuration in Customer Care.

Customers

Customers represent your IDI self-service portal subscribers who consume services from you and Paymentus. The first time an IDI self-service portal subscriber navigates to the Paymentus Customer Portal that subscriber is automatically created as a customer in Paymentus.

Paymentus User Interface

Note:

Paymentus functionality in the IDI platform is presented though I-frames. Paymentus controls content and functionality of these I-frames. You can work with Paymentus to tailor the function and presentation of these I-frames to meet your requirements. For this reason, I-frame depictions in this article may not reflect how the I-frames are implemented in your IDI platform. Your implementation may include OR omit some fields shown in this article.

Paymentus Configuration in Customer Care

This is required to establish Paymentus as the payment vendor in your IDI platform and enable SSO navigation. This setup also applies to IDI self-service portal if applicable. Customer Care and IDI self-service portal will observe these settings rather than payment gateway settings in the Admin Console > Enhanced PCI Configuration and POS Back Office Register Policy.

To begin, in the Customer Care Apps tray select MANAGE > Paymentus Configuration.

If Paymentus integration has not yet been established for the environment, clicking Paymentus Configuration displays the Integrate withPaymentus button.

Clicking this button displays a form for configuring Paymentus integration for the environment.

Once the environment has been integrated with Paymentus, clicking this menu option takes you directly to the Paymentus Configuration form. The form has three tabs.

• The Configuration tab is for establishing users and SSO navigation.

• The Payment Options tab provides a setting to enable allocating one-time payments to a specific invoice.

• The Payment Type Groups tab lets you associate payment processing rules such as applying (or not applying) surcharges to specific customer groups.

  Note:

  This configuration is initially set up by IDI on your behalf. Admin-level users can modify this setup if needed; however, they should proceed with caution and fully understand the consequences of the changes they implement.

Note:

You can turn off Paymentus integration in this environment if needed by clicking the Turn Off Paymentus link.

Configuration Tab

The Configuration tab has two drop-down menus as described below:

• My Configuration: In the User Group field enter the User Group provided by Paymentus to grant access to functionality applicable to Customer Care and IDI self-service portal users.

• Static Configuration:

  • Paymentus Subdomain and TLA – These values are provided by Paymentus and map Paymentus to a single environment.

  • SSO Encryption Secrets – The Paymentus Agent Dashboard (for Customer Care) and Customer Portal (for IDI self-service portal) each require a different SSO Secret. These secrets are unique per IDI environment and are provided by Paymentus.

  • XOTP Key ID and Secret – These are unique per IDI environment and are provided by Paymentus.

Payment Options Tab

The ability to allocate one-time payments to a specific invoice is disabled by default. To enable, click the Payment Options tab, then check  Allow payment allocation to a specific bill setting.

Payment Type Groups Tab

Payment Type Groups let you associate a set of payment processing rules to a specific customer group. For example, you can set up a payment type group to apply a fee when paying a bill and not apply a fee when paying off an installment plan.

Rules for processing payments are established by Payment Type Codes which consist of a Code paired with a corresponding Type. A payment type group comprises one or more payment type groups as needed to correctly process all payment types for the given customer group. The codes and types used to define payment type codes are provided by Paymentus.

A payment type group is associated to one or more specific customer groups by linking the payment type group to one or more finance groups. Finance groups are set up in Admin Console Data Management. This is the sole purpose for finance groups in this application. Any other settings on the finance groups (e.g. min/max amounts or rate) do not apply for Paymentus payment processing. However, finance groups can still be used elsewhere to assess late fees as before.

There are no payment type groups out-of-the box, so at least one is required. An example setup is shown below.

You can add as many payment type groups as needed for the different sets of accounts that require specific payment processing rules. To add a payment type group, add the group and then add payment type codes and link finance groups as described below. Additional guidelines for supporting fees are described in Adding Payment Type Groups for Surcharges.

Adding a Payment Type Group

Click New in the Payment Type Group section.

This displays fields for defining the new group. Name is required. The Description is optional. In addition, you can check Supports Fees as applicable to identify the group as having surcharges. This check box is for information only. For more on applying fees, see Payment Type Groups Setup for Surcharges.

Assigning Payment Type Codes

For a selected payment type group, assign the applicable payment type code(s). The codes and types needed to do this are provided by Paymentus.

Other codes and types may be provided by Paymentus. Work with Paymentus to ensure you’re using the correct payment type codes and types for your payment scenarios, and/or develop additional ones if needed.

To add a payment type code to a payment type group, select the group and then:

Click New in the Payment Type Codes section.

In the Create Payment Type Code form enter the Code name exactly as provided to you by Paymentus. Then select the appropriate Type from the drop-down menu.

If you need to delete a payment type code for a selected group, click the associated ellipsis button.

Linking Finance Groups

Link one or more finance groups to the payment type group. This establishes which accounts will use the rules assigned to this group. Select the payment type group and click Link in the Finance Groups section.

Note:

You can link as many finance groups to a payment type group as required; however, once a finance group is linked to a payment type group, it cannot be linked to another group.

Payment Type Groups Setup for Surcharges

This lets you set up Paymentus integration to handle surcharges (fees) on bill and installment payments according to your specific requirements for different customer groups. Customer groups are established through finance group configuration in Admin Console > Data Management. Customers are assigned to a finance group on adding or editing a customer account. The following table illustrates how you might use this functionality.

Note:

You may need to set up additional finance groups if your existing groups do not support all of your surcharge scenarios.

There are two payment type codes and types specifically for supporting surcharges as described in Assigning Payment Type Codes above. You’ll need to coordinate with Paymentus to establish additional payment type codes if needed. With these codes established, use the Payment Type Groups tab to:

• Add payment type groups as required to cover all of your surcharge scenarios.

• Assign payment type codes to those groups.

• Link the groups to their respective finance groups.

As noted earlier, Payment type group configuration is initially set up by IDI on your behalf. Admin-level users can modify this setup should the need arise; however, they should proceed with caution and fully understand the consequences of the changes they implement.

Once this setup is in place:

• Surcharges/fees are applied to payments by different finance groups per their Paymentus payment type codes.

• Pending surcharges/fees are indicated in the Paymentus Agent Dashboard or Customer Portal before the payment is confirmed. This provides an opportunity to cancel the payment if necessary.

Email Address

Customer accounts must have a valid email address set up under Account Details > Contact Information.

Setup for Check/ACH Payment Transactions

Customer Care provides an option to disallow check/ACH transactions on an account-basis on the Account Details page. If this setting is checked, payment methods for the account will be limited to non-check/ACH payments. When not checked, the subscriber will be permitted to select an existing ACH /(bank) payment method or create a new e-check payment method.

Setup for Tendering Retail Transactions in Web Orders

This functionality requires you to configure POS locations (stores) and registers via IDI Desktop Client POS Back Office. Register Policy setup has been enhanced to let you select Paymentus as a tender type and then configure the Paymentus Payment Gateway details. Also, store setup has been enhanced to specify a Paymentus ID to support payments through a Paymentus peripheral device.

Note:

You’ll need to perform this configuration on a store-by-store basis.

Access to this setup is via IDI Desktop Client Applications > POS Back Office > Locations.

Register Policy Setup

This is required if you intend to use a Paymentus payment method or peripheral device.

Note:

Equivalent setup is done in Customer Care > MANAGE > Paymentus Configuration. The Customer Care setup applies when tendering bill payments and E-Pay for a selected account in Care. The register policy setup in IDI Desktop Client applies when you select a specific register to tender a web sales transaction.

To set up a register policy:

• Right-click on a location and select Register Policy from the context menu.

  

• On the Register Policies form choose to Override the global register policy if applicable, then on the Tender tab, right-click in the Tender Types Accepted area and select Choose.

  

• Select the Paymentus tender type.

  

• After adding the Paymentus tender type, right-click on it and choose Payment Gateway > Configure from the context menu.

  

• Select Paymentus.

  

• Configure the Paymentus payment gateway details.

  

• User Group – Enter the User Group provided by Paymentus to grant access to functionality applicable to IDI Desktop Client and self-service portal users.

• Paymentus Subdomain and TLA – These values are provided by Paymentus and map Paymentus to a single IDI environment.

• Agent Secret – The Paymentus Agent Dashboard (for Customer Care) requires an SSO Secret. This secret is unique per IDI environment and provided by Paymentus.

• XOTP Key ID and Secret – These are unique per IDI environment and are provided by Paymentus.

• Callback URL – This is provided by IDI.

Setting Up Paymentus Location for a Store

This is required if you intend to tender transactions using a Paymentus peripheral device. The Location ID and device(s) that will be available for that location are determined though setup coordinated by your organization and Paymentus.

To specify the Paymentus Location-id on a store-by-store basis:

• Select the store in IDI Desktop Client via Applications > POS Back Office > Locations.

• On the Add/Edit Store form, Store Info tab, enter the Paymentus location-id provided by Paymentus.

  

Setup for Scheduling Payments in OnlineBill

OnlineBill does not provide access to the Paymentus Schedule Payments page by default. To make this page available for OnlineBill users, a Schedule Payments option must be manually added to the Invoice & Payments menu via Menu Configuration. This requires admin-level access to OnlineBill.

Note:

This (equivalent) setup is not required if your subscribers use the IDI platform Customer Portal in place of OnlineBill.

• Log in as an Admin user and go to Menu Configuration.

• Scroll to the Invoice and Payments section and click + to add a new item.

  

• Add the new item as a page. Select Page from the Menu Item Type drop down menu and select Schedule Payments from the Page menu.

  

Setup for AdvancePay

The following is required to support AdvancePay through Paymentus integration:

• SaaS Configuration – In SaaS Config an authorized IDI associate must set: PURCHASEDFEATURES/ADVANCEPAY to True.

• AdvancePay Setup – If not already done, AdvancePay must be set up as described in IDI Desktop Client online help.

• Payment Type Code Setup for AdvancePay – There is a new Paymentus payment type code for AdvancePay called Orders. This payment code must be assigned to the appropriate Payment Type Group.

• Wallets – AdvancePay accounts must be set up with a Paymentus Wallet/Payment Account instead of the Credit Card E-Pay account (as currently supported).