Integration Guide: How to Complete Your Profile

Business Information

-
Parameter Required Description
businessName Yes

Customer-facing name of the business.

Type: string

Limits:

  • Maximum 60 characters
  • ASCII characters only, with special characters: ",()./-"
legalName Yes

Legal name of the business.

Type: string

Limits:

  • Maximum 60 characters
  • ASCII characters only, with special characters: ",()./-"
productAndServiceDesc Yes

Detailed description of the business, including information about customers and merchant products, services, or both.

Type: string

Limits: Maximum 1500 characters
phone Yes

Company phone number.

Type: string

Limits: For US merchants, 10 digits with no spaces, dashes, or any other characters
businessType Yes

Type of business.

Valid values:

  • Limited Liability
  • Non-profit
  • Partnership
  • Private Corporation
  • Public Corporation
  • Sole Proprietorship
businessCategory Yes

Category of the business.

Valid values:

  • Business Services
  • Educational Services
  • Charities/Donations
  • Miscellaneous Personal Services
  • Pharmacy
  • Miscellaneous Specialty Retail
  • Software
  • Travel Agencies & Tour Operators
  • Other
taxId Yes

Merchant's tax ID number.

Type: alphanumeric

Limits: 9 characters
address Yes

Merchant's business address. Must be a registered business address.

Type: string

Limits: Maximum 40 characters
city Yes

Merchant's business address city.

Type: string

Limits: Maximum 40 characters
state Yes

Merchant's business address state.

Type: string

Limits: 2-letter code. Refer to State and Province Codes.
zip Yes

Merchant's business address zip code.

Type: number

Limits: 5- or 9-digit number, no special characters, no spaces
country Yes

Merchant's business address country.

Type: string

Limits:

  • United States: US
  • American Samoa: AS
  • Guam: GU
  • Marshall Isle: MH
  • Micronesia: FM
  • Palau: PW
  • Virgin Islands: VI

For more country codes, refer to Country Codes.
email Yes

The business email address provided by your merchant.

Type: string

Limits:

  • Minimum 7 characters
  • Maximum 100 characters
  • Plus sign ("+") character not permitted
  • Must have "@" character in string
  • Must include at least one period (".")

Note: After the application is approved, an access URL for your merchant's Chargeback Disputes Portal is sent to this email address.
accountUsername Yes

Merchant's account username. This is for the BlueSnap Merchant Portal credentials for the merchant.

Type: alphanumeric

Limits:

  • Maximum 18 characters
  • Must be unique
  • Only accepts the following special characters: - . _ ( ) :
salesVolume Yes

Merchant's current annual sales volume (Must be in USD).

Type: numeric

Limits: Value must be greater than zero
website Yes

Main website for the merchant's business.

Type: string

Limits:

  • Maximum 100 characters
additionalWebsites No

Array of up to 10 website addresses for the merchant's business, in addition to the main website.

Type: string

Limits:

  • Maximum 10 websites
  • Maximum 100 characters per website address
  • At least 1 "." required per website address
  • No spaces in website address
averageTransactionAmount Yes

Average transaction value for the current calendar year (must be in USD).

Type: string

Limits: Numbers only
highestTransactionAmount Yes

Highest transaction value for the current calendar year (must be in USD).

Type: string

Limits: Numbers only
riskMonitoring Yes

Provides an answer to the following question:

Has your company been placed in any Fraud Monitoring or Risk Monitoring Program?

Type: string

Limits: yes or no only
riskPayment Yes

Provides an answer to the following question:

Has your company been previously terminated by a payment processor, acquirer, financial institution, or operator of a payment system due to fraud, Credit Card Laundering, or excessively high chargeback rates?

Type: string

Limits: yes or no only
riskByCommission Yes

Provides an answer to the following question:

Has your company been the subject of a complaint filed by the Federal Trade Commission or consumer protection agency, or have you entered into an Assurance of Voluntary Compliance with a states attorney general?

Type: string

Limits: yes or no only

Ownership Information

+
Parameter Required Description
ownershipInfoArr Required if a person owns at least 25%. Otherwise, optional.

Container for the ownershipInfoArr properties.

Provide personal information for the owner, not the business. For example, provide the owner's personal address.

An owner must have at least 25% ownership of the company. You can have up to 4 owners.

