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.

Using Paymentus in Customer Care

Prev Next

In Customer Care, access to the Paymentus Agent Dashboard is via the Billing menu.

Graphical user interface, application, Word Description automatically generated

Choosing Billing > Paymentus displays a page with functional options on the left. Choosing an option displays the corresponding Paymentus I-frame on the right. The page defaults to the I-frame for Make Payment.

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.

Graphical user interface, application Description automatically generated

Note:

Some Paymentus I-frames may not auto-populate account number based on the current account you have open. In such cases you can use the copy icon next to the account number at the top of the page to copy the account number to clipboard to use later as needed.

Graphical user interface, text, application Description automatically generated

Make Payment

This option displays the Make Payment form.

Note:

Check/ACH payments may be allowed or disallowed for an account based on the corresponding setting in Customer Care.

  • You can edit contact information as needed.

    Note:

    The email you enter here determines where the payment confirmation email will be sent.

  • Select a customer from the Registered Customers list. This defaults to None of the above. You must select a customer account.

  • Select a Payment Method from the drop-down menu.

    Note:

    (New) options for E-check (if allowed for the account), Debit and Credit payment methods let you add a new method on-the-fly.

    A screenshot of a computer AI-generated content may be incorrect.

  • Payment Amount defaults to the current balance. You can enter a different amount if needed.

  • The progress bar at the top indicates what is done and yet to be done in the Make Payment process.

    Graphical user interface, application Description automatically generated

When you click Continue the next page displays a summary where you can review and change payment details.

Note:

The progress bar is updated accordingly. If you need to edit any details here, click the applicable Change button. Then agree to the Paymentus terms and conditions by clicking the associated check box at the bottom of this page to proceed with the payment.

Graphical user interface Description automatically generated

Click Make Payment when you’re ready. This displays a Payment in progress message.

Text Description automatically generated

When this is done, you’ll see a page indicating the payment has been submitted. A link on the bottom of this page lets you print the page.

Graphical user interface Description automatically generated

Allocating One-time Payments to a Specific Invoice

If the setting is enabled, choosing Make Payment will present an option to allocate the payment to a specific bill or continue without allocating:

Choosing to allocate to a specific bill will display a list of unpaid invoices on the account.  Click on the selector (0) for the applicable row to allocate the payment to that bill. Only one can be selected at a time. If no invoice is selected, the payment is applied to the oldest invoice with an unpaid balance. Note: Selecting an invoice for allocation will not change how the payment amount defaults in the Payment Details.

Note: At this point you can still choose to not allocate to a specific bill by unchecking that check box. Unchecking will return you to the previous form where you can continue without allocating.

Payment allocation interface showing due dates, invoice numbers, and unpaid amounts for bills.

Paymentus Accounts

This option displays a form to search for customer accounts registered in Paymentus by the Paymentus CIF scheduled job. From the search results you can manage payment methods (credit cards, debit cards, e-check, google pay etc…) for a selected account.

Enter search criteria (for example, Account Number as shown below) then click Search.

Graphical user interface, text, application, email Description automatically generated

Note:

The copy icon next to the account number at the top lets you copy to clipboard the account number for the account that’s currently open and paste it in the Account Number field.

Graphical user interface, text, application Description automatically generated

The search results will list all customer accounts that match the criteria.

Choose a customer from the list by clicking the associated radio button then click Continue.

Graphical user interface, application Description automatically generated

This displays a form for managing existing payment methods and adding new methods.

Graphical user interface, website Description automatically generated

Add Payment Method

Clicking Add Payment Method displays the form for adding a new payment method. The fields vary depending on the type of payment method you select using the drop-down menu. Selecting a method displays the applicable fields (Credit Card shown below).

Graphical user interface, application Description automatically generated

Managing an Existing Payment Method

Use the links in the Action column for an existing payment method to edit the details, remove the method or display a history of revisions that have been made to the method.

When you click Edit the available fields vary depending on the type of payment method. For example, for a credit card you can edit:

  • Card holder’s name

  • Nickname

  • Expiration date

Graphical user interface, application Description automatically generated

The History link displays a history of revisions for the payment method.

A picture containing table Description automatically generated

Clicking Remove displays a prompt that lets you confirm whether or not to remove the payment method.

Paymentus Schedule Payment

This option displays a form to create a new payment schedule.

A screenshot of a computer AI-generated content may be incorrect.

