SnapPay integration and setup

Appxite

Introduction

This article describes how the SnapPay integration works on the Platform and how a Distributor sets it up for Sellers and Customers. It covers what SnapPay is, how a user reaches it from the Platform, and how to configure the SnapPay button either on the Invoices – Overview tab or inside the Customer’s Payment methods section. The article also explains how inheritance works between Distributor and Seller configurations and which user roles can see the button.

In this article:

What is SnapPay

SnapPay is a third-party payment portal used by some Distributors to collect Credit Card and ACH payments from their Customers. It is provided as an external service — the Platform does not process payments itself; it only connects the user to the SnapPay portal so they can manage payment details, view balances, and pay invoices there.

The integration is designed so that a Customer does not need a separate SnapPay login. When the user selects the SnapPay button on the Platform, a background sign-on happens automatically and the SnapPay portal opens in a new browser tab with the correct Customer context already applied.

NOTE! This feature was built with SnapPay in mind, but it is not limited to SnapPay. The same button in Custom Navigation logic can be used to link to any external payment provider, balance portal, or credit-limit service — any Distributor that needs to send its Sellers or Customers to an external payment-related URL can configure a custom button in the same way described below. SnapPay is used throughout this article as the most common example.

How the integration works

From the end user’s point of view the flow is simple:

  1. The user opens the Platform and navigates to the page where the SnapPay button is placed — either the Invoices – Overview tab or the Customer’s Payment methods section.
  2. The user selects the SnapPay button.
  3. The Platform performs an automatic (silent) sign-on in the background. No extra login prompt is shown to the user.
  4. A new browser tab opens with the SnapPay portal, already authenticated for the correct Customer.

If the automatic sign-on cannot be completed — for example, because the Customer organization is missing required identifiers — the Platform displays a standard error message asking the user to contact the Support team.

NOTE! Only Customer-level organizations that have been onboarded with the Distributor’s payment provider can use the SnapPay button. If the button opens an error message, contact the Distributor’s support team.

Where the SnapPay button can appear

A Distributor can choose one of two placements for the SnapPay button:

  • Invoices – Overview tab — the button is displayed in the Custom Triggers area of the Overview tab. This is the default placement.
  • Organization detailsPayments section — the button is displayed next to the Payment method field, so it sits together with the other payment-related settings for the Customer. A user reaches it by opening the Customer’s organization details page.

Both placements use the same sign-on behavior — only the location of the button changes.

Enable Custom navigation

The SnapPay button is configured under Custom Navigation. Open Settings from the top navigation bar.

In the Settings side menu, select Currency & Payments.

On the Currency & Payments page, open the Display & Navigation tab and turn on the Custom Navigation toggle.

.

Configure the SnapPay button

After Custom Navigation is enabled, fill in the Visibility Settings, Button Configuration, and (optionally) the Button placement section:

  1. Under Visibility Settings, select who should see the button: Direct Customers, Indirect Sellers, or both.
NOTE! When the button is placed under Payment methods (see step 4), only the Direct Customers visibility is meaningful — the button is displayed inside a Customer’s organization profile and is only reached when a user is acting on behalf of a Customer.
  1. Under Display Conditions, select:
    • Always show — the button appears on the Invoices – Overview tab for every matching user.
    • Show when conditions are met — the button appears only under specific conditions. The Button placement section becomes available.
  2. Under Button Configuration, enter the button label (for example, Snap) and the target URL, for example:
    https://stage.snapPayGlobal.com/SSO/Index?reqno=(resolved:SnapPaySSOToken)
  3. (Optional) In the Button placement section, select the checkbox Display custom navigation under Payment Methods instead of Overview Tab. With this option selected, the button is shown in the Customer’s Payment methods area instead of the Invoices – Overview tab.
  4. Select Save to apply the configuration.
Warning! If the Display Conditions option is changed back to Always show, the Button placement section is hidden and the button returns to the Invoices – Overview tab. Save the configuration again after any change.

Inheritance and Seller overrides

The button configuration set by a Distributor is inherited to 2-tier Seller platforms:

  • On the Distributor’s own platform, the button is visible in a Customer’s Payment methods section when a user acts on behalf of that Customer.
  • On a 2-tier Seller’s platform without its own button configuration, the button is also visible — the Distributor’s settings are inherited.
  • On a 2-tier Seller’s platform that has its own button configuration, the Seller’s own button is displayed instead. A Seller’s configuration always overrides the Distributor’s configuration.
NOTE! The Button placement setting is supported only at Distributor level. When a Seller adds its own button configuration, the button is displayed according to the Seller’s own settings

Role visibility

The SnapPay button placed under Payment methods is visible to all user roles that can sign in on behalf of a Customer organization, with one exception: the Seller agent admin role cannot see the button and cannot open the Payment methods configuration page.

Role Can see the button in the Customer’s Payment methods?
Distributor admin Yes
Super admin Yes
Seller admin Yes
Customer Yes
Customer admin Yes
Seller agent admin No

For a Seller agent admin, the Payment method area of the Customer’s Organization details page shows no button:

When a Seller agent admin tries to open the Payment methods configuration page — either by selecting the edit icon under Organization details or by opening the URL directly — the page does not open and a standard Platform error message is displayed:

“Payment method settings are managed by your account administrator.”

Limitations and important information

  • The Button placement option is configurable only at Distributor level. Sellers cannot set the button placement themselves; they can only add their own button, which overrides the inherited configuration.
  • The Button placement setting is supported only for buttons. It is not available for hyperlinks configured in the Hyperlink Configuration section.
  • The Button placement section appears only when Display Conditions is set to Show when conditions are met. It is not available when Always show is selected.
  • Users with the Seller agent admin role cannot see the button under Payment methods and cannot open the Payment methods configuration page. This restriction cannot be overridden from the Platform UI.
  • The Platform does not process payments. All payment operations happen inside the external provider (SnapPay or equivalent); the Platform only handles the sign-on and the redirect.

If a change beyond these limits is needed, submit a support request to AppXite.

Summary

SnapPay is an external payment portal that Customers reach from the Platform through a Custom Navigation button with automatic sign-on. A Distributor configures the button under SettingsCurrency & PaymentsDisplay & NavigationCustom Navigation, chooses the visibility and display conditions, and optionally moves the button from the Invoices – Overview tab into the Customer’s Payment methods section. The same configuration is inherited by 2-tier Sellers that do not define their own button, and the button is visible to all roles acting on behalf of a Customer except the Seller agent admin. The same button logic can be reused for other external payment or balance portals.

Was this article helpful?

0 out of 0 found this helpful

Add comment

Please sign in to leave a comment.