Skip to main content
Skip table of contents

Prepopulate Merchant Signup Forms

The Payrix Pro platform offers the ability to prepopulate Merchant Signup Forms using Merchant data stored in your platforms, software, and databases. A prepopulated form reduces manual data entry and potential errors, minimizing the time it takes your Merchants to board your payments platform. This capability not only streamlines the onboarding process for Merchants but also offers you the flexibility to customize the signup experience to meet the unique needs of your Merchants.

Set Up a Form with HTTP Query Parameters

You can pass existing Merchant data into a signup form by using HTTP query parameters to dynamically prepopulate fields in the form. By appending specific query parameters to the URL of the form, you can automatically fill in nonsensitive information such as Merchant entity details, bank account information, business specifics, and managing member data.

To set up your Merchant Signup Form for prepopulation:

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

  2. Copy the link to the form from the Signup Forms page.
    The link should look like this: https://test-portal.{yourBrand}.com/signup/12345678

  3. Append the link with HTTP query parameters to prepopulate specific information on the Merchant Signup Form.
    The following example includes all available query parameters (with sample values) that you can add to the URL:

    NONE
    ?public=0&website=example-site.com&globalBusinessId=123456789&globalBusinessType=tin&customerPhone=5555555555&irsFilingName=Bob's Bicycles LLC&type=2&haveEmployees=0&address1=123 Main St.&address2=Suite 123&city=New York&state=NY&zip=10001&country=USA&custom=New York-based online custom bike store.&termsAgree=true&tcAttestation=true&industry=Custom Bicycle Sales&payoutSecondaryDescriptor=Example Bikes&name=Bob’s Bikes&email=ex1@examplemail.com&phone=5555555555&displayName=Example Bikes&tcVersion=PAYRIXPROSUBMERCHANT123&tcDate=202401201200&tcIp=0.0.0.0&tcAcceptDate=202401201200&tcAcceptIp=0.0.0.0&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.&merchant[dba]=Bob’s Bike Store&merchant[new]=0&merchant[established]=01-20-2016&merchant[annualCCSales]=22000000&merchant[avgTicket]=150000&merchant[amex]=123456789012345&merchant[discover]=123456789012345&merchant[mcc]=5940&merchant[environment]=e-commerce&merchant[visaMvv]=123456&merchant[chargebackNotificationEmail]=excb@examplemail.com&merchant[totalApprovedSales]=25000030&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[applePayStatus]=&merchant[googlePayActive]=1&merchant[passTokenEnabled]=1&merchant[naics]=44&merchant[naicsDescription]=Retail Trade&merchant[expressBatchCloseMethod]=TimeInitiated&merchant[expressBatchCloseTime]=1830&merchant[members][0][first]=Robert&merchant[members][0][middle]=Karl&merchant[members][0][last]=Wheelwright&merchant[members][0][email]=ex2@examplemail.com&merchant[members][0][phone]=5555555555&merchant[members][0][ssn]=123456789&merchant[members][0][dob]=01-01-1985&merchant[members][0][title]=CEO&merchant[members][0][address1]=123 Main St.&merchant[members][0][address2]=Suite 456&merchant[members][0][city]=New York&merchant[members][0][state]=NY&merchant[members][0][zip]=10001&merchant[members][0][primary]=1&merchant[members][0][country]=USA&merchant[members][0][significantResponsibility]=1&merchant[members][0][ownership]=100

    Refer to the next section for descriptions and examples of each possible query parameter.

Merchant Signup Form Query Parameters

The following sections describe how to effectively use specific query parameters. These parameters cover everything from Merchant entity information to member details, helping you maximize the utility of the Payrix Pro platform for you and your Merchants.

Important!

While technically possible, we strongly advise against prepopulating the following information in a Merchant Signup Form:

  • Any sensitive Merchant information, such as a global business ID, member social number, or manual bank account information

  • Specific third-party IDs from ThreatMetrix and Plaid integrations

  • Merchant attestations and agreements to terms and conditions

You should treat these types of parameters in the following tables as high-risk or sensitive data. We provide this information for reference purposes only.

Merchant Entity Information

This section describes the parameters for Merchant entity information that can be prepopulated in a form.

Merchant Entity Overview

The following table lists the parameters for prepopulating general information about a Merchant entity and its business:

Parameter

Description

Type

Format and Valid Values

type

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

The name of the entity.

string

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

haveEmployees

Whether the Merchant entity has employees.

boolean

  • 0: Has no employees

  • 1: Has employees

irsFilingName

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

Indicates whether this is a publicly held and traded entity.

boolean

  • 0: Private Entity

  • 1: Public Entity

industry

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

string

