How To - Use this guide to utilize the parameters available to Pre-Populate (or “pre-fill”) a Merchant Sign Up form with non-sensitive Merchant data stored in partner platforms. This easy URL query saves time in the boarding process, and reduces the information needed to create a Merchant account.

Payrix offers the ability to pre-populate Merchant Sign Up Forms using merchant data stored in partner 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.

Once populated data is available for the merchant to review, and edit if needed, they will input their sensitive information (such as SSN, DOB, and Banking information) to create the Merchant account in a fraction of the time.

Use Cases:

Pre-Populate an Entity Name

Sending the following URL query parameters will provide partners with a populated entity field:

?name=entityname

Pre-Populate a Merchant Environment

Sending the following URL query parameters will provide partners with a populated merchant environment field:

?name=entityname&merchant[environment]=moto

Pre-Populate a Member

Sending the following URL query parameters will provide partners with a populated entity field:

?name=entityname&merchant[environment]=moto&merchant[members][0][first]=membername

Pre-Populate a Custom Field Value

Sending the following URL query parameters will provide partners with a populated custom field:

?custom=yourvalue

Note: Some fields have specific values that can be sent, like environment and einType.

Other fields accept only 0 or 1, (boolean) which are specified in the guide.

Query Parameters Used to Pre-Populate the Merchant Sign-Up Form

Before creating the parameters, please refer to the Boarding Guide and API Doc for details on the specific fields. Below is a list of all items that you can pass in with the query string and the corresponding value type.

EXAMPLE / TEST URL: 

https://test-portal.payrix.com/signup/afrelease?type=1&name=name&phone=1111111111&customerPhone=1111111111&email=business@gmail.com&haveEmployees=1&irsFilingName=irsFilingName&industry=industry&payoutSecondaryDescriptor=payoutSecondaryDescriptor&einType=ssn&address1=6380west24ct&address2=108&city=miami&state=FL&country=USA&zip=11111&merchant[annualCCSales]=2000&merchant[avgTicket]=2000&merchant[environment]=cardPresent&merchant[mcc]=0742&merchant[established]=12/8/2021&merchant[dba]=dba&merchant[advancedBilling]=1&merchant[new]=1&merchant[locationType]=77&merchant[ndxDays]=2&merchant[percentBusiness]=50&merchant[percentEcomm]=50&merchant[percentKeyed]=10&merchant[seasonal]=1&merchant[saqType]=SAQ-A&merchant[saqDate]=12/1/2021&merchant[qsa]=qsa&merchant[pciCompliant]=1&merchant[members][0][first]=first&merchant[members][0][last]=last&merchant[members][0][middle]=middle&merchant[members][0][citizenship]=USA&merchant[members][0][title]=title&merchant[members][0][ownership]=50&merchant[members][0][significantResponsibility]=1&merchant[members][0][politicallyExposed]=1&merchant[members][0][address1]=6380west24ct&merchant[members][0][address2]=108&merchant[members][0][city]=miami&merchant[members][0][state]=FL&merchant[members][0][country]=USA&merchant[members][0][zip]=11111&merchant[members][0][email]=test@gmail.com&merchant[members][0][phone]=1111111111&merchant[members][1][first]=first&merchant[members][1][last]=last&merchant[members][1][middle]=middle&merchant[members][1][citizenship]=USA&merchant[members][1][title]=title&merchant[members][1][ownership]=50&merchant[members][1][significantResponsibility]=1&merchant[members][1][politicallyExposed]=1&merchant[members][1][address1]=6380west24ct&merchant[members][1][address2]=108&merchant[members][1][city]=miami&merchant[members][1][state]=FL&merchant[members][1][country]=USA&merchant[members][1][zip]=11111&merchant[members][1][email]=test@gmail.com&merchant[members][1][phone]=1111111111
CODE

Merchant Business Information Parameter Values

Value

Value Type

Notes

type

string

name

string

phone

string

customerPhone

string

email

string

haveEmployees

boolean

irsFilingName

string

industry

string

payoutSecondaryDescriptor

string

einType

SSN | TIN | Other

address1

string

address2

string

city

string

state

State | Province

country

Country

zip

string

merchant[annualCCSales]

string

(amount in cents)

merchant[avgTicket]

string

(amount in cents)

merchant[environment]

supermarket  | moto | cardPresent | fuel | serviceStation | restaurant | ecommerce

merchant[mcc]

string

(must be a valid mcc number)

merchant[established]

MM/DD/YYYY

merchant[dba]

string

merchant[advancedBilling]

boolean

merchant[new]

boolean

merchant[locationType]

77 | 78 | 79 | 80 | 81 

merchant[ndxDays]

string

merchant[percentBusiness]

string

merchant[percentEcomm]

string

merchant[percentKeyed]

string

merchant[seasonal]

boolean

merchant[saqType]

SAQ-A | SAQ-A-EP | SAQ-B | SAQ-B-IP | SAQ-C-VT | SAQ-C | SAQ-P2PE-HW | SAQ-D

merchant[saqDate]

MM/DD/YYYY

merchant[qsa]

string

merchant[pciCompliant]

boolean

merchant[custom]

string

Can be used to pass-in information from a Referrer’s CRM or other Merchant management system.

Merchant Member Information Parameter Values

Value

Value Type

Notes:

merchant[members][0][first]

string

merchant[members][0][last]

string

merchant[members][0][middle]

string

merchant[members][0][citizenship]

Country

merchant[members][0][title]

string

merchant[members][0][ownership]

string

(amount as 0 to 100 to indicate up to 100%)

Note: This differs from how the API handles this information pass-in.

merchant[members][0][significantResponsibility]

boolean

merchant[members][0][politicallyExposed]

boolean

merchant[members][0][address1]

string

merchant[members][0][address2]

string

merchant[members][0][city]

string

merchant[members][0][state]

State | Canada Province

merchant[members][0][country]

Country

merchant[members][0][zip]

string

merchant[members][0][email]

string

merchant[members][0][phone]

string

State possible values = 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 | AA | AE | AP | AS | FM | GU | MH | MP | PR | PW | UM | VI

Canada Provinces possible values = ON | QC | NS | NB | MB | BC | PE | SK | AB | NL

Country possible values =  CAN | USA

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.

  • By passing tcAttestation and visaDisclosure parameters with a value of 1, the Merchant does not need to click/open the actual Terms and Conditions Agreement and Visa Disclosure links. The checkboxes for acceptance and acknowledgment reflect as enabled and the Merchant signup form application can be submitted.