IBX-Payroc Portal Migration

Prev Next

This document provides information on the migration of Vendor Portal mobile transactions processing from IBX to Payroc Portal. It covers the changes being made at vendor level and location level. Please note that in most cases, end-users will not need to re-register their credit cards.

PayRange will coordinate with Payroc to migrate existing locations in the backend while switching the default gateway to Payroc. Operators will not need to perform these changes manually.


Scope and Limitation

Mobile APP: The CleanPay Mobile + Customed APPs

Server: KioCentral

Payment Methods: Credit/Debit Card, Google Pay, Apple Pay

Country: US only

Market: All Markets


Merchant Onboarding

New Merchant Accounts will continue to go through a manual application process to establish the MID.

Steps for this process have been outlined below:

1. Submit completed merchant application via Agreement

2. Payroc will email the merchant account details to PayRange via email from VAR@Payroc.com

Merchant account details emailed to:  VAR@Kiosoft.com and / or email noted on ERF

Included in the email will be the following:

  • MID and DBA name in subject of email

  • Payroc Gateway Merchant ID


Integrate Payroc Portal as a Payment Gateway at the Vendor Level

  1. Go to Settings → General Settings → Credentials for New Deployment (Automation) (Payroc) and configure the MID and Template ID based on Payroc's email.

  1. In “Payment Gateway - Online Transactions” section, you can set up Payroc Portal as the payment gateway for your online transactions across all locations for two payment types: Credit/Debit and Digital Wallets.

Payment Type: Credit/Debit

  1. Login as “admin” to vendor portal and select "Settings→Payment Gateway" in the navigation menu.

  1. Under the payment type “Credit/Debit”, select Payroc Portal for the Default Payment Gateway and fill in the required fields. The first (default) payment gateway configured will be defined as the Vendor Default Settings at the location level.

The six-dot drag control in the front of Payment Gateway can be used to adjust the gateway order. You can hover over the drag control and drag it to the desired place of order.

The delete icon, represented by a trash bin, can be used to remove the payment gateway option. This action is effective immediately upon clicking, so please proceed with caution.

  1. Enter Merchant Platform ID. It’s a unique identifier assigned to you by Payroc Portal when you register for their services.

  2. Enter Gateway MID. It’s a unique identifier assigned to your application by Payroc Portal.

  3. For AVS Verification, select the way you want to verify your credit card.

This is a dropdown with the options - "Disable," "Zip Only," and "Address and Zip." "Disable" is selected by default.

If "Disable" is selected, no more AVS fields will be shown. No AVS verification should be executed.

If "Zip Only" is selected, only zip code should be input.

If "Address and Zip" is selected, both address and zip code should be input.

If the options of AVS should be changed, the credit card information would be required to input and confirm again.

  1. Enable or disable 3D Secure based on your needs.

"Disable" is set as the default for 3D Secure. When 3D secure is configured, the mobile app card registration and payment shall adhere to the following rules:

If  "Disable" is selected, no 3D Secure is executed during card registration and payment.

If  "Enable" is selected, 3D Secure is executed. The MPI reference will be obtained and used for transactions.

Additionally, you can hover you mouse over the text "3D Secure" and a statement will appear as a reference:  "Enabling 3DS requires the merchant to be enrolled in the Payroc Portal. Enrollment is complete when the billing item is added to the merchant agreement and ERF, or when an addendum/change order ERF is signed and submitted. Please ensure enrollment is complete before turning on 3DS."

If the option of 3D Secure should be changed from "Disable" to "Enable", you have to re-enter their credit card information.

  1. Select “Production” for working environment.

Payment Type: Digital Wallets (Apple Pay/Google Pay)

In Digital Wallets section, select “Payroc Portal” for the default payment gateway.

  1. Fill in the Merchant Platform ID(MID) and Gateway MID. The IDs must match with the MID in Credit Card.

  2. Fill in the Google Pay Merchant ID. It is provided by Google.

  3. Fill in the Apple Domain ID provided by Payroc Portal.


Edit Payment Gateway at the Location Level

To ensure the payments are processed through Payroc Portal, you can check or edit the payment gateways for each location.

  1. Log in as “admin” to vendor portal and navigate to Locations→Create Locations (For new customers)/Edit Locations(For existing customers)→Payment Gateway.

  • Vendor Default Settings: The Payment Gateway Preference is set to “Vendor Default Settings” by default. If Payroc Portal is the default(first) gateway configured in Settings→Payment Gateway→Online Transactions, then the location will automatically use Payroc Portal as its payment gateway. The location inherits the configurations set at the vendor level.

  • Set Custom Gateway for this location:  For customers who want to only try out Payroc Portal in a certain location, selecting "Set Custom Gateway for this location" enables you to only assign the Payroc Portal to a specific location and configure its AVS Verification and 3D Secure settings.

    Note: Before saving the location, click the "Generate" button to generate the Processing Terminal ID.

Any configuration set at the location level overrides the corresponding vendor-level settings.


Check Transaction History

Once Payroc Portal is successfully configured as the payment gateway, you can view transaction history in both Pro Reports and Detail Reports, just as you currently do with IBX.

View Transaction Records in Pro Report

Navigate to Pro Reports -> Transaction Report and you can find the transaction records with payments completed through Payroc Portal (e.g. select “App Refill” under Transaction Type filter).

View Transaction Report in Detail Reports

In Reports→Detailed Reports→Mobile Refill Log, you can view the transactions processed through Payroc Portal. You have to know the date/time when switch was made to Payroc Portal to segregate transactions.