This field is a text string and must be between 0 and 1,000 characters long.

displayName

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 1,000 characters long.

payoutSecondaryDescriptor

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

The business registration type for the entity.

Indicates the Tax Identification Number type.

string

Must be a valid US EIN/TIN or SSN, or a Canadian BRN or SIN. Otherwise, indicate an other/unknown number.

  • ssn: US Social Security Number

  • tin: US Tax or Employer Identification Number

  • other: Canada BRN or SIN

globalBusinessId

The business registration number for the entity.

Important: This field should be handled as high-risk, sensitive data.

number

This field is an alphanumeric and must be between 9 to 10 characters long. Do not use dashes.

custom

Custom, free-form field for your custom identifiers.

string

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

Merchant Contact

The following table lists the parameters for prepopulating the Merchant’s address and contact details in a form:

Parameter

Description

Type

Format and Valid Values

phone

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

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

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.

Note: You must provide a valid URL.

email

The email address associated with this Entity.

string

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

address1

The street address for the Entity.

string

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

address2

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

The Entity’s street address city.

string

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

state

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

string

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

US 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

US 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

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

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

Important: The signup form will automatically select the country based on where the Referrer entity is located. There is currently no support for cross-border boarding at this time.

Terms and Conditions

The following table lists the parameters for prepopulating information related to the terms and conditions provided to the Merchant in a form:

Parameter

Description

Type

Format and Valid Values

termsAgree

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

Important: You should not accept terms on behalf of the Merchant.

boolean

  • 0: Merchant did not agree.

  • 1: Merchant agrees.

tcAttestation

Whether the Merchant can attest to viewing the Payrix Pro platform terms and conditions.

Important: You should not accept terms on behalf of the Merchant.

boolean

  • 0: Merchant did not attest.

  • 1: Merchant attests.

tcVersion

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 and Conditions Version 3.2

  • WellsFargo1.13: Wells Fargo Bank Terms and Conditions Version 1.13

tcDate

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

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.

Examples

  • 0.0.0.0 for IPv4

  • 2001:db8:3333:4444:5555:6666:7777:8888 for IPv6

tcAcceptDate

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

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.

Examples

  • 0.0.0.0 for IPv4

  • 2001:db8:3333:4444:5555:6666:7777:8888 for IPv6

Example Query

The following query example prepopulates Merchant entity information in a form:

CODE
?type=2&name=Bob’s Bikes&phone=5555555555&customerPhone=5555555555&website=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&tcAttestation=true&tcVersion=PAYRIXPROSUBMERCHANT123&tcDate=202401201200&tcIp=0.0.0.0&tcAcceptDate=202401201200&tcAcceptIp=0.0.0.0&custom=New York-based online custom bike store.

The table describes the prepopulated Merchant entity information in the query example:

Entity Info

Example Info

Query Parameter Input Format

Merchant Business Formation Type

Limited Liability Corporation

?type=2

What is the name for this new Merchant Entity?

Bob’s Bikes

?name=Bob%27s+Bikes

Merchant Business Primary Phone Number

555-555-5555

?phone=5555555555

Merchant Business Customer Service Phone Number

555-555-5555

?customerPhone=5555555555

Merchant Business Customer Website

www.examplebikes.com

?website=example-site.com

Merchant Business Primary Email Address

example@examplebikes.com

?email=example@examplebikes.com

Does the Merchant have employees?

Yes

?haveEmployees=1

Merchant Legal Name filed with the IRS or CRA.

Bob's Bicycles LLC

?irsFilingName=Bob's Bicycles LLC

Is the Merchant a Public or Private Company?

Private Company

?public=0

Merchant Business Industry

Custom Bicycle Sales

?industry=Custom+Bicycle+Sales

What is the platform account display name for the Merchant Entity?

Bob’s Bikes

?displayName=Example Bikes

What descriptor do we want to appear next to deposits into the Merchant Account

Example Bikes

?payoutSecondaryDescriptor=Example Bikes

Merchant Tax ID number issued from CRA or IRS

12-3456789

?globalBusinessId=123456789

Merchant Tax ID Type

Tax ID Number

?globalBusinessType=tin

Merchant Business Street Address

123 Main St.

?address1=123 Main St.

Merchant Business Unit or Suite

Suite 456

?address2=Suite 456

Merchant Business Street Address City

New York

?city=New York

Merchant Business Street Address State

New York

?state=NY

Merchant Business Street Address Postal Code

10001

?zip=10001

Merchant Business Street Address Country

United States

?country=USA

Did the Merchant attest to viewing the Payrix Pro platform Terms and Conditions?

Yes

?tcAttestation=true

What Terms and Conditions version did the Merchant agree to?

