Skip to main content
Skip table of contents

Pre-Populate Merchant Sign Up Forms

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

Merchant Entity Information Parameter Values

Pre-Populated Information:

Value

Required

Description

Type

Format & Valid Values

type

Required

The legal formation structure filed by the Entity.

integer

Valid Values

  • 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

Do not use dashes.

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.

Valid Values

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

Warning: 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.

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.

Examples

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.

Examples

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

CODE 
?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.
Pre-Populate Query Example - Merchant Entity Information

Pre-Populated Information:

Entity Info

Example Info

Query Parameter Input Format

Is the Merchant a Public or Private Company?

Private Company

?public=0

Merchant Business Customer Website

https://www.examplebikes.com

?website=https://example-site.com

Merchant Tax ID number issued from CRA or IRS

12-3456789

?globalBusinessId=123456789

Merchant Tax ID Type

Tax ID Number

?globalBusinessType=tin

Merchant Business Customer Service Phone Number

555-555-5555

?customerPhone=5555555555

Merchant Legal Name filed with the IRS or CRA.

Bob's Bicycles LLC

?irsFilingName=Bob's Bicycles LLC

Merchant Business Formation Type

Limited Liability Corporation

?type=2

Does the Merchant have employees?

Yes

?haveEmployees=1

Merchant Business Street Address

123 Main St.

?address1=123 Main St.

Merchant Business Unit or Suite

Suite 456

?address2=Suite 123

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

Is there any custom description this Merchant should have?

New York based online custom bike store.

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

Did the Merchant Agree to the Terms and Conditions?

Yes

?tcAttestation=true

Merchant Business Industry

Custom Bicycle Sales

?industry=Custom+Bicycle+Sales

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

Example Bikes

?payoutSecondaryDescriptor=Example Bikes

What is the name for this new Merchant Entity?

Bob’s Bikes

?name=Bob%27s+Bikes

Merchant Business Primary Email Address

example@examplebikes.com

?email=example@examplebikes.com

Merchant Business Primary Phone Number

555-555-5555

?phone=5555555555

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

Bob’s Bikes

?displayName=Example Bikes

What Terms & Conditions version did the Merchant agree to?

Payrix Sub-Merchant T&C Version 1.2.3.

?tcVersion=PAYRIXSUBMERCHANT1.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 & Conditions uploaded to.

0.0.0.0

?tcIp=0.0.0.0

When did the Merchant agree to the Terms & Conditions?

January 20, 2024 12:00pm EST

?tcAcceptDate=202401201200

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

0.0.0.0

?tcAcceptIp=0.0.0.0

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.

Note: The optional publicToken and mask parameters are dependent on using the Plaid integration and can be used instead of the required manual account information parameters (number, routing, & method) below.

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

Merchant Bank Account Information Parameter Values

Value

Required

Description

Type

Format & Valid Values

merchant[accounts][0][method]

Required

The

integer

Valid Values

  • 8 - Personal checking account

  • 9 - Personal savings account

  • 10 - Business checking account

  • 11 - Business savings account

merchant[accounts][0][number]

Required

The Merchant’s bank account number.

number

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

Example:

0123456789012345 = Bank Account number.

merchant[accounts][0][routing]

Required

The Merchant’s bank routing number.

number

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

Example:

012345678 = Bank Routing number.

merchant[accounts][0][name]

Optional

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]

Optional

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]

Required

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

boolean

  • 0 - Not primary

  • 1 - Primary

merchant[accounts][0][type]

Required

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.

Merchant Bank Account Information - Example Query

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.
Pre-Populated Query Example - Bank Account Information

Pre-Populated Merchant Bank Account Information:

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.

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 Parameter Values

Value

Required

Description

Type

Format & Valid Values

merchant[new]

Required

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]

Optional

The date on which the Merchant was established. in YYYYMMDD format, for example,

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[annualCCSales]

Required

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

integer

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

Example:

