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:
Create a Merchant Signup Form if you haven’t already.
Copy the link to the form from the Signup Forms page.
The link should look like this:https://test-portal.{yourBrand}.com/signup/12345678
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 |
---|---|---|---|
| The legal formation structure filed by the Entity. | integer |
|
| The name of the entity. | string | This field is a text string and must be between 1 and 100 characters long. |
| Whether the Merchant entity has employees. | boolean |
|
| 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. |
| Indicates whether this is a publicly held and traded entity. | boolean |
|
| 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. |
| 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. |
| 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. |
| 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
|
| 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, 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 |
---|---|---|---|
| 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 (). |
| 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 (). |
| 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. |
| The email address associated with this Entity. | string | This field is a text string and must be between 1 and 100 characters long. |
| The street address for the Entity. | string | This field is a text string and must be between 1 and 500 characters long. |
| 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. |
| The Entity’s street address city. | string | This field is a text string and must be between 1 and 500 characters long. |
| 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
US Territories
Canada Provinces
|
| The Entity’s address portal code. | string | This field is an alphanumeric string and must be between 5 and 20 digits. Can include dashes. |
| 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.
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 |
---|---|---|---|
| Whether the Merchant agreed to the Terms of the Referrer platform. Important: You should not accept terms on behalf of the Merchant. | boolean |
|
| 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 |
|
| 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
|
| 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: Example: |
| 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
|
| Date and time on which this Entity accepted the Terms and Conditions, if different. | date | The date is specified as a 12-digit string: Example: |
| 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 Query
The following query example prepopulates Merchant entity information in a form:
?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 |
|
What is the name for this new Merchant Entity? | Bob’s Bikes |
|
Merchant Business Primary Phone Number | 555-555-5555 |
|
Merchant Business Customer Service Phone Number | 555-555-5555 |
|
Merchant Business Customer Website | www.examplebikes.com |
|
Merchant Business Primary Email Address | example@examplebikes.com |
|
Does the Merchant have employees? | Yes |
|
Merchant Legal Name filed with the IRS or CRA. | Bob's Bicycles LLC |
|
Is the Merchant a Public or Private Company? | Private Company |
|
Merchant Business Industry | Custom Bicycle Sales |
|
What is the platform account display name for the Merchant Entity? | Bob’s Bikes |
|
What descriptor do we want to appear next to deposits into the Merchant Account | Example Bikes |
|
Merchant Tax ID number issued from CRA or IRS | 12-3456789 |
|
Merchant Tax ID Type | Tax ID Number |
|
Merchant Business Street Address | 123 Main St. |
|
Merchant Business Unit or Suite | Suite 456 |
|
Merchant Business Street Address City | New York |
|
Merchant Business Street Address State | New York |
|
Merchant Business Street Address Postal Code | 10001 |
|
Merchant Business Street Address Country | United States |
|
Did the Merchant attest to viewing the Payrix Pro platform Terms and Conditions? | Yes |
|
What Terms and Conditions version did the Merchant agree to? | Payrix Pro Sub-Merchant T&C Version 1.2.3 |
|
What date were the Terms and Conditions last uploaded? | January 20, 2024 12:00pm EST |
|
What IP address were the Merchant Terms and Conditions uploaded to. | 0.0.0.0 |
|
When did the Merchant agree to the Terms and Conditions? | January 20, 2024, 12:00 PM Eastern Time |
|
What IP address did the Merchant agree to the Terms and Conditions from? | 0.0.0.0 |
|
Is there any custom description this Merchant should have? | 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 |
---|---|---|---|
| The type of bank account. | integer |
|
| 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: |
| 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: |
| 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. |
| 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. |
| Whether this will be the primary bank account for the Merchant. | boolean |
|
| Whether the Merchant’s bank account will be used for receiving deposits (credits), withdrawing for costs (debits), or both on the platform. | string |
|
Example Query
The following query example prepopulates Merchant bank account information in a form:
?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 |
|
What is the bank routing number the Merchant is linking? | 012345678 |
|
What is the bank account number the Merchant is linking? | 0123456789012345 |
|
Confirm the Merchant Bank account. | 0123456789012345 |
|
Is this the Merchant’s primary bank account for platform usage and deposits? | Yes |
|
Will this bank account be used for receiving deposit credits, withdrawing cost debits or both for the Merchant? | Debit |
|
What is the customized name for the Merchant’s bank account on the platform? | Example Checking |
|
What is the customized description for the Merchant’s bank account on the platform? | 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 |
---|---|---|---|
| An indicator that specifies whether the Merchant is new to credit card processing. By default, merchants are considered to be new. | boolean |
|
| The date on which the Merchant was established. | date | The date must be in the format Example: |
| The Merchant Category Code (MCC) for this Merchant. | string | Must be a valid MCC with 4 numeric digits. |
| 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. |
| The environment which the Merchant is in, if applicable. | string |
|
| Description of the type of address that the business operates at. | string |
|
| Indicates if the merchant is a seasonal merchant or operates year-round. | boolean |
|
| The NAICS sector code that accurately describes the industry the business operates in. | integer |
|
| The NAICS sector description matching the NAICS sector code. If | 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 |
---|---|---|---|
| Whether the Merchant agrees to the platform Terms and Conditions. Important: You should not accept terms on behalf of the Merchant. | boolean |
|
| Whether the Merchant has reviewed the Visa card brand disclosure. | boolean |
|
| 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
|
| The date the Merchant platform disclosure is reviewed by the Merchant. | date | The date is specified as an 8-digit numeric string: Example: |
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 |
---|---|---|---|
| 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: Example: |
| 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: Example: |
| 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. |
| 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. |
| 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. |
| The email address where the Merchant’s chargeback notification emails will be sent. | Must be a valid email address. | |
| Show the total approved amount to this merchant. | integer | This field is an integer in cents with a minimum of 4 digits: Example: |
| 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: Example: |
| 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: Example: |
| 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: |
| 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: |
| Indicates whether the merchant accepts pre-purchase for products that are shipped at a later date or not currently available. | boolean |
|
| 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: |
| 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: Example: |
| This field indicates what percentage are internet originated transactions. | integer | This field is a 1 to 3-digit integer between 1 and 100. Example: |
| 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: Example: |
| 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: |
| This field indicates if Apple Pay is active for this merchant. | boolean |
|
| This field identifies the Merchant’s Domain Registration status for Apple Pay. | string |
|
| This field indicates if Google Pay is active for this merchant. | boolean |
|
| This field indicates if Pass Token is enabled for this merchant. | boolean |
|
| This field indicates the batch close method for this merchant applicable to Express platform. | string |
|
| 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: Example: |
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 |
---|---|---|---|
| Payment Card Industry (PCI) Data Security Standard Self-Assessment Questionnaire & Rating for Self-Attestation of Compliance. | string | The SAQ rating for the Merchant business.
|
| The date of certification from PCI-DSS Self-Assessment Questionnaire. | date | The date is specified as an 8-digit numeric string: Example: |
| 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. |
| The status of the Merchant’s PCI SAQ-QSA letter status approving or denying the Merchant based on its assessment. | boolean |
|
| The date the PCI SAQ-QSA letter was provided. | date | The date is specified as an 8-digit numeric string: Example: |
| The Merchant risk score categorized by level, where applicable. | string |
|
| 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: |
| 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: |
| 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: |
| This field allows the ability to submit merchant registration files with a MasterCard (MC) Auth Integrity value. | boolean |
|
| 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: |
Example Query
The following query example prepopulates Merchant business information in a form:
?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 |
|
When was the Merchant legally formed/established? | January 20, 2016 |
|
Merchant DBA | Bob’s Bike Store |
|
What is the Merchant’s expected amount of annual credit card sales? | $220,000.00/year |
|
What is the average amount of each customer transaction/ticket? | $1,500.00/ticket |
|
What is the Merchant’s registration code provided by American Express? | 123456789012345 |
|
What is the Merchant’s registration code provided by Discover? | 123456789012345 |
|
What is the Merchant’s Merchant Category Code (MCC)? | 5499 |
|
What environment does the Merchant accept payments? | e-Commerce |
|
What is the Merchant’s Merchant Visa Verification (MVV) code? | 123456 |
|
What email address does the Merchant want to use for their emailed chargeback notifications/alerts? | merchant@example.com |
|
Total Approved Amount for this Merchant to Process in Credit Card Sale | $250,000.30 |
|
What is the Merchant’s PCI DSS self-assessment rating? | SAQ-B |
|
When was the Merchant rated for PCI-DSS self-assessment? | Jan 20, 2016 |
|
The name of the individual assessor or organization that provided the QSA assessment and certification. | Example QSA Merchant |
|
Did the Merchant receive the PCI QSA certification letter? | Yes |
|
What date was the Merchant PCI QSA certification letter issued? | Jan 20, 2016 |
|
Did the Merchant agree to the terms and conditions for platform usage? | Yes |
|
Has the Merchant reviewed the Visa disclosure? | Yes |
|
What is the IP address where the Merchant reviewed the Visa disclosure (Merchant’s primary IP address)? | 192.168.0.1 |
|
Date the Merchant reviewed the Visa disclosure. | Jan 20, 2016 |
|
How many credit card transactions does the Merchant process per year? | 50,000/year |
|
How many eCheck transactions does the Merchant process per year? | 2,000/year |
|
What is the Merchant’s risk level? | Low |
|
What is the Merchant’s ratio of credit utilization? | 2:1 |
|
What is the Merchant’s ratio of on-time repayment? | 1:1 |
|
What ratio of the Merchant’s sale transactions result in chargebacks? | 0:1 |
|
How many days occur between a customer payment and shipment/fulfillment of the Merchant’s products/services? | 3 days |
|
What percentage of transactions of the Merchant’s will utilize the Non-Delivery Exposure fulfillment process? | 75% |
|
Does this Merchant accept pre-payment for later-fulfilled products or services? | Yes |
|
What type of building or location does the Merchant do business from? | Warehouse |
|
What percentage of the Merchant’s business is manually keyed into a terminal or payment form? | 75% |
|
What is the Merchant’s total number of all transaction types annually? | 50,000 / year |
|
What percentage of the Merchant’s business is online e-commerce transactions? | 100% |
|
Is the Merchant seasonal? | No |
|
How many American Express card brand-based transactions does the Merchant process per year? | 15,000/year |
|
Will the Merchant be able to support partial credit card authorizations? | Yes |
|
What is the ThreatMetrix Session ID for the Merchant? | 12a345bc-67d8-9012-3e45-6f7g8901a234 |
|
What percentage of this Merchant’s transactions are business-to-business? | 75% |
|
Will Apple Pay be active for this Merchant? | Active |
|
What is the Apple Pay registration status of the Merchant? | Registered |
|
Will Google Pay be active for this Merchant? | Active |
|
Will Pass Token be enabled for this Merchant? | Yes |
|
What is the Merchant’s NAICS code number? | 44 |
|
What is the description of the NAICS code for the Merchant? | 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 |
|
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 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 |
---|---|---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| The date of birth of this Member. | date | The date must be in the format Example: |
| 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. |
| The Member’s driver’s license ID number. | string | This field is alphanumeric string and is 1 to 15 characters long. Example: |
| 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 |
---|---|---|---|
| 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 |
| 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 (). |
| Personal address for the Merchant’s managing member. | string | This field is a text string and must be between 1 and 100 characters long. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
---|---|---|---|
| Whether the Merchant’s managing member is the primary point of contact for the Merchant. | boolean |
|
| 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 |
|
| The share of the Member's ownership of the associated Merchant | integer | This field is a three-digit integer between 0 and 100. Example: |
| 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 |
|
Example Query
The following query example prepopulates Merchant member information in a form:
?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 |
|
What is the first name of the Merchant’s managing member? | Robert |
|
What is the middle name of the Merchant’s managing member? | Karl |
|
What is the last name of the Merchant’s managing member? | Wheelwright |
|
What is the Merchant’s managing member’s personal email address? | john@example.com |
|
What is the Merchant’s managing member’s personal phone number? | 555-555-5555 |
|
What is the Merchant’s managing member’s personal tax ID number (SSN or SIN)? | 123456789 |
|
What is the date of birth of the Merchant’s managing member? | October 25, 1985 |
|
What is the personal mailing address for the Merchant’s managing member? | 123 Main St. |
|
What is the apartment, unit, or suite for the Merchant’s managing member? | Apt 101 |
|
What is the Merchant’s managing member’s personal mailing address city? | Los Angeles |
|
What is the Merchant’s managing member’s personal mailing address state? | California |
|
What is the Merchant’s managing member’s personal mailing address postal code? | 90001 |
|
What is the Merchant’s managing member’s personal mailing address country? | USA |
|
Does this Merchant’s managing member retain significant responsibility in and for the Merchant business? | Yes |
|
What percentage of ownership in the Merchant business does the Merchant’s managing member retain? | 50% |
|
Is this Merchant’s managing member the primary point of contact for the Merchant’s business? | Yes |
|
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. |
|
Prepopulate the Entity’s country | Sets the country for the Merchant Entity’s street address. |
|
Prepopulate a custom value for the Entity | Sets your preferred custom value to the Merchant Entity account. |
|
Prepopulate the Merchant's Entity name | Adds the Merchant’s entity name. |
|
Prepopulate the Merchant’s associated entity ID | Adds your Merchant’s entity ID. |
|
Prepopulate your Merchant’s sales environment | Sets the Merchant’s transaction processing environment. |
|
Prepopulate Merchant Member citizenship country | Sets the Merchant’s managing member’s citizenship country. |
|
Pre-Populate Merchant Member Political Exposure Status | Sets the Merchant’s managing member’s political exposure status. |
|
Prepopulate Merchant Member ownership and responsibility | Sets the Merchant’s managing member’s ownership and responsibility in the Merchant’s business. |
|