Payrix Pro Sub-Merchant T&C Version 1.2.3

?tcVersion=PAYRIXPROSUBMERCHANT1.2.3

What date were the Terms and Conditions last uploaded?

January 20, 2024 12:00pm EST

?tcDate=202401201200

What IP address were the Merchant Terms and Conditions uploaded to.

0.0.0.0

?tcIp=0.0.0.0

When did the Merchant agree to the Terms and Conditions?

January 20, 2024, 12:00 PM Eastern Time

?tcAcceptDate=202401201200

What IP address did the Merchant agree to the Terms and Conditions from?

0.0.0.0

?tcAcceptIp=0.0.0.0

Is there any custom description this Merchant should have?

New York based online custom bike store.

?custom=New+York+based+online+custom+bike+store.


Merchant Bank Account Information

You can prepopulate information about the bank account that a Merchant will use to pay debits for platform costs or the destination account for their deposits from their settled transaction amount payouts.

Note

For Plaid integrations, you can use the publicToken and mask parameters instead of the number, routing, and method parameters, which are for manually entering bank account information.

See the Plaid Integration setup steps if you haven’t already enabled and configured your Plaid account linking integration for your Merchant portfolio.

The following table describes the parameters for prepopulating Merchant bank account information in a form:

Parameter

Description

Type

Format and Valid Values

merchant[accounts][0][method]

The type of bank account.

integer

  • 8: Personal checking account

  • 9: Personal savings account

  • 10: Business checking account

  • 11: Business savings account

merchant[accounts][0][number]

The Merchant’s bank account number.

Important: This field should be handled as high-risk, sensitive data.

number

This field is a numeric string and must be between 8 and 17 digits.

Example: 0123456789012345

merchant[accounts][0][routing]

The Merchant’s bank routing number.

Important: This field should be handled as high-risk, sensitive data.

number

This field is a numeric string and must be exactly 9 digits.

Example: 012345678

merchant[accounts][0][name]

A custom name that can be given to the Merchant bank account.

string

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

merchant[accounts][0][description]

A custom description that can be given to the Merchant bank account.

string

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

merchant[accounts][0][primary]

Whether this will be the primary bank account for the Merchant.

boolean

  • 0: Not primary

  • 1: Primary

merchant[accounts][0][type]

Whether the Merchant’s bank account will be used for receiving deposits (credits), withdrawing for costs (debits), or both on the platform.

string

  • all: Both Credit and Debit Account

  • credit: Credit-only account.

  • debit: Debit-only account.

Example Query

The following query example prepopulates Merchant bank account information in a form:

CODE
?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.

The table describes the prepopulated Merchant bank account information in the query example:

Merchant Bank Account Info

Example Info

Query Parameter Input Format

What type of bank account will the Merchant link?

Business Checking

?merchant[accounts][0][account][method]=10

What is the bank routing number the Merchant is linking?

012345678

?merchant[accounts][0][account][routing]=012345678

What is the bank account number the Merchant is linking?

0123456789012345

?merchant[accounts][0][account][number]=0123456789012345

Confirm the Merchant Bank account.

0123456789012345

?merchant[accounts][0][account][confirmNumber]=0123456789012345

Is this the Merchant’s primary bank account for platform usage and deposits?

Yes

?merchant[accounts][0][primary]=1

Will this bank account be used for receiving deposit credits, withdrawing cost debits or both for the Merchant?

Debit

?merchant[accounts][0][type]=debit

What is the customized name for the Merchant’s bank account on the platform?

Example Checking

?merchant[accounts][0][name]=Example+Checking

What is the customized description for the Merchant’s bank account on the platform?

Business Account for Example Bike Merchant.

?merchant[accounts][0][description]=Business+Account+for+Example+Bike+Merchant.


Merchant Business Information

You can prepopulate information about the Merchant’s business entity and transaction processing information.

Merchant Business Overview

The following table lists the parameters for prepopulating the Merchant’s business details in a form:

Parameter

Description

Type

Format and Valid Values

merchant[new]

An indicator that specifies whether the Merchant is new to credit card processing. By default, merchants are considered to be new.

boolean

  • 0: Not new

  • 1: New

merchant[established]

The date on which the Merchant was established.

date

The date must be in the format MM-DD-YYYY with dashes.

Example: 01-20-2016 is January 20, 2016.

merchant[mcc]

The Merchant Category Code (MCC) for this Merchant.

string

Must be a valid MCC with 4 numeric digits.

merchant[dba]

The name under which the Merchant is doing business, if applicable.

string

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

merchant[environment]

The environment which the Merchant is in, if applicable.

