Pre-Populate Merchant Sign Up Forms

Owned by Jason Key (Deactivated)
Last updated: Jun 10, 2024 by Miles Graves
19 min read

Our platform offers the ability to pre-populate Merchant Sign Up Forms using Merchant data stored in your platforms/software/databases. Platforms can now pass any pre-existing Merchant data into the signup form using parameters in the URL and pre-populate the non-sensitive Merchant information.

Getting Started

To get started, follow the steps below:

  1. Create a Merchant Signup Form if haven’t already.

Tip: Visit the Merchant Signup Form guide for steps to create one.

  1. Copy the link from the Merchant Signup Form Profile (accessible by clicking on your listed Signup Form).

    1. The link should look like this: https://test-portal.{yourBrand}.com/signup/12345678

From here you can append any of the Signup Form query parameters listed below to pre-fill the information on the Merchant signup form, maximizing your flexibility and minimizing the time it takes your Merchants to board your payments platform..

Merchant Sign-Up Form Query Parameters

HTTP query parameters are a powerful way to dynamically pre-populate forms on the web, enhancing user experience by reducing manual data entry and potential errors. For Merchant Signup Forms, these parameters serve as a bridge between the Merchant data stored in your platforms and the signup process, allowing for a seamless integration of pre-existing Merchant information into the form fields.

By appending specific query parameters to the URL of the Merchant Signup Form, you can pre-fill non-sensitive information such as Merchant entity details, bank account information, business specifics, and managing member data. This capability not only streamlines the onboarding process for Merchants, making it quicker and more efficient but also offers you the flexibility to customize the signup experience to meet the unique needs of your Merchants.

The following sections delve into the specifics of how to utilize these query parameters effectively, covering everything from Merchant entity information to member details, thereby maximizing the utility of the our platform for both you and your Merchants.

Caution: While technically possible, we strongly advise users not to pre-populate any sensitive Merchant information, such as Global Business ID, Member Social Number, or Manual bank account information or specific third party ID’s from ThreatMetrix and Plaid integrations.

Any table entries below marked in the same color as this callout (red) should be handled as high-risk, sensitive data and should not be pre-populated into a Merchant signup form where possible. We simply provide this information for reference purposes.

1. Merchant Entity Information

Pre-Populated Information:

Value

Required

Description

Type

Format & Valid Values

type

Required

The legal formation structure filed by the Entity.

integer

  • 0 - Sole Proprietor

  • 1 - Corporation

  • 2 - Limited Liability Company

  • 3 - Partnership

  • 5 - Non-Profit Organization

  • 6 - Government Organization

  • 7 - C Corporation

  • 8 - S Corporation

name

Required

The name of the entity.

string

This field is a text string and must be between 1 and 100 characters long.

phone

Required

The phone number associated with this Entity.

string

This field is a text string and must be between 5 and 15 characters long. Can include dashes and area code parentheses ().

customerPhone

Optional

The customer service phone number associated with this Entity. For Merchants, this number will be displayed on the customer's credit card statement.

string

This field is a text string and must be between 5 and 15 characters long. Can include dashes and area code parentheses ().

website

Required

The web site URL associated with this Entity.

string

This field is a URL-based text string and must be between 0 and 500 characters long.

You must provide a valid URL

email

Required

The email address associated with this Entity.

string

This field is a text string and must be between 1 and 100 characters long.

haveEmployees

Required

Whether or not the Merchant entity has employees.

boolean

  • 0 - Has no employees

  • 1 - Has employees

irsFilingName

Required

The legal name the that the Merchant used to register with the IRS or CRA

string

This field is a text string and must be between 0 and 500 characters long.

public

Required

Indicates whether this is a publicly held and traded entity.

boolean

  • 0 - Private Entity

  • 1 - Public Entity

industry

Optional

Short description of the nature of the Entity’s industry.

string

This field is a text string and must be between 0 and 1000 characters long.

displayName

Optional

The name for this Entity that will be displayed on the platform portal and API records.

string

This field is a text string and must be between 1 and 1000 characters long.

payoutSecondaryDescriptor

Optional

The secondary billing descriptor to appear on the bank statements for funds transfer for the entity.

string

This field is a text string and must be between 1 and 15 characters long.

globalBusinessType

Required

The business registration type for the entity.

Indicates if the Tax Identification Number type.

string

Must be a valid a US EIN/TIN or SSN, or; Canadian BRN or SIN otherwise: "other/unknown" number.

  • ssn- U.S. Social Security Number

  • tin - U.S. Tax or Employer Identification Number

  • other - Canada BRN or SIN

globalBusinessId

Required

The business registration number for the entity.

number

This field is an alpha numeric and must be between 9 to 10 characters long

address1

Required

The street address for the Entity.

string

This field is a text string and must be between 1 and 500 characters long.

address2

Optional

