A Host is a configuration of whitelabel branding configurations and platform-wide settings that can be applied at a Partition (Facilitator) and Division (Partner) level.
Division Host configurations override Partition Host configurations. If no Division Host configuration is set up, the Merchant offering will default to the Partition-level Host configuration.
Setting up a new Host offers the following options:
General
The General Host parameters allow the Host to be configured with basic white-labeling information and setup preferences, such as business contact information for the Partner or Facilitator or defaulting to a Host’s settings when creating new Hosts.
See the following table for detailed descriptions of each General Host parameter.
Parameter | Description | Example |
|---|---|---|
Configuration | An option to select from saved pre-existing Host configurations. | N/A |
Default Configuration | Whether to make this the default for all users and entities within a Partition or Division. | Yes |
Name | The custom name given to the Host configuration displayed in the Configurations list and on the Hosts page. | GreatPay |
API Host | The custom URL hosted by a Facilitator or Partner that Merchants use to make API requests. | https://api.greatpay.com/ |
Portal Host | The custom URL hosted by a Facilitator or Partner that Merchants use to access their branded version of the Portal. | https:/portal.greatpay.com/ |
Phone | The customer service phone number listed in the Portal for a Facilitator or Partner. | +1 (555) 555-5554 |
Customer Service Email | The customer service email address listed in the Portal for a Facilitator or Partner. | |
Privacy Policy Version | The version number of the current Privacy Policy for a Facilitator or Partner. | 3.0.4 |
Whitelabel Portal User Interface
The Whitelabel Portal User Interface parameters allow the host to further brand the Merchant experience by specifying logos, colors, Merchant Signup Form availability, and setting data validation requirements.
See the following table for detailed descriptions of each Whitelabel Portal User Interface parameter.
Parameter | Description | Example |
|---|---|---|
Background Color | The accent color shown on icons and various components of the Portal. | #6CE08B |
Level 2 / Level 3 Validation | The requirements for Merchants to provide Level II or Level III interchange data when submitting transactions. | Level 2 |
Signup Form Mode | The development environment that the current whitelabeled signup form will board self-service Merchants to, Sandbox or Production. | Sandbox |
Disbursements Amount Format | The option to display disbursed amounts as Standard ($0.00) or Fractional ($0.00000) for Merchants. | Standard ($0.00) |
Logo | A custom logo shown on the whitelabeled Portal offering for a Facilitator or Partner business. | (Upload a 1200 x 1200-pixel image size in PNG or JPG format.) |
Email Logo | A custom logo shown on any email notifications sent from the Portal, such as email alerts. | (Upload a 1200 x 1200-pixel image size in PNG or JPG format.) |
PayFrame Logo | The custom logo displayed on PayFrame payment pages created by Merchants for customers. | (Upload a 64 x 64-pixel image size in PNG or JPG format.) |
Favicon | A custom icon displayed in website tabs and bookmarks created on the browser. | (Upload a 64 x 64-pixel image size in PNG or JPG format.) |
Footer Configuration
The Footer Configuration parameters allow the Host to assign all footer hyperlinks on the Portal to redirect to websites of the Facilitator or Partner’s choice, including Help Center documentation, API documentation, terms and conditions, privacy policy, and support contact information.
See the following table for detailed descriptions of each Footer Configuration parameter.
Parameter | Description | Example |
|---|---|---|
Documentation | The website URL for a Facilitator or Partner knowledge base. | https://docs.greatpay.com |
API | The URL for the API specification documentation used by a Facilitator or Partner’s whitelabeled API. | https://developer.greatpay.com/ |
Terms and Conditions | The website URL for a Facilitator or Partner’s Terms and Conditions. | https://www.greatpay.com/terms |
Privacy Policy | The website URL for a Facilitator or Partner’s Privacy Policy. | https://www.greatpay.com/privacy |
Support Email | The email address for a Facilitator or Partner’s Support team. | |
Support Phone | The phone number for a Facilitator or Partner’s Support team. | +1 (555) 555-5555 |
Support URL | The phone number for a Facilitator or Partner’s Support website for ticket intake. | https://support.greatpay.com/ |