Create Merchant API 2.0
This documentation describes Create Merchant API version 2.0. For version 1.0 documentation, see Create Merchant API 1.0.
Test Your Integration
Before you submit a merchant application in your production environment, BlueSnap recommends that you test different application outcomes with the optional
approvalTestingrequest property.For details, see Testing Your API Integration.
The New Application API lets you seamlessly integrate the new merchant application process into your platform design. You can create a form to collect the required information, and then send the information to BlueSnap to begin the merchant onboarding and verification process.
Endpoint
https://platform.bluesnap.com/services/2/merchants/new-application
Request Content
The merchant application requires that you collect specific business and banking information that varies by country or region.
Australia
| Parameter | Required | Description |
|---|---|---|
pfToken
|
Required if using Secure Customer Data Fields. Otherwise, no. | Secure Customer Data Fields token. |
approvalTesting
|
No | Include this parameter to test the customer-onboarding workflow. The customer account is not created but you receive a webhook and email as you would during an actual onboarding. Type: string Valid values: - APPROVED- RECOMMEND_APPROVE- RECOMMEND_DECLINE- DECLINE
|
defaultIPN
|
No | Only use if you want to set up a different notification endpoint for
each of your merchants. The endpoint URL you define with this parameter will receive transactional webhooks. The webhooks you receive for your merchants will be determined during your account setup. For details, see Webhooks. |
metadata
|
No | Array of up to three custom metadata objects consisting of key/value
pairs. Limits: - Key names up to 40 characters long - Values up to 500 characters long. |
businessInfo
|
Yes | Container for the businessInfo
parameters.ASCII characters only. |
businessTradingName
|
Yes | The 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: 10 digits with no spaces, dashes, or any other characters |
businessType
|
Yes | Type of business. Valid values: - Association- Cooperative- Partnership- Proprietary Company- Public Company
|
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 |
address
|
Yes | Merchant's business address. Must be a registered business
address. Type: string Limits: Maximum 60 characters |
suburb
|
Yes | Merchant's business address suburb. Type: string Limits: Maximum 60 characters |
state |
Only if country is
US or
CA
|
Merchant's business address state/province/county/region. Type: string Limits: 2-letter code. For US and CA, refer to State and Province Codes. |
zip |
Yes | Merchant's business address zip code. Type: string Limits: Maximum 4 characters |
country
|
Yes | Merchant's business address country. Type: string Limits: AU |
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
|
Required for testing only. | 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 |
businessRegistrationNumber
|
Yes | The business's registration number. Type: string Limits: Maximum 20 characters |
acnOrAbn
|
Yes | The business's Australian Company Number (ACN) or Australian Business
Number (ABN). Type: string Limits: Maximum 15 characters |
website
|
Yes | Main website for the merchant's business. Type: string Limits: - Maximum 100 characters - At least 1 "." required - No spaces |
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
|
bankingInfo
|
Yes | Container for the bankingInfo
parameters. |
bsb |
Yes | Routing number for the merchant's business bank account. Type: string Limits: - Maximum 6 characters - Numbers only |
accountNumber
|
Yes | Account number for the merchant's business bank account. Type: string Limits: - Maximum 9 characters - Numbers only |
minimalPayoutAmount
|
Yes | The minimum amount at which the customer will be paid. Until this value
is reached, funds continue to accumulate. Type: string Limits: Minimum $35 USD. |
refundReserve
|
Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: Minimum $100 USD. |
paymentReference
|
No | Reference text that appears on the customer's bank statement when they
are paid out. Type: string Limits: Maximum 100 alphanumeric character |
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 |
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. |
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 |
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. |
merchantAgreementsSign
|
Yes | Container for the merchantAgreementsSign
parameters.Important: In addition to the agreements below, you must present your merchant with a link to the latest BlueSnap Merchant Terms & Conditions. The merchant must expressly consent to these terms and conditions before they begin using BlueSnap. |
merchantIp
|
Yes | Merchant's IP address. Type: string Limit: Maximum 45 characters IPv4 format: XXX.XXX.XXX.XXXIPv6 format: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
|
pricingAgreementDate
|
Yes | Date the merchant signed the pricing agreement. You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
serviceAgreementDate
|
Yes | Date the merchant signed the merchant service agreement. You must present the merchant with a link to the BlueSnap Merchant Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
Canada
| Parameter | Required | Description |
|---|---|---|
pfToken
|
Required if using Secure Customer Data Fields. Otherwise, no. | Secure Customer Data Fields token. |
approvalTesting
|
No | Include this parameter to test the customer-onboarding workflow. The customer account is not created but you receive a webhook and email as you would during an actual onboarding. Type: string Valid values: - APPROVED- RECOMMEND_APPROVE- RECOMMEND_DECLINE- DECLINE
|
defaultIPN
|
No | Only use if you want to set up a different notification endpoint for
each of your merchants. The endpoint URL you define with this parameter will receive transactional webhooks. The webhooks you receive for your merchants will be determined during your account setup. For details, see Webhooks. |
metadata
|
No | Array of up to three custom metadata objects consisting of key/value
pairs. Limits: - Key names up to 40 characters long - Values up to 500 characters long. |
businessInfo
|
Yes | Container for the businessInfo
parameters.ASCII characters only. |
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: number Required: 10 digits with no spaces, dashes, or 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 15 characters |
address
|
Yes | Merchant's business address. Must be a registered business
address. Type: string Limits: Maximum 60 characters |
city |
Yes | Merchant's business address city. Type: string Limits: Maximum 60 characters |
state |
Only if country is
US or
CA
|
Merchant's business address state/province/county/region. Type: string Limits: 2-letter code. For US and CA, refer to State and Province Codes. |
zip |
Yes | Merchant's business address zip/postal code. Type: string Limits: - Maximum 7 characters - Only 1 space allowed |
country
|
Yes | Merchant's business address country. Type: string Limits: CA |
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
|
Required for testing only. | 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 |
businessRegistrationNumber
|
Yes | The business's registration number. Type: string Limits: Maximum 11 characters |
website
|
Yes | Main website for the merchant's business. Type: string Limits: - Maximum 100 characters - At least 1 "." required - No spaces |
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
|
bankingInfo
|
Yes | Container for the bankingInfo
parameters. |
payoutCurrency
|
Yes | Currency in which the merchant will be paid. Type: string Limits: CAD |
minimalPayoutAmount
|
Yes | The minimum amount at which the customer will be paid. Until this value
is reached, funds continue to accumulate. Type: string Limits: - This must be specified in the currency selected in payoutCurrency
(CAD).- Minimum value is the equivalent of $35 USD. |
refundReserve
|
Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: - This must be specified in the currency selected in payoutCurrency
(CAD).- Minimum value is the equivalent of $100 USD. |
bankProvince
|
Yes | Province where the bank is located. Type: string Limits: 2-letter code. Refer to State and Province Codes. |
transitNumber
|
Yes | Routing number. Generally, this is a 5-digit code. Type: string Limits: - Maximum 5 characters - Numbers only |
institutionNumber
|
Yes | Financial institution number. Type: string Limits: 3 digit number |
accountNumber
|
Yes | Bank account number. Type: string Limits: - Maximum 12 characters - Numbers only |
paymentReference
|
No | Reference text that appears on the customer's bank statement when they
are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
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 |
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. |
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 |
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. |
merchantAgreementsSign
|
Yes | Container for the merchantAgreementsSign
parameters.Important: In addition to the agreements below, you must present your merchant with a link to the latest BlueSnap Merchant Terms & Conditions. The merchant must expressly consent to these terms and conditions before they begin using BlueSnap. |
merchantIp
|
Yes | Merchant's IP address. Type: string Limit: Maximum 45 characters IPv4 format: XXX.XXX.XXX.XXXIPv6 format: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
|
pricingAgreementDate
|
Yes | Date the merchant signed the pricing agreement. You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
serviceAgreementDate
|
Yes | Date the merchant signed the merchant service agreement. You must present the merchant with a link to the BlueSnap Merchant Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
European Union
Supported Countries
| Name | Code |
|---|---|
| Austria | AT |
| Belgium | BE |
| Bulgaria | BG |
| Croatia | HR |
| Cyprus | CY |
| Czech Rep | CZ |
| Denmark | DK |
| Estonia | EE |
| Finland | FI |
| France | FR |
| Germany | DE |
| Gilbraltar | GI |
| Greece | GR |
| Guernsey | GG |
| Hungary | HU |
| Iceland | IS |
| Ireland | IE |
| Italy | IT |
| Latvia | LV |
| Liechtenstein | LI |
| Lithuania | LT |
| Luxembourg | LU |
| Malta | MT |
| Netherlands | NL |
| Norway | NO |
| Poland | PL |
| Portugal | PT |
| Romania | RO |
| Slovakia | SK |
| Slovenia | SI |
| Spain | ES |
| Sweden | SE |
| Switzerland | CH |
Request Parameters
| Parameter | Required | Description |
|---|---|---|
pfToken
|
Required if using Secure Customer Data Fields. Otherwise, no. | Secure Customer Data Fields token. |
approvalTesting
|
No | Include this parameter to test the customer-onboarding workflow. The customer account is not created but you receive a webhook and email as you would during an actual onboarding. Type: string Valid values: - APPROVED- RECOMMEND_APPROVE- RECOMMEND_DECLINE- DECLINE
|
defaultIPN
|
No | Only use if you want to set up a different notification endpoint for
each of your merchants. The endpoint URL you define with this parameter will receive transactional webhooks. The webhooks you receive for your merchants will be determined during your account setup. For details, see Webhooks. |
metadata
|
No | Array of up to three custom metadata objects consisting of key/value
pairs. Limits: - Key names up to 40 characters long - Values up to 500 characters long. |
businessInfo
|
Yes | Container for the businessInfo
parameters.ASCII characters only. |
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: Maximum 15 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
(VAT) |
Yes | Merchant's tax ID number. Important: Do not include the 2-character country code in this field. Type: alphanumeric Limits: 15 characters |
address
|
Yes | Merchant's business address. Must be a registered business
address. Type: string Limits: Maximum 60 characters |
city |
Yes | Merchant's business address city. Type: string Limits: Maximum 60 characters |
state |
Only if countryGermany
|
Merchant's business address state/province/county/region. Type: string Limits: 2-letter code. Refer to State and Province Codes. |
zip |
Yes | Merchant's business address zip/postal code. Type: string Limits: Maximum 15 characters, spaces allowed |
country
|
Yes | Merchant's business address country. Type: string Limits: 2-letter code. Refer to Supported Countries. |
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. |
salesVolume
|
Yes | Merchant's current annual sales volume (Must be in USD). Type: numeric Limits: Value must be greater than zero |
businessRegistrationNumber
|
Yes | The business's registration number. Type: string Limits: Maximum 20 characters |
website
|
Yes | Main website for the merchant's business. Type: string Limits: - Maximum 100 characters - At least 1 "." required - No "+" character allowed - Must have "@" in string |
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
|
bankingInfo
|
Yes | Container for the bankingInfo
parameters. |
minimalPayoutAmount
|
Yes | The minimum amount at which the customer will be paid. Until this value
is reached, funds continue to accumulate. Type: string Limits: - This must be specified in the currency selected in payoutCurrency.- Minimum value is the equivalent of $35 USD. |
refundReserve
|
Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: - This must be specified in the currency selected in payoutCurrency.- Minimum value is the equivalent of $100 USD. |
bankCountry
|
Yes | Country where the bank is located. Type: string Limits: 2-letter code. Refer to State and Province Codes. |
bic |
Yes | Bank Identification Code, also known as a SWIFT code. Type: string Limits: Maximum 11 characters |
iban |
Yes | International Bank Account Number. Type: string Limits: Maximum 34 characters |
paymentReference
|
No | Reference text that appears on the customer's bank statement when they
are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
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 |
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. |
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 |
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. |
merchantAgreementsSign
|
Yes | Container for the merchantAgreementsSign
parameters.Important: In addition to the agreements below, you must present your merchant with a link to the latest BlueSnap Merchant Terms & Conditions. The merchant must expressly consent to these terms and conditions before they begin using BlueSnap. |
merchantIp
|
Yes | Merchant's IP address. Type: string Limit: Maximum 45 characters IPv4 format: XXX.XXX.XXX.XXXIPv6 format: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
|
pricingAgreementDate
|
Yes | Date the merchant signed the pricing agreement. You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
serviceAgreementDate
|
Yes | Date the merchant signed the merchant service agreement. You must present the merchant with a link to the BlueSnap Merchant Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
United Kingdom
Merchants must be based out of one of the following countries:
- England
- Northern Ireland
- Scotland
- Wales
| Parameter | Required | Description |
|---|---|---|
pfToken
|
Required if using Secure Customer Data Fields. Otherwise, no. | Secure Customer Data Fields token. |
approvalTesting
|
No | Include this parameter to test the customer-onboarding workflow. The customer account is not created but you receive a webhook and email as you would during an actual onboarding. Type: string Valid values: - APPROVED- RECOMMEND_APPROVE- RECOMMEND_DECLINE- DECLINE
|
defaultIPN
|
No | Only use if you want to set up a different notification endpoint for
each of your merchants. The endpoint URL you define with this parameter will receive transactional webhooks (Webhooks). The webhooks you receive for your merchants will be determined during your account setup. For details, see Webhooks. |
metadata
|
No | Array of up to three custom metadata objects consisting of key/value
pairs. Limits: - Key names up to 40 characters long - Values up to 500 characters long. |
businessInfo
|
Yes | Container for the businessInfo
parameters.ASCII characters only. |
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: Maximum 11 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
(VAT) |
Yes | Merchant's tax ID number. Important: Do not include the 2-character country code in this field. Type: alphanumeric Limits: 15 characters |
address
|
Yes | Merchant's business address. Must be a registered business
address. Type: string Limits: Maximum 60 characters |
city |
Yes | Merchant's business address city. Type: string Limits: Maximum 60 characters |
zip |
Yes | Merchant's business address zip/postal code. Type: string Limits: Maximum 8 characters, spaces allowed |
country
|
Yes | Merchant's business address country. Type: string Limits: GB (This
should be used for all of Great Britain, including Wales, Northern Ireland, and Scotland). |
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.
|
salesVolume
|
Yes | Merchant's current annual sales volume (Must be in USD). Type: numeric Limits: Value must be greater than zero |
businessRegistrationNumber
|
Yes | The business's registration number. Type: alphanumeric Limits: Maximum 8 characters |
website
|
Yes | Main website for the merchant's business./ Type: string Limits: - Maximum 100 characters - At least 1 "." required - No "+" character allowed - Must have "@" char in string |
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
|
bankingInfo
|
Yes | Container for the bankingInfo
parameters. |
minimalPayoutAmount
|
Yes | The minimum amount at which the customer will be paid. Until this value
is reached, funds continue to accumulate. Type: string Limits: - This must be specified in the currency selected in payoutCurrency.- Minimum value is the equivalent of $35 USD. |
refundReserve
|
Yes | The amount of funds kept in the account to cover refunds. Type: string Limits: - This must be specified in the currency selected in payoutCurrency.- Minimum value is the equivalent of $100 USD. |
sortOrder
|
Yes | Bank Identification Code, also known as a Sort Code, National Sort Code
[NSC], or SWIFT code. Type: string Limits: - Must be 6 characters - Numbers only |
accountNumber
|
Yes | Bank account number. Type: string Limits: - Must be 8 characters - Numbers only |
paymentReference
|
No | Reference text that appears on the customer's bank statement when they
are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
payoutMethod
|
No | Method or entity that facilitated the payout. When you omit this
parameter, CHAPS is
used as the payout method.If you send a request with both payoutMethod
and paymentReference,
paymentReference
is ignored.Type: string Limits: Accepts only Fastbank
as a value.Note: When Fastbank
is the payout method, BlueSnap might be listed as the payment reference on the bank statement
when your merchant is paid out.
|
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 |
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. |
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 |
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. |
merchantAgreementsSign
|
Yes | Container for the merchantAgreementsSign
parameters.Important: In addition to the agreements below, you must present your merchant with a link to the latest BlueSnap Merchant Terms & Conditions. The merchant must expressly consent to these terms and conditions before they begin using BlueSnap. |
merchantIp
|
Yes | Merchant's IP address. Type: string Limit: Maximum 45 characters IPv4 format: XXX.XXX.XXX.XXXIPv6 format: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
|
pricingAgreementDate
|
Yes | Date the merchant signed the pricing agreement. You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
serviceAgreementDate
|
Yes | Date the merchant signed the merchant service agreement. You must present the merchant with a link to the BlueSnap Merchant Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
United States
| Parameter | Required | Description |
|---|---|---|
pfToken
|
Required if using Secure Customer Data Fields. Otherwise, no. | Secure Customer Data Fields token. |
approvalTesting
|
No | Include this parameter to test the customer-onboarding workflow. The customer account is not created but you receive a webhook and email as you would during an actual onboarding. Type: string Valid values: - APPROVED- RECOMMEND_APPROVE- RECOMMEND_DECLINE- DECLINE
|
defaultIPN
|
No | Only use if you want to set up a different notification endpoint for
each of your merchants. The endpoint URL you define with this parameter will receive transactional webhooks (Webhooks). The webhooks you receive for your merchants will be determined during your account setup. For details, see Webhooks. |
metadata
|
No | Array of up to three custom metadata objects consisting of key/value
pairs. Limits: - Key names up to 40 characters long - Values up to 500 characters long. |
businessInfo
|
Yes | Container for the businessInfo
parameters.ASCII characters only. |
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 |
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
|
bankingInfo
|
Yes | Container for the bankingInfo
parameters. |
routingNumber
|
Yes | Routing number for the merchant's business bank account. Type: string Limits: - Maximum 9 characters - Numbers only |
accountNumber
|
Yes | Account number for the merchant's business bank account. Type: string Limits: - Must be 17 characters - Numbers only |
bankState
|
Yes | Merchant's bank address state. Type: string Must be a valid 2-letter US State code. Refer to State and Province Codes. |
accountType
|
Yes | Type of accountfor the merchant's business bank account. Type: string Valid input: - Checking - Savings |
minimalPayoutAmount
|
Yes | The minimum amount at which the customer will be paid. Until this value
is reached, funds continue to accumulate. Type: string Limits: Minimum $35. |
refundReserve
|
Yes | The amount of funds kept in the account to cover refunds. Type: string |
paymentReference
|
No | Reference text that appears on the customer's bank statement when they
are paid out. Type: string Limits: Maximum 100 alphanumeric characters |
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 |
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. |
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 |
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. |
merchantAgreementsSign
|
Yes | Container for the merchantAgreementsSign
parameters.Important: In addition to the agreements below, you must present your merchant with a link to the latest BlueSnap Merchant Terms & Conditions. The merchant must expressly consent to these terms and conditions before they begin using BlueSnap. |
merchantIp
|
Yes | Merchant's IP address. Type: string Limit: Maximum 45 characters IPv4 format: XXX.XXX.XXX.XXXIPv6 format: XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX
|
pricingAgreementDate
|
Yes | Date the merchant signed the pricing agreement. You must present the merchant with a link to the BlueSnap Pricing Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
serviceAgreementDate
|
Yes | Date the merchant signed the merchant service agreement. You must present the merchant with a link to the BlueSnap Merchant Agreement and the merchant must sign it before they begin using BlueSnap. Type: string Must be in the format MM/DD/YYYY
|
Examples
Request Examples
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"approvalTesting": "APPROVED",
"businessInfo": {
"businessTradingName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.com",
"businessType": "Public Company",
"businessCategory": "Software",
"country": "Australia",
"address": "1234 Main Street",
"suburb": "Austral",
"zip": "1111",
"email": "[email protected]",
"accountUsername": "MerchantUsername7709",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"acnOrAbn": "770770770",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"bsb": "084100",
"accountNumber": "123456789",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.com",
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "77-0770770",
"zip": "1111",
"country": "Australia",
"address": "1234 Main Street",
"email": "[email protected]",
"accountUsername": "MerchantUsername7709",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"businessTradingName": "My Business",
"acnOrAbn": "1",
"suburb": "Austral",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"bsb": "084100",
"accountNumber": "123456789",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.ca",
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "77-0770770",
"address": "1234 Main Street",
"city": "City",
"state": "ON",
"zip": "12345",
"country": "Canada",
"email": "[email protected]",
"accountUsername": "MerchantUsername7708",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"minimalPayoutAmount": "100",
"refundReserve": "100",
"payoutCurrency": "CAD",
"bankProvince": "Quebec",
"transitNumber": "1234",
"institutionNumber": "5678",
"accountNumber": "80887200792"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "Doing Business As Name Germany",
"legalName": "Legal Business Name Germany",
"productAndServiceDesc": "Products",
"phone": "12757781072",
"website": https://www.website.com,
"businessType": "Public Corporation",
"businessCategory": "Software",
"taxId": "876876876",
"address": "Lychener Str. 60",
"city": "Berlin",
"state": "BE",
"zip": "10437",
"country": "DE",
"email": [email protected],
"salesVolume": "100000",
"businessRegistrationNumber": "HRB 12217",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"minimalPayoutAmount": "100",
"refundReserve": "100",
"bankCountry": "DE",
"bic": "LMCIFR2A",
"iban": "DE7615489048180007263550158"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Bertrand",
"ownerLastName": "Russell",
"ownerDateOfBirth": "01/01/1962",
"ownerGovID": "654654-6545",
"ownerPhone": "12757781072",
"address": "1234 Main Street",
"city": "Berlin",
"zip": "10458",
"country": "DE",
"ownerPercent": "50"
},
{
"ownerFirstName": "Ludwig",
"ownerLastName": "Wittgenstein",
"ownerDateOfBirth": "03/11/1971",
"ownerGovID": "654654-6545",
"ownerPhone": "12757781072",
"address": "1234 Lein Str.",
"city": "Berlin",
"zip": "10277",
"country": "DE",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Mary",
"companyRepLastName": "Wollstonecraft",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "98798798798",
"companyRepAddress": "123 Lein Str.",
"companyRepCity": "Berlin",
"companyRepZip": "10277",
"companyRepCountry": "DE",
"companyRepPhone": "12757981072"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2023",
"pricingAgreementDate": "01/01/2023",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "Doing Business As Name GB",
"legalName": "Legal Business Name GB",
"productAndServiceDesc": "Products",
"phone": "12757781072",
"website": https://www.website.com,
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "876876876",
"address": "555 Ken Rd",
"city": "Clevedon",
"zip": "BS21 6TH",
"country": "GB",
"email": [email protected],
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"minimalPayoutAmount": "100",
"refundReserve": "100",
"accountNumber": "16623256",
"sortOrder": "987967"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Bertrand",
"ownerLastName": "Russell",
"ownerDateOfBirth": "01/06/1962",
"ownerGovID": "654654-6545",
"ownerPhone": "12757781072",
"address": "1234 Oxford Street",
"city": "Clevedon",
"zip": "BS21 6TH",
"country": "GB",
"ownerPercent": "50"
},
{
"ownerFirstName": "Ludwig",
"ownerLastName": "Wittgenstein",
"ownerDateOfBirth": "03/11/1971",
"ownerGovID": "654654-6545",
"ownerPhone": "12757781072",
"address": "1234 Livingston Street",
"city": "Clevedon",
"zip": "BS21 6TH",
"country": "GB",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Mary",
"companyRepLastName": "Wollstonecraft",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "98798798798",
"companyRepAddress": "123 Landon Street",
"companyRepCity": "Clevedon",
"companyRepZip": "BS21 6TH",
"companyRepCountry": "GB",
"companyRepPhone": "12757981072"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2023",
"pricingAgreementDate": "01/01/2023",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "Business Name",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "1555123456",
"website": "https://www.website.com",
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "770770770",
"address": "1234 Main Street",
"city": "City",
"state": "fl",
"zip": "12345",
"country": "US",
"email": "[email protected]",
"accountUsername": "MerchantUsername7707",
"salesVolume": "100000",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"routingNumber": "123456789",
"accountNumber": "123456",
"accountType": "CHECKING",
"bankState": "FL",
"payoutCurrency": "USD",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"approvalTesting": "APPROVED",
"pfToken": "5ad59e4389abba704ee2d61580d1d5cc1ba0ccf114470d404f771a198d99891b_"
}'
curl -v -X POST https: //platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"metadata": [
{
"key": "merchantId",
"value": "12345678"
}
],
"businessInfo": {
"businessName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.com",
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "77-0770770",
"zip": "1111",
"country": "Australia",
"address": "1234 Main Street",
"email": "[email protected]",
"accountUsername": "MerchantUsername7709",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"businessTradingName": "My Business",
"acnOrAbn": "1",
"suburb": "Austral",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"bsb": "084100",
"accountNumber": "123456789",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.com",
"additionalWebsites": [
"https://www.example1.com",
"https://www.example2.com"
],
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "77-0770770",
"zip": "1111",
"country": "Australia",
"address": "1234 Main Street",
"email": "[email protected]",
"accountUsername": "MerchantUsername7709",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"businessTradingName": "My Business",
"acnOrAbn": "1",
"suburb": "Austral",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"bsb": "084100",
"accountNumber": "123456789",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/new-application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"businessInfo": {
"businessName": "My Business",
"legalName": "Business LLC",
"productAndServiceDesc": "Provide a detailed description of your product or service.",
"phone": "5555555555",
"website": "https://www.website.com",
"businessType": "Public Corporation ",
"businessCategory": "Software",
"taxId": "77-0770770",
"zip": "1111",
"country": "Australia",
"address": "1234 Main Street",
"email": "[email protected]",
"accountUsername": "MerchantUsername7709",
"salesVolume": "100000",
"businessRegistrationNumber": "BR123456",
"businessTradingName": "My Business",
"acnOrAbn": "1",
"suburb": "Austral",
"averageTransactionAmount": "100",
"highestTransactionAmount": "1000",
"riskMonitoring": "No",
"riskPayment": "No",
"riskByCommission": "No"
},
"bankingInfo": {
"bsb": "084100",
"accountNumber": "123456789",
"minimalPayoutAmount": "100",
"refundReserve": "100"
},
"ownershipInfoArr": [
{
"ownerFirstName": "Chris",
"ownerLastName": "Jones",
"ownerDateOfBirth": "01/01/2000",
"ownerGovID": "1111",
"ownerPhone": "1555123456",
"address": "1234 Main Street",
"city": "Waltham",
"state": "FL",
"zip": "02453",
"country": "US",
"ownerPercent": "50"
},
{
"ownerFirstName": "Jamie",
"ownerLastName": "Doe",
"ownerDateOfBirth": "02/01/2000",
"ownerGovID": "2222",
"ownerPhone": "1555123456",
"address": "200 Broadway",
"city": "Happy",
"state": "FL",
"zip": "12345",
"country": "US",
"ownerPercent": "50"
}
],
"companyRep": {
"companyRepFirstName": "Jesse",
"companyRepLastName": "Smith",
"companyRepDateOfBirth": "12/13/1967",
"companyRepGovID": "1234",
"companyRepAddress": "123 South Street",
"companyRepCity": "Happy",
"companyRepState": "FL",
"companyRepZip": "12345",
"companyRepCountry": "US",
"companyRepPhone": "1555123456"
},
"additionalCompanyReps": [
{
"companyRepFirstName": "John",
"companyRepLastName": "Doe",
"companyRepDateOfBirth": "10/10/1970",
"companyRepGovID": "4321",
"companyRepAddress": "321 North Street",
"companyRepCity": "Jupiter",
"companyRepState": "FL",
"companyRepZip": "54321",
"companyRepCountry": "US",
"companyRepPhone": "5551239876"
}
],
"merchantAgreementsSign": {
"serviceAgreementDate": "01/01/2019",
"pricingAgreementDate": "01/01/2019",
"merchantIp": "192.168.20.15"
}
}'
Response Example
A successful request returns a 200 OK response from BlueSnap. When we complete our automated review, you receive a webhook explaining the status of your merchant approval process.
{
"sandboxId": 1682291,
"message": "success"
}