The Unit or Suite number for the Entity’s street address.

string

This field is a text string and must be between 1 and 500 characters long.

city

Required

The Entity’s street address city.

string

This field is a text string and must be between 1 and 500 characters long.

state

Required

The U.S. state/territory, or Canadian province for the Entity’s street address.

string

The 2-character postal abbreviation for any U.S. state, territory or Canadian province.

U.S. States

  • AL

  • AK

  • AZ

  • AR

  • CA

  • CO

  • CT

  • DE

  • DC

  • FL

  • GA

  • HI

  • ID

  • IL

  • IN

  • IA

  • KS

  • KY

  • LA

  • ME

  • MD

  • MA

  • MI

  • MN

  • MS

  • MO

  • MT

  • NE

  • NV

  • NH

  • NJ

  • NM

  • NY

  • NC

  • ND

  • OH

  • OK

  • OR

  • PA

  • RI

  • SC

  • SD

  • TN

  • TX

  • UT

  • VT

  • VA

  • WA

  • WV

  • WI

  • WY

U.S. Territories

  • AA

  • AE

  • AP

  • AS

  • FM

  • GU

  • MH

  • MP

  • PR

  • PW

  • UM

  • VI

Canada Provinces

  • AB

  • BC

  • MB

  • NB

  • NL

  • NS

  • ON

  • PE

  • QC

  • SK

zip

Required

The Entity’s address portal code.

string

This field is an alphanumeric string and must be between 5 and 20 digits. Can include dashes.

country

Required

The Entity’s address country, U.S or Canada.

string

This field is a text string that requires a valid 3-digit postal abbreviation for any country.

  • CAN - Canada

  • USA - United States

termsAgree

Required

Whether or not the Merchant agreed to the Terms of the Referrer platform.

boolean

  • 0 - Merchant did not agree.

  • 1 - Merchant agrees.

tcAttestation

Required

Whether or not the Merhcant can attest to viewing the Payrix platform terms and conditions.

boolean

  • 0 - Merchant did not attest.

  • 1 - Merchant attests.

tcVersion

Optional

An indicator showing the version of the terms and conditions that this Entity has accepted.

string

This field is an alphanumeric text string and must be between 0 and 20 characters long.

Examples:

  • FifthThird3.2 - Fifth Third Bank Terms & Conditions Version 3.2

  • WellsFargo1.13 - Wells Fargo Bank Terms & Conditions Version 1.13

tcDate

Required

The date that the Merchant attests to viewing and agreeing to the Terms and Conditions.

date

The date is specified as a 12-digit string: YYYYMMDDHHII

Example:

202501201528 is January 20, 2025 at 15:28 (3:28 pm)

tcIp

Required

The IP address where the Terms and conditions that the Merchant viewed is hosted.

IP address

This field is a numeric string between 4 and 128 digits, using the standard decimal or colon separation.

Accepts IPv4 or IPv6 format.

Example: IPv4

0.0.0.0 = 0.0.0.0

Example: IPv6

2001:db8:3333:4444:5555:6666:7777:8888 = = 2001:db8:3333:4444:

tcAcceptDate

Optional

Date and time on which this Entity accepted the Terms and Conditions, if different.

date

The date is specified as a 12-digit string: YYYYMMDDHHII

Example:

202501201528 is January 20, 2025 at 15:28 (3:28 pm)

tcAcceptIp

Optional

IP address from which this Entity accepted the Terms and Conditions, if different.

string

This field is a numeric string between 4 and 128 digits, using the standard decimal or colon separation.

Accepts IPv4 or IPv6 format.

Example: IPv4

0.0.0.0 = 0.0.0.0

Example: IPv6

2001:db8:3333:4444:5555:6666:7777:8888 = = 2001:db8:3333:4444:

custom

Optional

Custom, free-form field for your custom identifiers.

string

This field is a text string, must be between 0 and 1000 characters long and separated by comma

Merchant Entity Information - Example Query

?type=2&name=Bob’s Bikes&phone=5555555555&customerPhone=5555555555&website=https://example-site.com&email=ex1@examplemail.com&haveEmployees=0&irsFilingName=Bob's Bicycles LLC&public=0&industry=Custom Bicycle Sales&displayName=Example Bikes&payoutSecondaryDescriptor=Example Bikes&globalBusinessId=123456789&globalBusinessType=tin&address1=123 Main St.&address2=Suite 123&city=New York&state=NY&zip=10001&country=USA&termsAgree=true&tcAttestation=true&tcVersion=PAYRIXSUBMERCHANT123&tcDate=202401201200&tcIp=0.0.0.0&tcAcceptDate=202401201200&tcAcceptIp=0.0.0.0&custom=New York-based online custom bike store.

2. Merchant Bank Account Information