25000030 is $250000.30.

merchant[mcc]

Optional

The Merchant Category Code (MCC) for this Merchant.

string

Must be a valid MCC with 4 numeric digits.

merchant[status]

Required

The boarding status of the Merchant.

integer

Valid Values

  • 0 - Not ready

  • 1 - Ready

  • 2 - Boarded

  • 3 - Manual

  • 4 - Closed

  • 5 - Incomplete

  • 6 - Pending

merchant[statusReason]

Optional

The reason for manual or closed status.

string

Valid Values

  • rejected - Rejected by manual review or integration

  • fraud - Rejected by automated fraud-based risk decisions

  • noResponse - No response from Merchant during Manual Review or request for more information.

  • withdrawn - Merchant has withdrawn interest in completing platform boarding.

merchant[dba]

Optional

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[avgTicket]

Required

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

integer

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

Example:

25000030 is $250000.30.

merchant[amex]

Optional

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

string

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

merchant[discover]

Optional

The Discover merchant identifier for this Merchant, if applicable

string

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

merchant[boarded]

Optional

Whether the Merchant can be boarded after Tax ID number verification.

boolean

  • 0 - No

  • 1 - Yes

merchant[environment]

Required

The environment which the Merchant is in, if applicable.

string

Valid Values

  • supermarket Supermarket

  • motoMail Order / Telephone Order

  • cardPresentCard Present

  • fuel Fuel

  • serviceStation Service Station

  • restaurant Restaurant

  • e-commerce eCommerce

merchant[visaMvv]

Optional

Merchant Verification Value (MVV).

A value assigned by Visa to identify participation in select merchant programs.

string

Must be a valid MVV with 6 numeric digits.

merchant[chargebackNotificationEmail]

Optional

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

Email

Must be a valid email address.

merchant[totalApprovedSales]

Optional

Show the total approved amount to this merchant.

integer

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

Example:

25000030 is $250000.30.

merchant[autoBoarded]

Whether to auto-board the Merchant without manual review.

boolean

  • 0 - Disabled

  • 1 - Enabled

merchant[saqType]

Optional

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

string

The SAQ rating for the Merchant business.

Valid Values

  • SAQ-A

  • SAQ-A-EP

  • SAQ-B

  • SAQ-B-IP

  • SAQ-C-VT

  • SAQ-C

  • SAQ-P2PE-HW

  • SAQ-D

merchant[saqDate]

Required

The date of certification from PCI-DSS Self-Assessment Questionaire

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[qsa]

Optional

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]

Optional

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]

Optional

The date the PCI SAQ-QSA letter was provided.

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[tcAttestation]

Optional

Whether the Merchant agrees to the platform Terms and Conditions

boolean

  • 0 - Agree

  • 1 - Do Not Agree

merchant[visaDisclosure]

Optional

Whether or not the Merchant has reviewed the Visa card brand disclosure.

boolean

  • 0 - Reviewed

  • 1 - Not Reviewed

merchant[disclosureIP]

Optional

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

Example: IPv4

0.0.0.0 = 0.0.0.0

Example: IPv6

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

merchant[disclosureDate]

Optional

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

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[accountClosureReasonCode]

Optional

The denial or account closure reason code.

string

