Skip to main content

Boarding APIs

Updated

Overview

The Boarding APIs page enables you to securely store processor credentials and required boarding details in Merchant Central, allowing users to board new merchant accounts directly from the CRM through TurboApp.

By centralizing processor setup, Boarding APIs help organizations reduce manual entry, improve consistency, and create a smoother boarding experience for ISOs, Sub ISOs, and their teams.

Prerequisites

Before using the Boarding APIs page, make sure you have the following:

  • Access to Merchant Central.
  • The appropriate administrative permissions to manage TurboApp settings.
  • Processor credentials and required configuration details for each processor you want to enable.
  • The TurboApp - Systemwide permission, if users need systemwide access to board merchants to enabled processors.
  • The TURBOAPP_LOGIN_ACCESS feature flag enabled, if you want to restrict boarding access by group.

To open the Boarding APIs page in Merchant Central, open the main navigation panel and go to Manage → TurboApp → Boarding APIs.

How does Boarding APIs work?

The Boarding APIs page stores the processor credentials and configuration details required to board new merchant accounts through TurboApp. The information you need to enter varies by processor.

Once a processor login is configured, eligible users can select that processor when boarding merchants from the lead page. Depending on your access setup, users may be able to board merchants to all enabled processors or only to processors assigned to the lead's group.

For processor-specific setup requirements, refer to the applicable integration guide:

How to restrict access by group

By default, all users with the TurboApp - Systemwide permission can board merchants to any enabled processor from the lead page.

If needed, you can restrict this access so users can only board merchants to processors assigned to the lead group.

Enable the feature flag

To restrict Boarding API access by group, contact the Merchant Central support team and request that the TURBOAPP_LOGIN_ACCESS feature flag be enabled for your account.

After the feature flag is enabled, the User Access section appears on the Boarding APIs page. This section allows you to assign a processor login to one or more user groups.

boardingapi2.png

Assign user groups to a processor login

  1. From the main navigation panel go to Manage → TurboApp → Boarding APIs.
  2. Open or configure the applicable processor login.
  3. In the User Access section, select the user groups that should be able to use the processor login.
  4. Save your changes.

Once configured, users can only board merchants to processors that are enabled for the lead's group.

2024-10-14_17h47_29.png 

Use case: Restricting Sub ISO boarding access

Organizations that manage multiple Sub ISOs can use Boarding API group access restrictions to control which processor login each Sub ISO can use when boarding merchants through TurboApp.

For example, a parent ISO may board merchants through the same processor, such as Fiserv North, but need each Sub ISO to use only the portfolio, processor login, or Sales Rep setup assigned to its own group. In this setup, each Sub ISO is assigned to a separate group in Merchant Central, and the applicable Boarding API login is assigned only to that group.

This helps ensure that Sub ISO users can access Merchant Central and board merchants without seeing or using processor logins that belong to other groups.

Typical Sub ISO setup

A typical setup may include the following:

  • Create or confirm separate Merchant Central groups for each Sub ISO.
  • Create a separate Boarding API login for each Sub ISO, portfolio, or boarding configuration as needed.
  • Add the applicable Sales Reps to the processor login.
  • Assign each Boarding API login to the appropriate group from the User Access section (see first screenshot above).
  • Review the applicable user classes and remove the TurboApp - Systemwide permission if users should only board through processor logins assigned to their group.
  • If applicable, link each processor Sales Rep to the corresponding Merchant Central user to make the correct Sales Rep easier to select during boarding.

Once configured, users can only board merchants to processors enabled for the lead's group. This allows each Sub ISO to work within its assigned boarding setup while the parent organization continues to manage processor credentials centrally.

Note: This setup requires the TURBOAPP_LOGIN_ACCESS feature flag. If the User Access section is not visible on the Boarding APIs page, contact the Merchant Central support team to request that the feature flag be enabled.

Frequently Asked Questions

  • Who can board merchants to enabled processors by default? By default, users with the TurboApp - Systemwide permission can board merchants to any enabled processor from the lead page.
  • Can I restrict which processors a user can access? Yes. You can restrict access by group using the TURBOAPP_LOGIN_ACCESS feature flag. Once enabled, the User Access section appears on the Boarding APIs page.
  • Why is the User Access section not visible? The User Access section only appears when the TURBOAPP_LOGIN_ACCESS feature flag is enabled. Contact the Merchant Central support team to request access.
  • Can multiple groups use the same processor login? Yes. A processor login can be assigned to one or more user groups from the User Access section.
  • Can each Sub ISO have its own Boarding API login? Yes. You can create separate Boarding API logins for each Sub ISO, portfolio, or boarding configuration, then assign each login to the appropriate Merchant Central group.