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 the IDI Customer Portal

Prev Next

The IDI platform Customer Portal is designed to use the Paymentus payment vendor. Access for making payments and related functions is via the portal’s Payments menu.

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.

A screenshot of a computer Description automatically generated

OnlineBill users will enter the Paymentus Customer Portal via applicable options in the Invoice & Payment menu.

Notes:

  • 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.

  • Admin OnlineBill users can also change the names of any Paymentus-related menu option using Menu Configuration, if needed to align with the Paymentus Customer Portal.

  • For providers that replaced their OnlineBill offering with the Customer Portal, subscribers will automatically be directed to Customer Portal when entering their OnlineBill log-in credentials.

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

On accessing the Paymentus Customer Portal via the IDI Customer Portal or OnlineBill, the subscriber experience is basically the same.

Make Payment

Selecting Make Payment displays the form for starting the payment process. You can use the + Add New button to add a new payment account if needed.

Note:

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

To make a payment, check an option under Select Account(s) and click Continue to proceed to the next step.

Graphical user interface, application Description automatically generated with medium confidence

This displays the Pay My Bill form which lets you add one or more payments.

Note:

The + Add New button lets you add a new payment method. For details see Manage Payment Accounts.

To continue with Make Payment, specify the Payment Amount for each and select an option from My Wallet.

Graphical user interface, application Description automatically generated

Click Continue to proceed to the next step. This displays a summary of the payment. From here you can proceed with the payment as is or go back to make changes.

Graphical user interface, text, application Description automatically generated

If you choose to pay by clicking the Pay amount button, a receipt will be displayed.

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

From here you can choose to make another payment or print the receipt.

Allocating One-time payments to a Specific Invoice

If this functionality is enabled in the subscriber’s Profile, choosing Payments > Make Payment will present subscribers with 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:

Making a selection is optional. 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.

Manage Payment Accounts

This option displays a form listing existing payment methods for the account. This form also lets you add a new payment method.

For existing payment methods, the image indicates whether the method is the default. For methods that are not the default, the image provides a Make Default button that lets you change the default with one click. Each image also provides an Edit button that lets you edit details for the payment.

Graphical user interface, application, website Description automatically generated

Clicking Edit displays the Edit Payment method form. The editable details depend on the type of payment method (E-Check, Debit, Credit or Digital Wallet). There is also an option to remove the payment method.

Graphical user interface, application, website Description automatically generated

Clicking Add Payment Method displays the form for adding a new payment method. The required fields vary depending on the type of payment method you select using the upper tabs: E-Check, Debit, Credit or Digital Wallets (Credit shown below).

Graphical user interface, text, application Description automatically generated

Payments and Transactions

This option displays a page with a payment and transaction history. For each transaction the left column indicates the status. Also shown for each transaction are the account number, amount, date, and payment method.

Graphical user interface Description automatically generated with medium confidence

The View button in the right column lets you view the transaction details. From the detail view you can navigate back to the history via the breadcrumbs link at the top or the Back to Payment History button at the bottom.

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

Also, from the transaction history page you can search for transactions by account and/or payment type.

Graphical user interface, application Description automatically generated

The Download History button downloads a csv file to your local downloads folder.

Graphical user interface, application Description automatically generated

You’ll see a form in the upper right corner of your screen with a list of recent downloads. Clicking a link will open the corresponding file.

Graphical user interface, text, application Description automatically generated

Schedule Payments

Note:

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.

This option displays a form that lists existing payment schedules. For an existing schedule you can edit the schedule and/or payment details. Or you can add a new schedule.

Graphical user interface, application Description automatically generated

Editing schedule details

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

Editing Payment Method

This form lets you select a different payment method (if the account has more than one) or add a new method.

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

Changing Names for Paymentus Functions

Admin-level OnlineBill users can change menu option names in the Invoice & Payment menu as needed via Admin > Menu Configuration.

Graphical user interface Description automatically generated with medium confidence

Using Paymentus to Tender Transactions

This covers:

  • Tendering a transaction amount due:

  • Using a Paymentus peripheral device for in-store transactions.

  • Using a supported payment method for remote transactions.

  • Tendering a return and issuing a refund for transactions tendered through Paymentus.

  • Voiding a transaction completed through Paymentus.

This requires starting block functionality to be enabled in your system. Complete details for setting up and using starting blocks is covered in the Web Sales article in the IDI Knowledge Center.

Tendering Amount Due

Initiate the transaction. Below shows initiating a sales transaction via a starting block. Then select the account and staging items as you would for any transaction and click Review to display the Billing/Retail Summary. Below, the summary shows updating two services, each with two retail products. Each product has a $5.00 charge ($10.00 total for each service and $20.00 total for the transaction).

A screenshot of a computer Description automatically generated

When you click Proceed to Checkout, the tendering screen lets you add one or more tenders to cover the transaction charges. To tender through Paymentus, select the Paymentus tender type on the checkout TAX & TOTALS tab, then use the Method selector to choose whether to use a Paymentus device set up at the retail location (Use Paymentus Device) or use a Paymentus account set up on the customer’s account (Select Payment Method).