string

  • supermarket: Supermarket

  • moto: Mail Order / Telephone Order

  • cardPresent: Card Present

  • fuel: Fuel

  • serviceStation: Service Station

  • restaurant: Restaurant

  • e-commerce: eCommerce

merchant[locationType]

Description of the type of address that the business operates at.

string

  • 77: Retail Storefront

  • 78: Warehouse

  • 79: Private Residence

  • 80: Others

  • 81: P. Res-Prof / Construction

merchant[seasonal]

Indicates if the merchant is a seasonal merchant or operates year-round.

boolean

  • 0: Year-Round

  • 1: Seasonal

merchant[naics]

The NAICS sector code that accurately describes the industry the business operates in.

integer

  • 11: Agriculture, Forestry, Fishing and Hunting

  • 21: Mining, Quarrying, and Oil and Gas Extraction

  • 22: Utilities

  • 23: Construction

  • 31-33: Manufacturing

  • 41: Wholesale Trade

  • 44-45: Retail Trade

  • 48-49: Transportation and Warehousing

  • 51: Information

  • 52: Finance and Insurance

  • 53: Real Estate and Rental and Leasing

  • 54: Professional, Scientific, and Technical Services

  • 55: Management of Companies and Enterprises

  • 56: Administrative and Support and Waste Management and Remediation Services

  • 61: Educational Services

  • 62: Health Care and Social Assistance

  • 71: Arts, Entertainment, and Recreation

  • 72: Accommodation and Food Services

  • 81: Other Services (except Public Administration)

  • 91/92: Public Administration

merchant[naicsDescription]

The NAICS sector description matching the NAICS sector code. If Other, the industry description is prefixed with Other:.

string

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

Agreements and Disclosures

The following table lists the parameters for prepopulating information related to Merchant agreements and disclosures in a form:

Parameter

Description

Type

Format and Valid Values

merchant[tcAttestation]

Whether the Merchant agrees to the platform Terms and Conditions.

Important: You should not accept terms on behalf of the Merchant.

boolean

  • 0: Agree

  • 1: Do Not Agree

merchant[visaDisclosure]

Whether the Merchant has reviewed the Visa card brand disclosure.

boolean

  • 0: Reviewed

  • 1: Not Reviewed

merchant[disclosureIP]

The IP address where the Merchant platform disclosure is hosted.

string

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

Accepts IPv4 or IPv6.

Examples

  • 0.0.0.0 for IPv4

  • 2001:db8:3333:4444:5555:6666:7777:8888 for IPv6

merchant[disclosureDate]

The date the Merchant platform disclosure is reviewed by the Merchant.

date

The date is specified as an 8-digit numeric string: YYYYMMDD

Example: 20160120 is January 20, 2016.

Financials and Payment Processing

The following table lists the parameters for prepopulating the Merchant’s financial and payment processing information in a form:

Parameter

Description

Type

Format and Valid Values

merchant[annualCCSales]

The value of the annual credit card sales of this Merchant.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 is $250,000.30.

merchant[avgTicket]

The value of the average credit card sales of this Merchant.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 is $250,000.30.

merchant[amex]

The American Express merchant identifier for this Merchant, if applicable.

Important: This field should be handled as high-risk, sensitive data.

string

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

merchant[discover]

The Discover merchant identifier for this Merchant, if applicable.

Important: This field should be handled as high-risk, sensitive data.

string

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

merchant[visaMvv]

The Merchant Verification Value (MVV), a value assigned by Visa to identify participation in select merchant programs.

Important: This field should be handled as high-risk, sensitive data.

string

Must be a valid MVV with 6 numeric digits.

merchant[chargebackNotificationEmail]

The email address where the Merchant’s chargeback notification emails will be sent.

Email

Must be a valid email address.

merchant[totalApprovedSales]

Show the total approved amount to this merchant.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 is $250,000.30.

merchant[annualCCSaleVolume]

The expected total number of credit card transactions the Merchant receives annually.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 is $250,000.30.

merchant[annualACHSaleVolume]

The expected total number of all eCheck/ACH/EFT transactions the Merchant receives annually.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 is $250,000.30.

merchant[ndxDays]

The Non-Delivery Exposure (NDX) days the Merchant will experience when fulfilling a product or service transaction sale.

number

This field is a numeric string and must be a whole number between 0 and 32,767.

Example: 3 for three NDX days

merchant[ndxPercentage]

The percentage of The Non-Delivery Exposure (NDX) transactions to be used by the merchant, if applicable.

number

This field is a 1 to 3-digit integer between 1 and 100.

Example: 75 = 75%

merchant[advancedBilling]

Indicates whether the merchant accepts pre-purchase for products that are shipped at a later date or not currently available.