Valid Values

  • deniedMemberCreditScore - Denied for Merchant Member credit score.

  • deniedBusinessRiskScore - Denied for high Merchant Business risk score.

  • deniedMemberRiskScore - Denied for high Merchant Member risk score.

  • deniedOtherUnspecified - Denied for other or unspecified reason(s).

  • AccountDataCompromise - Merchant account was the point of a data compromise.

  • CommonPointOfPurchase - Merchant account was discovered as the source of one or more card breaches during a common point-of-purchase (CPP) analysis.

  • Laundering - Merchant account was identified as being involved in money laundering.

  • ExcessiveChargebacks - Merchant account was identified as having an excessive number of chargebacks and/or disputes.

  • ExcessiveFraud - Merchant account was identified as the source of excessive transaction or Merchant fraud.

  • FraudConviction - Merchant business was convicted of committing Fraud.

  • BankruptcyLiquidationInsolvency - Merchant business has filed for bankruptcy and is currently in the process of liquidation to attempt to cover their insolvency

  • ViolationOfMasterCardStandards - Merchant account was identified as having violated the Mastercard card brand regulations.

  • SubMerchantCollusion - Merchant account was identified as working with a sub-Merchant to commit a type of fraud or data breach.

  • PCIDataSecurityStandardNonCompliance - Merchant account was identified as no longer being PCI-DSS compliant.

  • IllegalTransactions - The Merchant account was identified as having performed transactions for illegal products, services, or to previously identified OFAC-prohibited persons or entities.

  • IdentityTheft - The Merchant account was identified as being involved in customer identity theft.

  • OutOfBusiness - The Merchant account was identified as no longer in business.

  • DissatisfiedWithService - The Merchant decided they were dissatisfied with the platform and wanted to close their account.

  • OtherUnspecified - The Merchant account was closed for an unspecified reason or reason not listed above.

merchant[accountClosureReasonDate]

Optional

The date the account closure reason code was provided.

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[annualCCSaleVolume]

Optional

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

integer

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

Example:

25000030 is $250000.30.

merchant[annualACHSaleVolume]

Optional

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

integer

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

Example:

25000030 is $250000.30.

merchant[riskLevel]

Optional

The Merchant risk score categorized by level, where applicable.

string

Merchant Platform Risk Score

Valid Values

  • 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]

Optional

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 = 2:1 credit ratio.

merchant[creditTimeliness]

Optional

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 = 1:1 credit timeliness ratio.

merchant[chargebackRatio]

Optional

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 = 0:1 credit timeliness ratio.

merchant[ndxDays]

Optional

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 = 3 Non-Delivery Exposure days.

merchant[ndxPercentage]

Optional

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

number

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

Example:

75 = 75%

merchant[advancedBilling]

Optional

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[locationType]

Optional

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

string

Valid Values

  • 77 - Retail Storefront

  • 78 - Warehouse

  • 79 - Private Residence

  • 80 - Others

  • 81 - P. RES-PROF/Construction

merchant[percentKeyed]

Optional

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

integer

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

Example:

75 = 75%

merchant[totalVolume]

Optional

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 minmum of 4 digits: 0000

Example:

25000030 is $250000.30.

merchant[percentEcomm]

Optional

This field indicates what percentage are internet originated transactions.

integer

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

Example:

75 = 75%

merchant[seasonal]

Optional

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

boolean

  • 0 - Year-Round

  • 1 - Seasonal

merchant[amexVolume]

Optional

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

integer

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

Example:

25000030 is $250000.30.

merchant[incrementalAuthSupported]

Optional

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]

Optional

ThreatMetrix Session ID for the Merchant

string

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

Example:

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

merchant[percentBusiness]

Optional

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

integer

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

Example:

75 = 75%

merchant[applePayActive]

Optional

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

boolean

  • 0 - Active

  • 1 - Inactive

merchant[applePayStatus]

Optional

Thyis field identifies that Merhcnat’s Domain Registration status for Apple Pay.

string

  • null - can be registered later.

merchant[googlePayActive]

Optional

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

boolean

  • 0 - Active

  • 1 - Inactive

merchant[passTokenEnabled]

Optional

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

boolean

  • 0 - Disabled

  • 1 - Enabled

merchant[naics]

Optional

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

integer

Valid Values

  • 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]

Optional

The NAICS sector description matching the above 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.

merchant[expressBatchCloseMethod]

Optional

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]

Optional

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 U.S Eastern Time Zone (EST):

HH:II:SS

Example:

15:28:00 is 3:28 PM EST

merchant[inactive]

Required