A screenshot of a computer Description automatically generated

Note:

You can use Paymentus tendering options in combination with other non-Paymentus tendering options. For example, you can tender part of the transaction with cash and then tender the rest through a Paymentus peripheral device.

Using a Paymentus Peripheral Device

This supports in-store tendering. To do this:

  • Select the PaymentusType, then select Use Paymentus Device and click Add. From here you can use the current device (if any) or choose to use a different device. The first time you do this, a current device will not be specified Current Device = None).

    A screenshot of a device Description automatically generated

  • In this case your only option is to click Choose. This displays a form listing all peripheral devices available at the Paymentus location. This form lets you scroll through muliple pages if there are more devices that can be displayed on the form at one time.

  • Select a device and click Use Selected Device.

    A screenshot of a computer Description automatically generated

If the selected device is available, the tender will be added successfully; otherwise, you’ll need to select a different device. From that point, the device you select will become the current device until you choose to clear it. It will be indicated on the Payment Devices form and you can choose to use the current device (Use Current) or choose another (Choose). You also have the option to Clear the current device and choose a different one.

A screenshot of a computer Description automatically generated

Using a Supported Paymentus Payment Method

This is primarily for remote (not in-store) transactions, or when a Paymentus device is not available.

To use a payment method, start by selecting Paymentus in the Type selector and Select Payment Method in the Method selector.

Note:

You can combine multiple Paymentus payment methods (a combination of credit cards, or other methods such as ACH or PayPal). For example, the customer may wish to tender purchases for two separate services using different credit cards. The Amount field lets you adjust the amount to apply for each method. Below the amount is adjusted down to $10.00. If you add a tender for a partial amount, you’ll be required to add additional tenders to cover the full amount in order to finalize the transaction.

A screenshot of a payment method Description automatically generated

Clicking Add displays the Paymentus tendering form. This form lets you select a payment method that has been up for the account in Customer Care via Billing > Paymentus, or you can use a new payment method. The tendering form will give you the option to save it.

A screenshot of a computer screen Description automatically generated

After adding the required tenders, the resulting view shows the amount tendered through Paymentus. Below shows the result of using two credit cards to tender the transaction.

A screenshot of a computer Description automatically generated

Clicking to finalize converts the transaction to a sale or order based on the starting block you used to process the transaction.

A screenshot of a computer Description automatically generated

Issuing a Refund on a Return with Paymentus

When you initiate a return, select the customer and items to return, and specify the reason and inventory status. These steps are common to any return (existing functionality). Below shows returning a total of three items tendered in two separate transactions; one tendered with cash and the other tendered through a Paymentus payment method.

A screenshot of a computer Description automatically generated

Saving these selections displays the familiar view showing the quantity and total charge for each item to be refunded. Below shows three $5.00 items (total charges = $15.00). This is also existing functionality. You can make changes to the return transaction here by adding or deleting items.

A screenshot of a computer Description automatically generated

Clicking Review presents the billing and retail summary.

A screenshot of a computer Description automatically generated

Clicking Proceed to Checkout displays the tendering page. From here you add tender types as needed to cover the full refund amount (in this case $15.00). For this return, you’ll need to add two return tenders – one to cover the transaction paid with cash, and one to cover the one tendered through Paymentus.

A screenshot of a computer Description automatically generated

Click + New to add a tender. Below shows adding a Cash tender with the amount adjusted down to $5.00 to reflect the charge for the item that was paid for with cash. Click Add to add the Cash tender. This is existing functionality.

A screenshot of a computer Description automatically generated

Then click +New again to add a Paymentus tender type for the refund due on other transaction. When you select the Paymentus tender type, the Payment Method selector provides just one option: Refund Tenders From a Previous Transaction. Note that the amount reflects the remaining amount to be refunded for this return ($10.00).

A screenshot of a payment method Description automatically generated

Clicking Add here displays a form listing the Paymentus tenders for the items you chose to return. You’ll see a row for each payment method and/or receipt. Each row shows the transaction’s receipt number, date, the Paymentus account (or device), and the total amount tendered for the payment method or receipt. This may differ from the amount being refunded, depending on the items you chose to return.

A screenshot of a computer Description automatically generated

Note:

If there are multiple rows listed (not the case above) you are only permitted to select one. Select the row and then click Refund. This displays a form indicating amount to be refunded for this tender.

Note:

The form also presents a warning indicating the refund will be final if you continue by clicking Submit. This is because the IDI platform is communicating with Paymentus in real time. This differs from non-Paymentus returns where the return is not finalized until you finalize the transaction.

A screenshot of a refund account Description automatically generated

After clicking Submit, you’ll see both the cash and Paymentus tenders.

A screenshot of a computer Description automatically generated

On finalizing you’ll see a summary of the return transaction.

A screenshot of a computer Description automatically generated

Voiding a Transaction Through Paymentus

You can void a transaction that was tendered using Paymentus.

A screenshot of a computer Description automatically generated

A screenshot of a computer screen Description automatically generated