boolean

  • 0: Disabled

  • 1: Enabled

merchant[percentKeyed]

The merchant percentage of transactions that are Card Not Present (including MOTO and eCommerce).

integer

This field is a 1 to 3-digit integer between 1 and 100.

Example: 75 for 75%

merchant[totalVolume]

The expected total number of all transaction types that the merchant will process for the current year.

number

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 for $250,000.30

merchant[percentEcomm]

This field indicates what percentage are internet originated transactions.

integer

This field is a 1 to 3-digit integer between 1 and 100.

Example: 75 for 75%

merchant[amexVolume]

The expected total number of American Express brand credit card transactions the Merchant receives annually.

integer

This field is an integer in cents with a minimum of 4 digits: 0000

Example: 25000030 for $250,000.30

merchant[percentBusiness]

This field indicates what percentage of the transactions are Business to Business

integer

This field is a 1 to 3-digit integer between 1 and 100.

Example: 75 for 75%

merchant[applePayActive]

This field indicates if Apple Pay is active for this merchant.

boolean

  • 0: Active

  • 1: Inactive

merchant[applePayStatus]

This field identifies the Merchant’s Domain Registration status for Apple Pay.

string

  • null: can be registered later.

merchant[googlePayActive]

This field indicates if Google Pay is active for this merchant.

boolean

  • 0: Active

  • 1: Inactive

merchant[passTokenEnabled]

This field indicates if Pass Token is enabled for this merchant.

boolean

  • 0: Disabled

  • 1: Enabled

merchant[expressBatchCloseMethod]

This field indicates the batch close method for this merchant applicable to Express platform.

string

  • TimeInitiated: Time-triggered Express batch close.

  • MerchantInitiated: manual Merchant-triggered Express batch close.

merchant[expressBatchCloseTime]

Indicates the daily batch close time for the Merchant applicable to Express platform.

time

This field is 4-digit integer using a 24-hour clock, based in the US Eastern Time zone: HH:II:SS

Example: 15:28:00 for 3:28 PM Eastern Time

Risk and Compliance

The following table lists the parameters for prepopulating information related to the Merchant’s risk and compliance in transaction processing:

Parameter

Description

Type

Format and Valid Values

merchant[saqType]

Payment Card Industry (PCI) Data Security Standard Self-Assessment Questionnaire & Rating for Self-Attestation of Compliance.

string

The SAQ rating for the Merchant business.

  • SAQ-A

  • SAQ-A-EP

  • SAQ-B

  • SAQ-B-IP

  • SAQ-C-VT

  • SAQ-C

  • SAQ-P2PE-HW

  • SAQ-D

merchant[saqDate]

The date of certification from PCI-DSS Self-Assessment Questionnaire.

date

The date is specified as an 8-digit numeric string: YYYMMDD

Example: 20160120 for January 20, 2016

merchant[qsa]

The name of the Qualified Security Assessor (QSA) used by the Merchant to assess, verify and prove their PCI DSS compliance.

string

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

merchant[letterStatus]

The status of the Merchant’s PCI SAQ-QSA letter status approving or denying the Merchant based on its assessment.

boolean

  • 0: Denied

  • 1: Approved

merchant[letterDate]

The date the PCI SAQ-QSA letter was provided.

date

The date is specified as an 8-digit numeric string: YYYYMMDD

Example: 20160120 for January 20, 2016

merchant[riskLevel]

The Merchant risk score categorized by level, where applicable.

string

  • low: 67-100

  • medium: 34 to 66

  • high: 0 to 33

  • restricted: Manual review required, very high-risk Merchant.

  • prohibited: Prohibited from boarding.

merchant[creditRatio]

The ratio of credit card transactions that use credit card processing credit ratio to use while calculating risk factors for credit, if applicable.

Defines the number of transactions out of the total transactions that are credit.

number

This field is a numeric string and must be a whole number between 0 and 32,767.

Example: 2 for a 2:1 credit ratio

merchant[creditTimeliness]

The credit timeliness for the Merchant, if applicable.

number

This field is a numeric string and must be a whole number between 0 and 32,767.

Example: 1 for a 1:1 credit timeliness ratio

merchant[chargebackRatio]

The ratio of transactions that the Merchant processes resulting in a chargeback dispute from the cardholder.

number

This field is a numeric string and must be a whole number between 0 and 32,767.

Example: 0 for a 0:1 credit timeliness ratio

merchant[incrementalAuthSupported]

This field allows the ability to submit merchant registration files with a MasterCard (MC) Auth Integrity value.

boolean

  • 0: Not supported

  • 1: Supported

merchant[tmxSessionId]