Whether this Merchant is marked as inactive.

boolean

  • 0 - Active

  • 1 - Inactive

merchant[frozen]

Required

Whether this Merchant is marked as frozen.

boolean

  • 0 - Not Frozen

  • 1 - Frozen

Merchant Business Information - Example Query

CODE 
?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
Pre-Populate Query Example - Merchant Business Information

Pre-Populated Information:

Merchant Info

Example Info

Query Parameter Input Format

Merchant DBA

Bob’s Bike Store

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

Is this a new Merchant?

Yes

?merchant[new]=1

When was the Merchant legally formed/established?

January 20, 2016

?merchant[established]=20160120

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’s this Merchant’s platform boarding status?

Ready

?merchant[status]=1

Is the Merchant successfully boarded?

No

?merchant[boarded]=0

Will the Merchant account be active or inactive?

Active

?merchant[inactive]=0

Will the Merchant account be not frozen or frozen ?

Not Frozen

?merchant[frozen]=0

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

The reason for a status being Manual (3), Closed (4), Incomplete (5) or Pending (6) status.

Fraud [Risk]

?merchant[statusReason]=fraud

This is for example purposes, do not change the statusReason from null unless you have chosen one of the statuses mentioned for this example.

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

$250,000.30

?merchant[totalApprovedSales]=25000030

Will this Merchant be approved for Auto-Boarding for the platform?

Yes

?merchant[autoBoarded]=1

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-assement?

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

What is the reason code if the Merchant’s account was closed on the platform previously?

Member Credit Score Too Low

?merchant[accountClosureReasonCode]=deniedMemberCreditScore

This is for example purposes, do not change the statusReason from null unless you have chosen one of the statuses mentioned for this example.

Date the Merchant’s platform account was previously closed?

Jan 20, 2016

?merchant[accountClosureReasonDate]=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]=75

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 from EST)

6:30 PM EST

?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 Parameter Values

Value

Required

Description

Type

Format & Valid Values

merchant[members][0][first]

Required

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]

Optional

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]

Required

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][email]

Required

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]

Required

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][ssn]

Optional

The social security (U.S.) or social insurance number (Canada) of the Merchant’s managing member

number

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

Do not use dashes.

merchant[members][0][dob]

Required

The date of birth of this Member

date

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

YYYMMDD

Example:

20160120 is January 20, 2016.

merchant[members][0][title]

Optional

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][address1]

Required

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]

Required

Suite, Unit or Apt 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]

Required

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]

Required

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

string

The 2-digit postal abbreviation for any U.S. state, territory or Candaian province.

Valid Values

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

merchant[members][0][zip]

Required

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][primary]

Required

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

boolean

  • 0 - Not primary

  • 1 - Primary

merchant[members][0][country]

Required

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

string

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

