Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Overview: This Implementations resource provides information on white label and customized branding.

Providing a White Labeled experience for Payrix Partners user experience for your our Partner clients is one of our founding pillars, creating a white label instance allows our referrer partners to fully brand the Payrix Portal and platform with your company logo and branding. By creating a white label, your merchants will enjoy a fully branded user experience, which eliminates the impression that they log onto a third-party platform when accessing Payrix. We’ll also provide you with a custom URL to access the Portal and replace ‘Payrix’ with your company name. 

...

To leverage our white label, you will need to set up single-host certificates for Portal & API. Payrix strongly recommends setting these up in our Production. After submitting a white label intake request, Payrix will provide you with a Certificate Signing Request (CSR) (unless you opt to generate this on your own).

Once a CSR is submitted, you will work with your domain provider to get the signed certificates. Additionally, Payrix will configure DNS records to support sending emails on your behalf for email notifications and alerts initiated via our platform. These DNS records will need to be applied to your business domain. Once Payrix has, and the Client has installed the provided signed certificates, and Payrix has completed the white label setup, Clients can add their logos to the Portal. 

Note

Graphic Size Requirements:

  • Main: 275x80px

  • PayFrame: 60x60px

  • Email: Max height 140px

  • Favicon: 32x32px

API Subdomain

This is the subdomain

...

that will be used to access the Payrix API, white labeled to your domain.

...

Info

Example:

Our production API is located at api.payrix.com, but when we configure your white label setup we can work with your IT team to support using api.yourcompanyname.com.

Your organization will need to own the domain you'd like to use (Such as yourcompanyname.com) and we can choose to use any subdomain with that domain; api.yourcompanyname.com, payapi.yourcompanyname.com, etc.

...

 

Portal Subdomain

This is the subdomain

...

that will be used to access the Payrix Portal, white labeled to your domain.

...

Info

Example:

Your organization will need to own the domain you'd like to use (Such as  yourcompanyname.com) and we can choose to use any subdomain with that domain; portal.yourcompanyname.com, dashboard.yourcompanyname.com, etc.

 

SSL Certificates for subdomains

  • SSL certificates are required to secure the API and Portal when configured for white label. Payrix requires the partner to acquire the certificates for each of the subdomains.

  • Payrix can provide CSRs (certificate signing requests) for each subdomain, which can then be provided to your Certificate Authority of choice to purchase SSL certificates.

  • Alternatively, you can obtain certificates from your Certificate Authority without the optional CSRs, just be sure to include accurate information in the purchase without CSRs as most CAs typically won't refund for typos and mistakes.

...

White Label Intake Form Tutorial

...

Sandbox Setup

  • This is almost always "Yes", as your IT and engineering teams will need a development environment in which they can integrate the software.

  • The sandbox environment will have similar subdomains to your chosen production environment, but we prepend test- to the beginning of each. E.g. test-portal.yourcompanyname.com, test-api.yourcompanyname