The ThreatMetrix Session ID for the Merchant.

Important: This field should be handled as high-risk, sensitive data.

string

This field is an alphanumeric string that is exactly 36 digits and includes dashes.

Example: 12a345bc-67d8-9012-3e45-6f7g8901a234

Example Query

The following query example prepopulates Merchant business information in a form:

CODE
?merchant[new]=0&merchant[established]=01-20-2016&merchant[dba]=Bob’s Bike Store&merchant[annualCCSales]=22000000&merchant[avgTicket]=150000&merchant[amex]=123456789012345&merchant[discover]=123456789012345&merchant[mcc]=5940&merchant[environment]=e-commerce&merchant[visaMvv]=123456&merchant[chargebackNotificationEmail]=excb@examplemail.com&merchant[totalApprovedSales]=25000030&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

The table describes the prepopulated Merchant business information in the query example:

Merchant Business Info

Example Info

Query Parameter Input Format

Is this a new Merchant?

Yes

?merchant[new]=1

When was the Merchant legally formed/established?

January 20, 2016

?merchant[established]=01-20-2016

Merchant DBA

Bob’s Bike Store

?merchant[dba]=Bob%27s+Bike+Store

What is the Merchant’s expected amount of annual credit card sales?

$220,000.00/year

?merchant[annualCCSales]=220000.00

What is the average amount of each customer transaction/ticket?

$1,500.00/ticket

?merchant[avgTicket]=150000

What is the Merchant’s registration code provided by American Express?

123456789012345

?merchant[amex]=123456789012345

What is the Merchant’s registration code provided by Discover?

123456789012345

?merchant[discover]=123456789012345

What is the Merchant’s Merchant Category Code (MCC)?

5499

?merchant[mcc]=5499

What environment does the Merchant accept payments?

e-Commerce

?merchant[environment]=e-commerce

What is the Merchant’s Merchant Visa Verification (MVV) code?

123456

?merchant[visaMvv]=123456

What email address does the Merchant want to use for their emailed chargeback notifications/alerts?

merchant@example.com

?merchant[chargebackNotificationEmail]=merchant%40example.com

Total Approved Amount for this Merchant to Process in Credit Card Sale

$250,000.30

?merchant[totalApprovedSales]=25000030

What is the Merchant’s PCI DSS self-assessment rating?

SAQ-B

?merchant[saqType]=SAQ-B

When was the Merchant rated for PCI-DSS self-assessment?

Jan 20, 2016

?merchant[saqDate]=20160120

The name of the individual assessor or organization that provided the QSA assessment and certification.

Example QSA Merchant

?merchant[qsa]=Example+QSA

Did the Merchant receive the PCI QSA certification letter?

Yes

?merchant[letterStatus]=1

What date was the Merchant PCI QSA certification letter issued?

Jan 20, 2016

?merchant[letterDate]=20160120

Did the Merchant agree to the terms and conditions for platform usage?

Yes

?merchant[tcAttestation]=1

Has the Merchant reviewed the Visa disclosure?

Yes

?merchant[visaDisclosure]=1

What is the IP address where the Merchant reviewed the Visa disclosure (Merchant’s primary IP address)?

192.168.0.1

?merchant[disclosureIP]=192.168.0.1

Date the Merchant reviewed the Visa disclosure.

Jan 20, 2016

?merchant[disclosureDate]=20160120

How many credit card transactions does the Merchant process per year?

50,000/year

?merchant[annualCCSaleVolume]=50000

How many eCheck transactions does the Merchant process per year?

2,000/year

?merchant[annualACHSaleVolume]=2000

What is the Merchant’s risk level?

Low

?merchant[riskLevel]=low

What is the Merchant’s ratio of credit utilization?

2:1

?merchant[creditRatio]=2

What is the Merchant’s ratio of on-time repayment?

1:1

?merchant[creditTimeliness]=1

What ratio of the Merchant’s sale transactions result in chargebacks?

0:1

?merchant[chargebackRatio]=0

How many days occur between a customer payment and shipment/fulfillment of the Merchant’s products/services?

3 days

?merchant[ndxDays]=3

What percentage of transactions of the Merchant’s will utilize the Non-Delivery Exposure fulfillment process?

75%

?merchant[ndxPercentage]=75

Does this Merchant accept pre-payment for later-fulfilled products or services?

Yes

?merchant[advancedBilling]=1

What type of building or location does the Merchant do business from?

Warehouse

?merchant[locationType]=78

What percentage of the Merchant’s business is manually keyed into a terminal or payment form?

75%

?merchant[percentKeyed]=75

What is the Merchant’s total number of all transaction types annually?

50,000 / year