If no one person owns at least 25%, do not include ownershipInfoArr, include companyRep instead.
ownerFirstName Yes

Business owner's first name.

Type: string

Limits:

  • US: Maximum 40 characters
  • Other: Maximum 60 characters
ownerLastName Yes

Business owner's last name.

Type: string

Limits:

  • US: Maximum 40 characters
  • Other: Maximum 60 characters
ownerDateOfBirth Yes

The business owner's date of birth.

Type: numeric with "/"

Limits:

  • Must be in the format of MM/DD/YYYY
  • Maximum 10 characters
ownerGovID Yes

Business owner's government ID number.

Type: numeric

Limits:

  • No special characters
  • US: Last 4 digits of SSN, numbers only
  • Other: Maximum 50 characters

For more information on government ID types, refer to Government ID Types.
ownerPhone Yes

Business owner's personal phone number.

Type: string

Limits:

  • No spaces, dashes, or any other characters
  • US/CA: 10 digits required
  • UK: Maximum 11 digits
  • Other: Maximum 15 digits
ownerPercent Yes

Percentage of the business that belongs to the owner.

Limits:

  • Numbers only
  • Accepts up to two decimal places
address Yes

Business owner's home street address.

Type: string

Limits:

  • US: Maximum 40 characters
  • Other: Maximum 60 characters
city Yes

Business owner's home address city.

Type: string

Limits:

  • US: Maximum 25 characters
  • Other: Maximum 60 characters
state Only if country is US or CA

Business owner's home address state/province/county/region.

Type: string

Limits: 2-letter code. For US and CA, refer to State and Province Codes.
zip Yes

Business owner's home address zip or postal code.

Type: string

Limits:

  • US: Must be 5 or 9 digits
  • CA: Maximum 7 characters, only 1 space allowed
  • AU: Maximum 4 characters
  • UK: Maximum 8 characters, spaces allowed
  • EU/ROW: Maximum 15 characters, spaces allowed
country Yes

Business owner's home address country.

Type: string

Limits: 2-letter code. For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.

Company Representative Information

+
Parameter Required Description
companyRep Yes

Container for the companyRep properties.

Provide personal information for a person who oversees the business and has significant control over the entity. For example, provide the address and phone number of the CEO, COO, or CFO.
companyRepFirstName Yes

Company representative's first name.

Type: string

Limits:

  • US: Maximum 40
  • Other: Maximum 60
companyRepLastName Yes

Company representative's last name.

Type: string

Limits:

  • US: Maximum 40
  • Other: Maximum 60
companyRepDateOfBirth Yes

The company representative's date of birth.

Type: numeric with "/"

Limits:

  • Must be in the format of MM/DD/YYYY
  • Maximum 10 characters
companyRepGovID Yes

Company representative's government ID number.

Type: numeric

Limits:

  • No special characters
  • US: Last 4 digits of SSN, numbers only
  • Other: Maximum 50 characters

For more information on government ID types, refer to Government ID Types.
companyRepPhone Yes

Company representative's personal phone number.

Type: string

Limits:

  • No spaces, dashes, or any other characters
  • US/CA: 10 digits required
  • UK: Maximum 11 digits
  • Other: Maximum 15 digits
companyRepAddress Yes

Company representative's home street address.

Type: string

Limits:

  • US: Maximum 40 characters
  • Other: Maximum 60 characters
companyRepCity Yes

Company representative's home address city.

Type: string

Limits:

  • US: Maximum 25 characters
  • Other: Maximum 60 characters
companyRepState Only if companyRepCountry is US or CA

Company representative's home address state/province/county/region.

Type: string

Limits: 2-letter code. For US and CA, refer to State and Province Codes.
companyRepZip Yes

Company representative's home address zip or postal code.

Type: string

Limits:

  • US: Must be 5 or 9 digits
  • CA: Maximum 7 characters, only 1 space allowed
  • AU: Maximum 4 characters
  • UK: Maximum 8 characters, spaces allowed
  • EU/ROW: Maximum 15 characters, spaces allowed
companyRepCountry Yes

Company representative's home address country.

Type: string

Limits: 2-letter code. For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.
additionalCompanyReps No

Array of up to 20 companyRep objects, in addition to the primary companyRep object.

Reference Links

+