The Merchant Business query section allows you to pre-populate information about the Merchant’s bank account they’ll use to pay debits for platform costs or the destination account for their deposits from their settled transaction amount payouts.

Merchant Bank Account Information - Example Query

accounts[0][account][method]=8&accounts[0][account][routing]=012345678&accounts[0][account][number]=0123456789012345&accounts[0][account][confirmNumber]=0123456789012345&accounts[0][primary]=1&accounts[0][type]=all&accounts[0][name]=Example Checking&accounts[0][description]=Business Account for Example Bike Merchant.

3. Merchant Business Information

The Merchant Business query section allows you to pre-populate information about the Merchant’s business entity and transaction processing information.

 

Merchant Business Information - Example Query

?merchant[new]=0&merchant[established]=20160120&merchant[dba]=Bob’s Bike Storemerchant[annualCCSales]=22000000&merchant[avgTicket]=150000&merchant[amex]=123456789012345&merchant[discover]=123456789012345&merchant[mcc]=5940&merchant[status]=1&merchant[boarded]=1=&merchant[inactive]=0&merchant[frozen]=0&merchant[environment]=e-commerce&merchant[visaMvv]=123456&merchant[chargebackNotificationEmail]=excb@examplemail.com&merchant[totalApprovedSales]=25000030&merchant[autoBoarded]=1&merchant[saqType]=SAQ-B&merchant[saqDate]=20160120&merchant[qsa]=Example+QSA&merchant[letterStatus]=1&merchant[letterDate]=20160120&merchant[tcAttestation]=1&merchant[visaDisclosure]=1&merchant[disclosureIP]=0.0.0.0&merchant[disclosureDate]=20160120&merchant[annualCCSaleVolume]=50000&merchant[annualACHSaleVolume]=2000&merchant[riskLevel]=low&merchant[creditRatio]=2&merchant[creditTimeliness]=1&merchant[chargebackRatio]=0&merchant[ndxDays]=3&merchant[ndxPercentage]=100&merchant[advancedBilling]=0&merchant[locationType]=78&merchant[percentKeyed]=0&merchant[totalVolume]=5000000&merchant[percentEcomm]=100&merchant[seasonal]=0&merchant[amexVolume]=15000&merchant[incrementalAuthSupported]=0&merchant[tmxSessionId]=12a345bc-67d8-9012-3e45-6f7g8901a234&merchant[percentBusiness]=15&merchant[applePayActive]=1&merchant[googlePayActive]=1&merchant[passTokenEnabled]=1&merchant[naics]=44&merchant[naicsDescription]=Retail Trade&merchant[expressBatchCloseMethod]=TimeInitiated&merchant[expressBatchCloseTime]=1830

4. Merchant Member Information

The Merchant Member query section allows you to pre-populate information about the Merchant’s managing member assigned to their account on the platform.

 

Merchant Member Information - Example Query

Final Pre-Populated Query Result

 

Quick Use Cases

Below are some use cases that can be used to streamline some commonly encountered scenarios for pre-populating a Merchant Signup form with queries.

Use Case

Description

Query Parameter

Use Case

Description

Query Parameter

Pre-Populate Entity Website

Adds the Merchant Entity’s website.

?website={https://www.example-Merchant.com}

Pre-Populate the Entity’s Street Address Country

Sets the country for the Merchant Entity’s street address.

?country={USA}

Pre-Populate a custom value for the Entity

Sets your preferred custom value to the Merchant Entity account.

?custom={your_CRM_Sales_or_Marketing_Identifier}

Pre-Populate The Merchant's Entity Name

Adds the Merchant’s entity name.

?name={Merchant+Name}

Pre-Populate The Merchant’s Associated Entity ID

Adds your Merchant’s entity ID.

merchant[entity]={t1_ent_123abc4d567890efg1h2i34}

Pre-Populate Your Merchant’s Sales Environment

Sets the Merchant’s transaction processing environment.

&merchant[environment]={MerchantEnvironment}

Pre-Populate Merchant Member Citizenship Country

Sets the Merchant’s managing member’s citizenship country.

merchant[members][0][citizenship]={USA}

Pre-Populate Merchant Member Political Exposure Status

Sets the Merchant’s managing member’s political exposure status.

merchant[members][0][politicallyExposed]={0}

Pre-Populate Merchant Member Ownership and Responsibility

Sets the Merchant’s managing member’s ownership and responsibility in the Merchant’s business.

&merchant[members][0][ownership]={7500}&merchant[members][0][significantResponsibility]={1}

Additional API Information:

  • Regardless of the value chosen for public (public can either be0 or 1), the checkbox is enabled on the signup form. Not passing the public parameter at all results in the checkbox not being enabled.

  • By setting the type parameter value as Sole Proprietor, the website parameter value will not be present on the signup form. Setting the type parameter value as Corp, Gov, LLC, Non-Profit, or Partner, the website parameter value will be present.