Valid Values

  • ABW

  • AFG

  • AGO

  • AIA

  • ALA

  • ALB

  • AND

  • ARE

  • ARG

  • ARM

  • ASM

  • ATA

  • ATF

  • ATG

  • AUS

  • AUT

  • AZE

  • BDI

  • BEL

  • BEN

  • BES

  • BFA

  • BGD

  • BGR

  • BHR

  • BHS

  • BIH

  • BLM

  • BLR

  • BLZ

  • BMU

  • BOL

  • BRA

  • BRB

  • BRN

  • BTN

  • BVT

  • BWA

  • CAF

  • CAN

  • CCK

  • CHE

  • CHL

  • CHN

  • CIV

  • CMR

  • COD

  • COG

  • COK

  • COL

  • COM

  • CPV

  • CRI

  • CUB

  • CUW

  • CXR

  • CYM

  • CYP

  • CZE

  • DEU

  • DJI

  • DMA

  • DNK

  • DOM

  • DZA

  • ECU

  • EGY

  • ERI

  • ESH

  • ESP

  • EST

  • ETH

  • FIN

  • FJI

  • FLK

  • FRA

  • FRO

  • FSM

  • GAB

  • GBR

  • GEO

  • GGY

  • GHA

  • GIB

  • GIN

  • GLP

  • GMB

  • GNB

  • GNQ

  • GRC

  • GRD

  • GRL

  • GTM

  • GUF

  • GUM

  • GUY

  • HKG

  • HMD

  • HND

  • HRV

  • HTI

  • HUN

  • IDN

  • IMN

  • IND

  • IOT

  • IRL

  • IRN

  • IRQ

  • ISL

  • ISR

  • ITA

  • JAM

  • JEY

  • JOR

  • JPN

  • KAZ

  • KEN

  • KGZ

  • KHM

  • KIR

  • KNA

  • KOR

  • KWT

  • LAO

  • LBN

  • LBR

  • LBY

  • LCA

  • LIE

  • LKA

  • LSO

  • LTU

  • LUX

  • LVA

  • MAC

  • MAF

  • MAR

  • MCO

  • MDA

  • MDG

  • MDV

  • MEX

  • MHL

  • MKD

  • MLI

  • MLT

  • MMR

  • MNE

  • MNG

  • MNP

  • MOZ

  • MRT

  • MSR

  • MTQ

  • MUS

  • MWI

  • MYS

  • MYT

  • NAM

  • NCL

  • NER

  • NFK

  • NGA

  • NIC

  • NIU

  • NLD

  • NOR

  • NPL

  • NRU

  • NZL

  • OMN

  • PAK

  • PAN

  • PCN

  • PER

  • PHL

  • PLW

  • PNG

  • POL

  • PRI

  • PRK

  • PRT

  • PRY

  • PSE

  • PYF

  • QAT

  • REU

  • ROU

  • RUS

  • RWA

  • SAU

  • SDN

  • SEN

  • SGP

  • SGS

  • SHN

  • SJM

  • SLB

  • SLE

  • SLV

  • SMR

  • SOM

  • SPM

  • SRB

  • SSD

  • STP

  • SUR

  • SVK

  • SVN

  • SWE

  • SWZ

  • SXM

  • SYC

  • SYR

  • TCA

  • TCD

  • TGO

  • THA

  • TJK

  • TKL

  • TKM

  • TLS

  • TON

  • TTO

  • TUN

  • TUR

  • TUV

  • TWN

  • TZA

  • UGA

  • UKR

  • UMI

  • URY

  • USA

  • UZB

  • VAT

  • VCT

  • VEN

  • VGB

  • VIR

  • VNM

  • VUT

  • WLF

  • WSM

  • XXK

  • YEM

  • ZAF

  • ZMB

  • ZWE

merchant[members][0][significantResponsibility]

Required

A controlling authority, or 'Control Prong' include but are 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]

Required

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

integer

This field is a 4-5 digit integer between 0001 (.01%) and 10000 (100%).

Example:

7525 = 75.25%

merchant[members][0][dl]

Required

The Member’s driver’s license ID number.

string

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

Example: 123456789

merchant[members][0][dlstate]

Required

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

string

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

Valid Values

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

Merchant Member Information - Example Query

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]=01011985&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]=10000&merchant[members][0][primary]=1&merchant[members][0][dl]=123456789&merchant[members][0][dlstate]=NY
Pre-Populate Query Example - Merchant Member Information

Pre-Populated Merchant Member Information:

Merchant Member Info

Example Info

Query Parameter Input Format

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]=19851025

What is the title of the Merchant managing member?

CEO

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

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

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

Yes

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

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]=5000

Final Pre-Populated Query Result

CODE 
public=0&website=https://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=PAYRIXSUBMERCHANT123&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]=20160120&merchant[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[statusReason]=&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[accountClosureReasonCode]=&merchant[accountClosureReasonDate]=&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]=01011985&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]=10000

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.

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

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.

JavaScript errors detected

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

If this problem persists, please contact our support.

Contact Support Close