?merchant[totalVolume]=5000000

What percentage of the Merchant’s business is online e-commerce transactions?

100%

?merchant[percentEcomm]=100

Is the Merchant seasonal?

No

?merchant[seasonal]=0

How many American Express card brand-based transactions does the Merchant process per year?

15,000/year

?merchant[amexVolume]=15000

Will the Merchant be able to support partial credit card authorizations?

Yes

?merchant[incrementalAuthSupported]=1

What is the ThreatMetrix Session ID for the Merchant?

12a345bc-67d8-9012-3e45-6f7g8901a234

?merchant[tmxSessionId]=12a345bc-67d8-9012-3e45-6f7g8901a234

What percentage of this Merchant’s transactions are business-to-business?

75%

?merchant[percentBusiness]=75

Will Apple Pay be active for this Merchant?

Active

?merchant[applePayActive]=1

What is the Apple Pay registration status of the Merchant?

Registered

?merchant[applePayStatus]=1

Will Google Pay be active for this Merchant?

Active

?merchant[googlePayActive]=1

Will Pass Token be enabled for this Merchant?

Yes

?merchant[passTokenEnabled]=1

What is the Merchant’s NAICS code number?

44

?merchant[naics]=44

What is the description of the NAICS code for the Merchant?

Retail Trade

?merchant[naicsDescription]=Retail+Trade

For Express, will the Merchant’s transaction settlement batch be closed to begin settlement through a daily set time or manually each time?

Time Initiated

?merchant[expressBatchCloseMethod]=TimeInitiated

If the Merchant’s Express Batch Close is time-initiated, what time will the batch be set to close each day? (Based on Eastern Time)

6:30 PM Eastern Time

?merchant[expressBatchCloseTime]=1830


Merchant Member Information

You can prepopulate information about the Merchant’s managing member assigned to their account on the platform.

Member Identification

The following table describes the parameters for prepopulating the managing member’s identity and personal information in a form:

Parameter

Description

Type

Format and Valid Values

merchant[members][0][first]

The first name of the Merchant’s managing member.

string

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

merchant[members][0][middle]

The middle name of the Merchant’s managing member.

string

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

merchant[members][0][last]

The last name of the Merchant’s managing member.

string

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

merchant[members][0][ssn]

The Social Security (US) or social insurance number (Canada) of the Merchant’s managing member.

Important: This field should be handled as high-risk, sensitive data.

number

This field is a numeric string and must be exactly 9 digits. Do not use dashes.

merchant[members][0][dob]

The date of birth of this Member.

date

The date must be in the format MM-DD-YYYY with dashes.

Example: 01-20-2006 is January 20, 2006.

merchant[members][0][title]

The Merchant’s managing member’s title at the business.

string

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

merchant[members][0][dl]

The Member’s driver’s license ID number.

string

This field is alphanumeric string and is 1 to 15 characters long.

Example: 123456789

merchant[members][0][dlstate]

The Member’s driver’s license issuing state or province.

string

The 2-character postal abbreviation for any US state, territory or Canadian province. See the Entity state parameter for a list of valid values.

Member Contact

The following table describes the parameters for prepopulating the managing member’s address and contact details in a form:

Parameter

Description

Type

Format and Valid Values

merchant[members][0][email]

Email address for the Merchant’s managing member.

string

This field is a text string and must be a valid email address between 1 and 100 characters long

merchant[members][0][phone]

Phone number for the Merchant’s managing member.

number

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

merchant[members][0][address1]

Personal address for the Merchant’s managing member.

string

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

merchant[members][0][address2]

Suite, unit, or apartment number for the Merchant’s managing member.

string

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

merchant[members][0][city]

City of the personal address for the Merchant’s managing member.

string

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

merchant[members][0][state]

State or Province of the personal address for the Merchant’s managing member.

string

The 2-digit postal abbreviation for any US state, territory, or Canadian province. See the Entity state parameter for a list of valid values.

merchant[members][0][zip]

Postal code of the personal address for the Merchant’s managing member.

string

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

merchant[members][0][country]

Country of the personal address for the Merchant’s managing member.

string

This field is a text string that requires a valid three-letter ISO 3166-1 country code.

Ownership and Responsibility

The following table describes the parameters for prepopulating the ownership stake and responsibilities of the managing member in a form:

Parameter

Description

Type

Format and Valid Values

merchant[members][0][primary]

Whether the Merchant’s managing member is the primary point of contact for the Merchant.

boolean

  • 0: Not primary

  • 1: Primary

merchant[members][0][significantResponsibility]

A controlling authority, or Control Prong, including but not limited to: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice Presidents, or an individual with significant legal authority to enter the Legal Entity into a commercial relationship.