Enter the schedule and payment information and click Continue. This displays a form to review the payment schedule and make changes if needed. Click Submit when you’re done.

Graphical user interface Description automatically generated

This option displays a form to search for scheduled payments systemwide. From the search results you can use the links in the Actions menu to view, edit or cancel the schedule or view a history of changes to the schedule.

Paymentus Transactions

This option displays a form to search for transactions systemwide.

Graphical user interface, application Description automatically generated

Enter search criteria and click Search. This returns a list of transactions that match the criteria.

Table Description automatically generated with medium confidence

From here you can use the links in the Action column to view transaction details, cancel the transaction, or issue a refund. Available options depend on transaction status.

Viewing Transaction Details

The View link displays the transaction details and provides options to refund or cancel the transaction as applicable or resend the confirmation email.

Graphical user interface, application Description automatically generated

Refunding a Payment

The Refund link displays a form with pertinent details and lets you enter a note for the refund.

Graphical user interface, application Description automatically generated

Clicking Submit displays a form that lets you review the refund details.

Graphical user interface, application Description automatically generated

From here you can use the links at the bottom to print the page or find another transaction. The Find another payment option returns you to the transaction list where you can see the result of the refund.

Note:

The Related Payment column provides a link to the original (refunded) transaction and the Actions column provides just one option for viewing the refund transaction.

A screenshot of a computer Description automatically generated

Note:

Clicking a link in the Confirmation Number or Related Payment column takes you to the transaction details view.

Support for Advance Pay Auto Renewal

Paymentus integration supports:

  • Using the Paymenus payment account as the tender for an AdvancePay automatic renewal purchase.

  • Notifications from Paymentus to the IDI platform, including any details about the automatic renewal purchase and/or an applied surcharge/fee.

Automatic renewal purchase can be viewed in a Paymentus Transaction Search (using either the Customer Care via the Paymentus Agent Dashboard or IDI self-service portal via the Paymentus Customer Portal.

The Account menu has an AdvancePay Auto Renewal option.

A screenshot of a computer Description automatically generated

Selecting this option displays the AdvancePay Auto Renewal page. Use this page to manage (add/remove) auto renew services for a selected wallet.

A screenshot of a computer Description automatically generated

The Wallets drop-down menu on this page lists the wallets (payment methods) that have been set up for the account via the Paymentus I-frame. For a selected wallet, this page lists the current AdvancePay services associated to the wallet with plan, and pertinent information for the selected wallet.

Note:

If there are no wallets, a Paymentus I-frame will display and prompt you to create one.

A screenshot of a computer screen Description automatically generated

Managing Auto Renewal Services for a Wallet

The Add Services button displays a dialog for managing (adding/removing) AdvancePay auto renewal services for the selected wallet. The Configure Auto Renewal Services dialog lists all AdvancePay services for the account, and favorite price point information for each service (if known). If the list is large, you can apply a filter to make the list manageable or limit the list to a specific range of services based on the entered text string. Services that have already been added are checked. You can select other services to add by checking their respective boxes and clicking Continue.

Note:

A service can only be associated to a single wallet.

A close-up of a computer screen Description automatically generated

Removing Auto Renewal Services from a Wallet

You can also use the Configure Auto Renewal Services dialog to remove one or more previously added services by unchecking their check boxes and clicking Continue. Or you can use the ellipsis button for a service on the main page as shown below to remove the service. In either case, choosing to remove a service will display a confirmation dialog.

A screenshot of a computer screen Description automatically generated

When the Paymentus Integration is enabled, the AdvancePay > Auto Renewals option in the IDI Desktop Client changes to a hyperlink that redirects you to the new auto-renewal page in Customer Care.

A screenshot of a computer Description automatically generated

AdvancePay Scheduled Job Enhancements for Tendering an Automatic Renewal Purchase

When Paymentus integration is enabled, payments are processed through the Paymentus APIs instead of the PCI payment gateway. When the AdvancePay Automation Job processes an automatic renewal purchase, the solution tenders the calculated amount due to the customer’s specific Paymentus Payment Account. Doing so supports:

  • Creating the ARP according to existing AdvancePay configuration and IDI platform rules.

  • Tendering to/with Paymentus replaces tendering to an existing E-Pay Account.

  • Creating the transaction, emails and notifications in Paymentus (as supported for Monthly Invoice Payments and Installment Plan Payoffs).

Tendering to Paymentus does not negatively impact existing AdvancePay reporting or financial-related processes.