boolean

  • 0: Does not hold significant responsibility

  • 1: Holds significant responsibility

merchant[members][0][ownership]

The share of the Member's ownership of the associated Merchant

integer

This field is a three-digit integer between 0 and 100.

Example: 75 for 75%

merchant[members][0][politicallyExposed]

Whether the Member is politically exposed. A Member is considered politically exposed if they hold a prominent position or possess significant influence, making them more vulnerable to involvement in bribery or corruption.

boolean

  • 0: Is not politically exposed

  • 1: Is politically exposed

Example Query

The following query example prepopulates Merchant member information in a form:

CODE
?merchant[members][0][title]=CEO&merchant[members][0][first]=Robert&merchant[members][0][middle]=Karl&merchant[members][0][last]=Wheelwright&merchant[members][0][email]=ex2@examplemail.com&merchant[members][0][phone]=5555555555&merchant[members][0][ssn]=123456789&merchant[members][0][dob]=01-01-1985&merchant[members][0][address1]=123 Main St.&merchant[members][0][address2]=Suite 456&merchant[members][0][city]=New York&merchant[members][0][state]=NY&merchant[members][0][zip]=10001&merchant[members][0][country]=USA&merchant[members][0][significantResponsibility]=1&merchant[members][0][ownership]=100&merchant[members][0][primary]=1&merchant[members][0][dl]=123456789&merchant[members][0][dlstate]=NY

The table describes the prepopulated Merchant member information in the query example:

Merchant Member Info

Example Info

Query Parameter Input Format

What is the title of the Merchant managing member?

CEO

?merchant[members][0][title]=CEO

What is the first name of the Merchant’s managing member?

Robert

?merchant[members][0][first]=Robert

What is the middle name of the Merchant’s managing member?

Karl

?merchant[members][0][middle]=Karl

What is the last name of the Merchant’s managing member?

Wheelwright

?merchant[members][0][last]=Wheelwright

What is the Merchant’s managing member’s personal email address?

john@example.com

?merchant[members][0][email]=john%40example.com

What is the Merchant’s managing member’s personal phone number?

555-555-5555

?merchant[members][0][phone]=5555555555

What is the Merchant’s managing member’s personal tax ID number (SSN or SIN)?

123456789

?merchant[members][0][ssn]=123456789

What is the date of birth of the Merchant’s managing member?

October 25, 1985

?merchant[members][0][dob]=10-25-1985

What is the personal mailing address for the Merchant’s managing member?

123 Main St.

?merchant[members][0][address1]=123+Main+St.

What is the apartment, unit, or suite for the Merchant’s managing member?

Apt 101

?merchant[members][0][address2]=Apt+101

What is the Merchant’s managing member’s personal mailing address city?

Los Angeles

?merchant[members][0][city]=Los+Angeles

What is the Merchant’s managing member’s personal mailing address state?

California

?merchant[members][0][state]=CA

What is the Merchant’s managing member’s personal mailing address postal code?

90001

?merchant[members][0][zip]=90001

What is the Merchant’s managing member’s personal mailing address country?

USA

?merchant[members][0][country]=USA

Does this Merchant’s managing member retain significant responsibility in and for the Merchant business?

Yes

?merchant[members][0][significantResponsibility]=1

What percentage of ownership in the Merchant business does the Merchant’s managing member retain?

50%

?merchant[members][0][ownership]=50

Is this Merchant’s managing member the primary point of contact for the Merchant’s business?

Yes

?merchant[members][0][primary]=1

Queries for Common Use Cases

The following table lists use cases that can be used to streamline some commonly encountered scenarios for prepopulating a Merchant Signup Form with queries.

Note

Be sure to use valid applicable data to replace all characters with {} brackets, and ensure you delete any {} brackets before testing.

Use Case

Description

Query Parameter

Prepopulate Entity website

Adds the Merchant Entity’s website.

?website={www.example-Merchant.com}

Prepopulate the Entity’s country

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

?country={USA}

Prepopulate a custom value for the Entity

Sets your preferred custom value to the Merchant Entity account.

?custom={your_CRM_Sales_or_Marketing_Identifier}

Prepopulate the Merchant's Entity name

Adds the Merchant’s entity name.

?name={Merchant+Name}

Prepopulate the Merchant’s associated entity ID

Adds your Merchant’s entity ID.

?merchant[entity]={t1_ent_123abc4d567890efg1h2i34}

Prepopulate your Merchant’s sales environment

Sets the Merchant’s transaction processing environment.

?merchant[environment]={MerchantEnvironment}

Prepopulate 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}

Prepopulate Merchant Member ownership and responsibility

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

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.