{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Create a US Customer","type":"basic","slug":"create-us-customer","excerpt":"","body":"#Create the merchant account\nWhen you have collected all your merchant information, use the Create-Merchant API request to send to BlueSnap for review.  \n\n###Create Merchant API Request\n\n`https://platform.bluesnap.com/services/2/merchants/application`\n\n####Create Merchant API Parameters for US Customers\n[block:html]\n{\n  \"html\": \"<div>\\n    <table id=\\\"section-create-merchant-api\\\" class=\\\"table table-responsive table-hover\\\">\\n        <thead>\\n\\n            <tr>\\n                <th style=\\\"width: 235px;\\\">Parameter</th>\\n                <th style=\\\"text-align:left\\\">Required</th>\\n                <th style=\\\"text-align:left\\\">Details</th>\\n            </tr>\\n        </thead>\\n\\n\\n        <!--businessInfo container-->\\n        <div>\\n            <tbody>\\n              <tr>\\n                <td><span class=\\\"api\\\">pfToken</span><br />\\n                <td>No. Include if using <a href=\\\"/docs/customer-onboarding#section-implementing-secure-customer-data-fields\\\">Secure Customer Data Fields</a></td>\\n                <td>Secure Customer Data Fields token.</td>\\n              </tr>\\n                <tr>\\n                    <td><span class=\\\"api\\\">approvalTesting</span><br />\\n                    <td>No</td>\\n                    <td>If you include this parameter, you are <b>testing</b> the customer-onboarding workflow; the customer\\n                        account is <b>NOT</b> created but you will receive an IPN and an email as you would in an actual\\n                        onboarding.<br /><br />\\n                        Refer to the <a href=\\\"http://developers.bluesnap.com/docs/customer-onboarding#section-test-the-merchant-approval-process\\\" >testing section</a>\\n                        for details on how to use this parameter.\\n                        <br />Type: <i>string</i> <br /><br />Valid values:\\n                        <ul>\\n                            <li><span class=\\\"api\\\">APPROVED</li>\\n                            <li><span class=\\\"api\\\">RECOMMEND_APPROVE</li>\\n                            <li><span class=\\\"api\\\">RECOMMEND_DECLINE</li>\\n                            <li><span class=\\\"api\\\">DECLINE</li>\\n                        </ul>\\n                    </td>\\n              </tr>\\n              \\n                     <tr>\\n                   <td><span class=\\\"api\\\">defaultIPN</span><br />\\n                    <td>No</td>\\n                    <td>If this is included, this URL will be used for receiving <a href=\\\"https://support.bluesnap.com/docs/ipns-name-reference#default\\\">the Charge IPN</td>\\n              </tr>\\n              \\n                <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#businessInfo-rows\\\" aria-expanded=\\\"false\\\"\\n                    aria-controls=\\\"businessInfo-rows\\\">\\n                    <td><span class=\\\"api\\\">businessInfo</span><br />\\n                        <font size=\\\"1\\\" color=\\\"blue\\\">\\n                            (Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Container for the <span class=\\\"api\\\">businessInfo</span> parameters</td>\\n                </tr>\\n            </tbody>\\n            <tbody id=\\\"businessInfo-rows\\\" class=\\\"collapse\\\">\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">businessName</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Customer-facing name of the business<br />Type: <i>string</i> <br />Limit: Maximum\\n                        60 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">legalName</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Legal name of the business<br />Type: <i>string</i> <br />Limit: Maximum 60\\n                        characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">productAndServiceDesc</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Provides a detailed description of the business including information about\\n                        customers and the merchant's products, services, or both\\n                        <br />Type: <i>string</i> <br />Limit: Maximum 1500\\n                        characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">phone</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company phone number<br />Type: <i>string</i> <br />For US merchants: 10 digits\\n                        with no spaces, dashes, or any other characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">website</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Main website for the merchant's business<br />Type: <i>string</i> <br />Limit:\\n                        Maximum 100 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">businessType</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Type of business<br />Valid values:\\n                        <ul>\\n                            <li><span class=\\\"api\\\">Limited Liability</span></li>\\n                            <li><span class=\\\"api\\\">Non-profit</span></li>\\n                            <li><span class=\\\"api\\\">Partnership</span></li>\\n                            <li><span class=\\\"api\\\">Private Corporation</span></li>\\n                            <li><span class=\\\"api\\\">Public Corporation</span></li>\\n                            <li><span class=\\\"api\\\">Sole Proprietorship</span></li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">businessCategory</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Category of the business<br />Valid values:\\n                        <ul>\\n                            <li><span class=\\\"api\\\">Business Services</span></li>\\n                            <li><span class=\\\"api\\\">Education</span></li>\\n                            <li><span class=\\\"api\\\">Non-profit</span></li>\\n                            <li><span class=\\\"api\\\">Personal Services</span></li>\\n                          <li><span class=\\\"api\\\">Pharmacy</span></li>\\n                            <li><span class=\\\"api\\\">Physical Goods</span></li>\\n                            <li><span class=\\\"api\\\">Software</span></li>\\n                            <li><span class=\\\"api\\\">Travel</span></li>\\n                            <li><span class=\\\"api\\\">Other</span></li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">taxId</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's tax ID number<br />Type: <i>alphanumeric</i> <br />9 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">address</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's business address. Must be a registered business address.<br />Type: <i>string</i> <br />Limit: Maximum 40\\n                        characters\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">city</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's business address city<br />Type: <i>string</i> <br />Limit: Maximum 25\\n                        characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">state</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's business address state<br />Type: <i>string</i> <br />Limit: 2-letter\\n                        code. (Refer to <a href=\\\"http://developers.bluesnap.com/docs/state-and-province-codes\\\"\\n                            target=\\\"_blank\\\">State Codes</a>.)</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">zip</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's business address zip code<br />Type: <i>string</i> <br />Limit: Maximum\\n                        10 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">country</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's business address country<br />Type: <i>string</i> <br />Limit: 2-letter\\n                        code <br />For Great Britain, Wales, or Scotland, use <span class=\\\"api\\\"><font size=\\\"3\\\">GB</font></span>.  For all other countries, refer to <a href=\\\"http://developers.bluesnap.com/docs/country-codes\\\"\\n                            target=\\\"_blank\\\">Country\\n                            Codes</a>.</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">email</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Email address of the entity to receive all communications.\\n                        <br />Type: <i>string</i> <br />Limits:\\n                        <ul>\\n                            <li>Minimum 7 characters</li>\\n                            <li>Maximum 100 characters</li>\\n                          \\t<li>\\\"+\\\" character not permitted</li>\\t\\n                        </ul>\\n                        <p><b>Note:</b> Once the application is approved, an access URL for your BlueSnap Production account will be sent to this email address.</p>\\n                    </td>\\n\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">accountUsername</span></td>\\n                    <td class=\\\"left\\\">Required only for testing.</td>\\n                    <td class=\\\"left\\\">Merchant's account username. This is for the BlueSnap console credentials for the\\n                        merchant.<br />Type: <i>alphanumeric</i><br />Limits: <ul>\\n                            <li>Maximum 18 characters</li>\\n                            <li>Must be unique</li>\\n                            <li>Only accepts the following special characters:<br />\\n                                <span class=\\\"api\\\"> - . _ ( ) :</span></li></ul></td>\\n                </tr>\\n\\n\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">salesVolume</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's current annual sales volume (Must be in USD)<br />Type: <i>numeric</i><br /> Limit: Value must be greater than zero</td>\\n                </tr>\\n            </tbody>\\n        </div>\\n\\n        <!--bankingInfo container-->\\n        <div>\\n            <tbody>\\n                <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#bankingInfo-rows\\\" aria-expanded=\\\"false\\\"\\n                    aria-controls=\\\"bankingInfo-rows\\\">\\n                    <td><span class=\\\"api\\\">bankingInfo</span><br />\\n                        <font size=\\\"1\\\" color=\\\"blue\\\">\\n                            (Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Container for the <span class=\\\"api\\\">bankingInfo</span> parameters</td>\\n                </tr>\\n            </tbody>\\n            <tbody id=\\\"bankingInfo-rows\\\" class=\\\"collapse\\\">\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">routingNumber</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Routing number for the merchant's business bank account<br />Type: <i>string</i>\\n                        <br />Limit: Maximum 9 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">accountNumber</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Account number for the merchant's business bank account<br />Type: <i>string</i>\\n                        <br />Limit: Maximum 17 characters</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">bankState</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's bank address state<br />Type: <i>string</i> <br />Limit: 2-letter\\n                        code\\n                        (Refer to <a href=\\\"http://developers.bluesnap.com/docs/state-and-province-codes\\\"\\n                            target=\\\"_blank\\\">State and Province Codes</a>.)</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">accountType</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Type of accountfor the merchant's business bank account<br />Type: <i>string</i>\\n                        <br />Valid values:<ul>\\n                            <li>Checking</li>\\n                            <li>Savings</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">minimalPayoutAmount</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">The minimum amount at which the customer will be paid. Until this value is reached,\\n                        funds continue to accumulate.<br />Type: <i>string</i>\\n                        <br />Limit: Minimum $35.</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">refundReserve</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">The amount of funds kept in the account to cover refunds.<br />Type: <i>string</i>\\n                        <br />Limit: Minimum $100</td>\\n                </tr>\\n              <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">paymentReference</span></td>\\n                <td class=\\\"left\\\">No</td>\\n                <td class=\\\"left\\\">\\t\\nReference text that appears on the customer's bank statement when they are paid out. <br />Type: <i>string</i>\\n                  <br />Limit: Maximum 100 alphanumeric characters</td>\\n              </tr>   \\n            </tbody>\\n        </div>\\n\\n        <!--ownershipInfoArr container-->\\n        <div>\\n            <tbody>\\n                <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#ownershipInfoArr-rows\\\" aria-expanded=\\\"false\\\"\\n                    aria-controls=\\\"ownershipInfoArr-rows\\\">\\n                    <td><span class=\\\"api\\\">ownershipInfoArr</span><br />\\n                        <font size=\\\"1\\\" color=\\\"blue\\\">\\n                            (Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes,&nbsp;if anyone&nbsp;owns at&nbsp;least&nbsp;25%.</td>\\n                    <td class=\\\"left\\\">Container for the <span class=\\\"api\\\">ownershipInfoArr</span>\\n                        parameters\\n                        <p>\\n                            <ul>\\n                                <li>An owner must have at least 25% ownership of the company. You can have up to 4\\n                                    owners.</li>\\n                                <li>If no one person owns at least 25%, do <b>not</b> include this section; use <span\\n                                        class=\\\"api\\\">companyRep</span> instead.</li>\\n                            </ul>\\n                        </p>\\n                        <p><b>Note: </b>The information provided in this section should be the personal information of\\n                            the owner, <b>not</b> for the business.\\n                            For example, provide the owner's address, not the business address.</p>\\n                    </td>\\n                </tr>\\n            </tbody>\\n\\n            <tbody id=\\\"ownershipInfoArr-rows\\\" class=\\\"collapse\\\">\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">ownerFirstName</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's first name<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">ownerLastName</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's last name<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">ownerDateOfBirth</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">The business owner's date of birth. <br />Type: <i>numeric</i> <br />Limit: Must be\\n                        in the format of <span class=\\\"api\\\">MM/DD/YYYY</span></td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">ownerGovID</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's <a href=\\\"/docs/government-id-types\\\">government ID number</a><br />Type:\\n                        <i>numeric</i>\\n                        <br />Limit:\\n                        <ul>\\n                            <li>no special characters</li>\\n                            <li>US: Last 4 of the SSN</li>\\n                            <li>Other: Maximum 50</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">ownerPhone</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's personal phone number<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>No spaces, dashes, or any other characters</li>\\n                            <li>US: Maximum 10</li>\\n                            <li>Other: Maximum 15</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">address</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's home street address<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">city</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's home address city<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 25</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">state</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Only&nbsp;if <span class=\\\"api\\\">companyRepCountry</span> is&nbsp;US&nbsp;or&nbsp;CA\\n                    </td>\\n                    <td class=\\\"left\\\">Business owner's home address state/province/county/region<br />Type:\\n                        <i>string</i><br />Limit:\\n                        2-letter\\n                        code. (For US or CA, refer to <a\\n                            href=\\\"http://developers.bluesnap.com/docs/state-and-province-codes\\\" target=\\\"_blank\\\">State\\n                            and Province Codes</a>.)</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">zip</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's home address zip/postal code<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 10</li>\\n                            <li>Other: Maximum 15</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">country</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Business owner's home address country<br />Type: <i>string</i> <br />Limit: 2-letter\\n                        code <br />For Great Britain, Wales, or Scotland, use <span class=\\\"api\\\"><font size=\\\"3\\\">GB</font></span>.  For all other countries, refer to <a href=\\\"http://developers.bluesnap.com/docs/country-codes\\\"\\n                            target=\\\"_blank\\\">Country\\n                            Codes</a>.</td>\\n                </tr>\\n\\n            </tbody>\\n        </div>\\n\\n        <!--companyRep container-->\\n        <div>\\n            <tbody>\\n                <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#companyRep-rows\\\" aria-expanded=\\\"false\\\"\\n                    aria-controls=\\\"companyRep-rows\\\">\\n                    <td><span class=\\\"api\\\">companyRep</span><br />\\n                        <font size=\\\"1\\\" color=\\\"blue\\\">\\n                            (Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Container for the <span class=\\\"api\\\">companyRep</span> parameters\\n                        <p></p>\\n                        <p>Information of the person who oversees the business and has significant control over the\\n                            entity.\\n                            For example, the CEO, COO, or CFO.<br /></p>\\n\\n                        <p><b>Note: </b>Information provided in this section should be the personal information of the\\n                            representative, not for the business.\\n                            For example, provide the representative's address and phone number, not the business address\\n                            and\\n                            phone number.</p>\\n                    </td>\\n                </tr>\\n            </tbody>\\n\\n            <tbody id=\\\"companyRep-rows\\\" class=\\\"collapse\\\">\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepFirstName</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's first name<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepLastName</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's last name<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepDateOfBirth</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's date of birth. <br />Type: <i>numeric</i> <br />Limit:\\n                        Must be in the format of <span class=\\\"api\\\">MM/DD/YYYY</span></td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepGovID</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's <a href=\\\"/docs/government-id-types\\\">government ID number</a><br />Type:\\n                        <i>alphanumeric</i>\\n                        <br />Limit:\\n                        <ul>\\n                            <li>no special characters</li>\\n                            <li>US: Last 4 of the SSN</li>\\n                            <li>Other: Maximum 50</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepPhone</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's personal phone number<br />Type: <i>string</i>\\n                        <br />Limit:\\n                        <ul>\\n                            <li>No spaces, dashes, or any other characters</li>\\n                            <li>US: Maximum 10</li>\\n                            <li>Other: Maximum 15</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepAddress</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's home street address<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 40</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepCity</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's home address city<br />Type: <i>string</i> <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 25</li>\\n                            <li>Other: Maximum 60</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepState</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Only&nbsp;if <span class=\\\"api\\\">companyRepCountry</span> is&nbsp;US&nbsp;or&nbsp;CA\\n                    </td>\\n                    <td class=\\\"left\\\">Company representative's home address state/province/county/region<br />Type:\\n                        <i>string</i><br />Limit: 2-letter\\n                        code. (For US and CA, refer to <a\\n                            href=\\\"http://developers.bluesnap.com/docs/state-and-province-codes\\\" target=\\\"_blank\\\">State\\n                            and Province Codes</a>.)</td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepZip</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's home address zip or postal code<br />Type: <i>string</i>\\n                        <br />Limit:\\n                        <ul>\\n                            <li>US: Maximum 10</li>\\n                            <li>Other: Maximum 15</li>\\n                        </ul>\\n                    </td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 40px\\\">\\n                        <span class=\\\"api\\\">companyRepCountry</span>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Company representative's home address country<br />Type: <i>string</i> <br />Limit: 2-letter\\n                        code <br />For Great Britain, Wales, or Scotland, use <span class=\\\"api\\\"><font size=\\\"3\\\">GB</font></span>.  For all other countries, refer to <a href=\\\"http://developers.bluesnap.com/docs/country-codes\\\"\\n                            target=\\\"_blank\\\">Country\\n                            Codes</a>.)</td>\\n                </tr>\\n\\n\\n            </tbody>\\n        </div>\\n\\n        <!--merchantAgreementsSign container-->\\n        <div>\\n            <tbody>\\n                <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#merchantAgreementsSign-rows\\\"\\n                    aria-expanded=\\\"false\\\" aria-controls=\\\"merchantAgreementsSign-rows\\\">\\n                    <td><span class=\\\"api\\\">merchantAgreementsSign</span><br />\\n                        <font size=\\\"1\\\" color=\\\"blue\\\">\\n                            (Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font>\\n                    </td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">\\n                        <p>Container for the <span class=\\\"api\\\">merchantAgreementsSign</span> parameters.</p>\\n                        <p><b>Important</b>: In addition to the agreements below, you must present your merchant with a link to the latest <b><i>BlueSnap Merchant Terms & Conditions</i></b> (available <a href=\\\"http://home.bluesnap.com/ecommerce/contracts/\\\" target=\\\"_blank\\\"><b>here</b></a>) and the merchant must expressly consent to it before they begin using BlueSnap.</p></td>\\n                </tr>\\n            </tbody>\\n\\n            <tbody id=\\\"merchantAgreementsSign-rows\\\" class=\\\"collapse\\\">\\n\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 30px\\\"><span class=\\\"api\\\">serviceAgreementDate</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">\\n                        <p>Date the merchant signed the merchant service agreement.</p>\\n                        <p>You must present the merchant with a link to the <b><i>BlueSnap Merchant Agreement</i></b> (available <a href=\\\"https://home.bluesnap.com/wp-content/uploads/2020/12/BlueSnap-Merchant-Agt-ElectronicFinal.v5.12.Dec2020.pdf\\\" target=\\\"_blank\\\"><b>here</b></a>) and the merchant must sign it before they begin using BlueSnap.</p>\\n                      <p>Type: <i>string</i> <br />Must be in the format <span class=\\\"api\\\">MM/DD/YYYY</span></p></td></tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 30px\\\"><span class=\\\"api\\\">pricingAgreementDate</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                  <td class=\\\"left\\\"><p>Date the merchant signed the pricing agreement.</p>\\n                    <p>You must present the merchant with a link to the <b><i>BlueSnap Pricing Agreement</i></b> and the merchant must sign it before they begin using BlueSnap.</p>\\n                      <p>Type: <i>string</i> <br />Must\\n                        be in the format <span class=\\\"api\\\">MM/DD/YYYY</span></p></td>\\n                </tr>\\n                <tr bgcolor=\\\"#f8f8f8\\\">\\n                    <td style=\\\"padding-left: 30px\\\"><span class=\\\"api\\\">merchantIp</span></td>\\n                    <td class=\\\"left\\\">Yes</td>\\n                    <td class=\\\"left\\\">Merchant's IP address<br />Type: <i>string</i><br>Limit: Maximum 45 characters\\n                      <br>Format: IPv4 <span class=\\\"api\\\">xxx.xxx.xxx.xxx</span>\\n                      <br>IPv6 <span class=\\\"api\\\">xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx</span>\\n\\n          </p></td>\\n                </tr>\\n            </tbody>\\n        </div>\\n    </table>\\n</div>\\n\\n<style>\\n    .api {\\n        font-family: 'Courier New';\\n        font-weight: 900;\\n    }\\n\\n    .left {\\n        display: table-cell;\\n        text-align: left;\\n    }\\n\\n    table td {\\n        display: table-cell;\\n        vertical-align: top;\\n    }\\n\\n    table th {\\n        display: table-cell;\\n        vertical-align: top;\\n    }\\n\\n    tbody.collapse.in {\\n        display: table-row-group;\\n    }\\n</style>\"\n}\n[/block]\n####Create Merchant API Request examples\nHere are some examples.\n**Note:**  Before using Test mode, review the [Customer Onboarding steps](https://developers.bluesnap.com/docs/customer-onboarding#section-process).     \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"approvalTesting\\\": \\\"APPROVED\\\",\\n  \\\"businessInfo\\\": {\\n    \\\"businessName\\\": \\\"Business Name\\\",\\n    \\\"legalName\\\": \\\"Business LLC\\\",\\n    \\\"productAndServiceDesc\\\": \\\"Provide a detailed description of your product or service.\\\",\\n    \\\"phone\\\": \\\"5555555555\\\",\\n    \\\"website\\\": \\\"https://www.website.com\\\",\\n    \\\"businessType\\\": \\\"Public Corporation \\\",\\n    \\\"businessCategory\\\": \\\"Software\\\",\\n    \\\"taxId\\\": \\\"77-0770770\\\",\\n    \\\"address\\\": \\\"1234 Main Street\\\",\\n    \\\"city\\\": \\\"City\\\",\\n    \\\"state\\\": \\\"fl\\\",\\n    \\\"zip\\\": \\\"12345\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"email\\\": \\\"first.last:::at:::merchant.com\\\",\\n    \\\"accountUsername\\\": \\\"MerchantUsername7707\\\",\\n    \\\"salesVolume\\\": \\\"100000\\\"\\n  },\\n  \\\"bankingInfo\\\": {\\n    \\\"routingNumber\\\": \\\"123456789\\\",\\n    \\\"accountNumber\\\": \\\"123456\\\",\\n    \\\"accountType\\\": \\\"CHECKING\\\",\\n    \\\"bankState\\\": \\\"FL\\\",\\n    \\\"payoutCurrency\\\": \\\"USD\\\",\\n    \\\"minimalPayoutAmount\\\": \\\"100\\\",\\n    \\\"refundReserve\\\": \\\"100\\\"\\n  },\\n  \\\"ownershipInfoArr\\\": [\\n    {\\n      \\\"ownerFirstName\\\": \\\"Chris\\\",\\n      \\\"ownerLastName\\\": \\\"Jones\\\",\\n      \\\"ownerDateOfBirth\\\": \\\"01/01/2000\\\",\\n      \\\"ownerGovID\\\": \\\"1111\\\",\\n      \\\"ownerPhone\\\": \\\"15551234567\\\",\\n      \\\"address\\\": \\\"1234 Main Street\\\",\\n      \\\"city\\\": \\\"Waltham\\\",\\n      \\\"state\\\": \\\"FL\\\",\\n      \\\"zip\\\": \\\"02453\\\",\\n      \\\"country\\\": \\\"US\\\"\\n    },\\n    {\\n      \\\"ownerFirstName\\\": \\\"Jamie\\\",\\n      \\\"ownerLastName\\\": \\\"Doe\\\",\\n      \\\"ownerDateOfBirth\\\": \\\"02/01/2000\\\",\\n      \\\"ownerGovID\\\": \\\"2222\\\",\\n      \\\"ownerPhone\\\": \\\"15551234567\\\",\\n      \\\"address\\\": \\\"200 Broadway\\\",\\n      \\\"city\\\": \\\"Happy\\\",\\n      \\\"state\\\": \\\"FL\\\",\\n      \\\"zip\\\": \\\"12345\\\",\\n      \\\"country\\\": \\\"US\\\"\\n    }\\n  ],\\n  \\\"companyRep\\\": {\\n    \\\"companyRepFirstName\\\": \\\"Jesse\\\",\\n    \\\"companyRepLastName\\\": \\\"Smith\\\",\\n    \\\"companyRepDateOfBirth\\\": \\\"12/13/1967\\\",\\n    \\\"companyRepGovID\\\": \\\"1234\\\",\\n    \\\"companyRepAddress\\\": \\\"123 South Street\\\",\\n    \\\"companyRepCity\\\": \\\"Happy\\\",\\n    \\\"companyRepState\\\": \\\"FL\\\",\\n    \\\"companyRepZip\\\": \\\"12345\\\",\\n    \\\"companyRepCountry\\\": \\\"US\\\",\\n    \\\"companyRepPhone\\\": \\\"15551234567\\\"\\n  },\\n  \\\"merchantAgreementsSign\\\": {\\n    \\\"serviceAgreementDate\\\": \\\"01/01/2019\\\",\\n    \\\"pricingAgreementDate\\\": \\\"01/01/2019\\\",\\n    \\\"merchantIp\\\": \\\"192.168.20.15\\\"\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Create Merchant: Test mode\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"businessInfo\\\": {\\n    \\\"businessName\\\": \\\"Business Name\\\",\\n    \\\"legalName\\\": \\\"Business LLC\\\",\\n    \\\"productAndServiceDesc\\\": \\\"Provide a detailed description of your product or service.\\\",\\n    \\\"phone\\\": \\\"5555555555\\\",\\n    \\\"website\\\": \\\"https://www.website.com\\\",\\n    \\\"businessType\\\": \\\"Public Corporation \\\",\\n    \\\"businessCategory\\\": \\\"Software\\\",\\n    \\\"taxId\\\": \\\"77-0770770\\\",\\n    \\\"address\\\": \\\"1234 Main Street\\\",\\n    \\\"city\\\": \\\"City\\\",\\n    \\\"state\\\": \\\"fl\\\",\\n    \\\"zip\\\": \\\"12345\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"accountUsername\\\": \\\"MerchantUsername7707\\\",\\n    \\\"salesVolume\\\": \\\"100000\\\"\\n  },\\n  \\\"bankingInfo\\\": {\\n    \\\"routingNumber\\\": \\\"123456789\\\",\\n    \\\"accountNumber\\\": \\\"123456\\\",\\n    \\\"accountType\\\": \\\"CHECKING\\\",\\n    \\\"bankState\\\": \\\"FL\\\",\\n    \\\"payoutCurrency\\\": \\\"USD\\\",\\n    \\\"minimalPayoutAmount\\\": \\\"100\\\",\\n    \\\"refundReserve\\\": \\\"100\\\"\\n  },\\n  \\\"ownershipInfoArr\\\": [\\n    {\\n      \\\"ownerFirstName\\\": \\\"Chris\\\",\\n      \\\"ownerLastName\\\": \\\"Jones\\\",\\n      \\\"ownerDateOfBirth\\\": \\\"01/01/2000\\\",\\n      \\\"ownerGovID\\\": \\\"1111\\\",\\n      \\\"ownerPhone\\\": \\\"15551234567\\\",\\n      \\\"address\\\": \\\"1234 Main Street\\\",\\n      \\\"city\\\": \\\"Waltham\\\",\\n      \\\"state\\\": \\\"FL\\\",\\n      \\\"zip\\\": \\\"02453\\\",\\n      \\\"country\\\": \\\"US\\\"\\n    },\\n    {\\n      \\\"ownerFirstName\\\": \\\"Jamie\\\",\\n      \\\"ownerLastName\\\": \\\"Doe\\\",\\n      \\\"ownerDateOfBirth\\\": \\\"02/01/2000\\\",\\n      \\\"ownerGovID\\\": \\\"2222\\\",\\n      \\\"ownerPhone\\\": \\\"15551234567\\\",\\n      \\\"address\\\": \\\"200 Broadway\\\",\\n      \\\"city\\\": \\\"Happy\\\",\\n      \\\"state\\\": \\\"FL\\\",\\n      \\\"zip\\\": \\\"12345\\\",\\n      \\\"country\\\": \\\"US\\\"\\n    }\\n  ],\\n  \\\"companyRep\\\": {\\n    \\\"companyRepFirstName\\\": \\\"Jesse\\\",\\n    \\\"companyRepLastName\\\": \\\"Smith\\\",\\n    \\\"companyRepDateOfBirth\\\": \\\"12/13/1967\\\",\\n    \\\"companyRepGovID\\\": \\\"1234\\\",\\n    \\\"companyRepAddress\\\": \\\"123 South Street\\\",\\n    \\\"companyRepCity\\\": \\\"Happy\\\",\\n    \\\"companyRepState\\\": \\\"FL\\\",\\n    \\\"companyRepZip\\\": \\\"12345\\\",\\n    \\\"companyRepCountry\\\": \\\"US\\\",\\n    \\\"companyRepPhone\\\": \\\"15551234567\\\"\\n  },\\n  \\\"merchantAgreementsSign\\\": {\\n    \\\"serviceAgreementDate\\\": \\\"01/01/2019\\\",\\n    \\\"pricingAgreementDate\\\": \\\"01/01/2019\\\",\\n    \\\"merchantIp\\\": \\\"192.168.20.15\\\"\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Live mode\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"approvalTesting\\\": \\\"APPROVED\\\",\\n  \\\"pfToken\\\": \\\"5ad59e4389abba704ee2d61580d1d5cc1ba0ccf114470d404f771a198d99891b_\\\"\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with Secure Customer Data Fields token\"\n    }\n  ]\n}\n[/block]\n##Response\nIf your request is successful, you receive a `200 OK` response from BlueSnap. When our automated review is complete, you receive an IPN explaining the status of your merchant approval process.  \n\n##What's next?\nReturn to [Step 3](https://developers.bluesnap.com/v8976-Basics/docs/customer-onboarding#section-step-3-bluesnap-reviews-the-merchant-account) in the Customer Onboarding process to continue.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60f9b8e6969e03006edca931","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Basics","version_clean":"8976.0.0-Basics","codename":"3.39 Release","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60f9b8e6969e03006edca8eb","60f9b8e6969e03006edca8ec","60f9b8e6969e03006edca8ed","60f9b8e6969e03006edca8ee","60f9b8e6969e03006edca8ef","60f9b8e6969e03006edca8f0","5beb278ac442ab0213f00990","60f9b8e6969e03006edca8f1","5c3f542c12c4ac004bc51718","60f9b8e6969e03006edca8f2","5df806ccecebde0059f17225","5dfa8a8f340c2b007418eb8a","60f9b8e6969e03006edca8f3","5e597199fd2b0200117c2c1c"],"_id":"60f9b8e6969e03006edca94a","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"609978ff6a29a202e39f0aa5","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Partners","slug":"partners","order":4,"from_sync":false,"reference":false,"_id":"60f9b8e6969e03006edca8f2","project":"57336fd5a6a9c40e00e13a0b","version":"60f9b8e6969e03006edca94a","createdAt":"2019-03-20T19:00:10.025Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-07-17T14:59:51.388Z","__v":0,"parentDoc":null}

Quickstart

API Usage

Mobile

Marketplace/Split Payments

Partners

SDKs

Reference

Guides

Create a US Customer

Create the merchant account

When you have collected all your merchant information, use the Create-Merchant API request to send to BlueSnap for review.

Create Merchant API Request

https://platform.bluesnap.com/services/2/merchants/application

Create Merchant API Parameters for US Customers

Parameter Required Details
pfToken
No. Include if using Secure Customer Data Fields Secure Customer Data Fields token.
approvalTesting
No If you include this parameter, you are testing the customer-onboarding workflow; the customer account is NOT created but you will receive an IPN and an email as you would in an actual onboarding.

Refer to the testing section for details on how to use this parameter.
Type: string

Valid values:
  • APPROVED
  • RECOMMEND_APPROVE
  • RECOMMEND_DECLINE
  • DECLINE
defaultIPN
No If this is included, this URL will be used for receiving the Charge IPN
businessName Yes Customer-facing name of the business
Type: string
Limit: Maximum 60 characters
legalName Yes Legal name of the business
Type: string
Limit: Maximum 60 characters
productAndServiceDesc Yes Provides a detailed description of the business including information about customers and the merchant's products, services, or both
Type: string
Limit: Maximum 1500 characters
phone Yes Company phone number
Type: string
For US merchants: 10 digits with no spaces, dashes, or any other characters
website Yes Main website for the merchant's business
Type: string
Limit: Maximum 100 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
  • Education
  • Non-profit
  • Personal Services
  • Pharmacy
  • Physical Goods
  • Software
  • Travel
  • Other
taxId Yes Merchant's tax ID number
Type: alphanumeric
9 characters
address Yes Merchant's business address. Must be a registered business address.
Type: string
Limit: Maximum 40 characters
city Yes Merchant's business address city
Type: string
Limit: Maximum 25 characters
state Yes Merchant's business address state
Type: string
Limit: 2-letter code. (Refer to State Codes.)
zip Yes Merchant's business address zip code
Type: string
Limit: Maximum 10 characters
country Yes Merchant's business address country
Type: string
Limit: 2-letter code
For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.
email Yes Email address of the entity to receive all communications.
Type: string
Limits:
  • Minimum 7 characters
  • Maximum 100 characters
  • "+" character not permitted

Note: Once the application is approved, an access URL for your BlueSnap Production account will be sent to this email address.
accountUsername Required only for testing. Merchant's account username. This is for the BlueSnap console 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
Limit: Value must be greater than zero
routingNumber Yes Routing number for the merchant's business bank account
Type: string
Limit: Maximum 9 characters
accountNumber Yes Account number for the merchant's business bank account
Type: string
Limit: Maximum 17 characters
bankState Yes Merchant's bank address state
Type: string
Limit: 2-letter code (Refer to State and Province Codes.)
accountType Yes Type of accountfor the merchant's business bank account
Type: string
Valid values:
  • 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
Limit: Minimum $35.
refundReserve Yes The amount of funds kept in the account to cover refunds.
Type: string
Limit: Minimum $100
paymentReference No Reference text that appears on the customer's bank statement when they are paid out.
Type: string
Limit: Maximum 100 alphanumeric characters
ownerFirstName Yes Business owner's first name
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
ownerLastName Yes Business owner's last name
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
ownerDateOfBirth Yes The business owner's date of birth.
Type: numeric
Limit: Must be in the format of MM/DD/YYYY
ownerGovID Yes Business owner's government ID number
Type: numeric
Limit:
  • no special characters
  • US: Last 4 of the SSN
  • Other: Maximum 50
ownerPhone Yes Business owner's personal phone number
Type: string
Limit:
  • No spaces, dashes, or any other characters
  • US: Maximum 10
  • Other: Maximum 15
address Yes Business owner's home street address
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
city Yes Business owner's home address city
Type: string
Limit:
  • US: Maximum 25
  • Other: Maximum 60
state Only if companyRepCountry is US or CA Business owner's home address state/province/county/region
Type: string
Limit: 2-letter code. (For US or CA, refer to State and Province Codes.)
zip Yes Business owner's home address zip/postal code
Type: string
Limit:
  • US: Maximum 10
  • Other: Maximum 15
country Yes Business owner's home address country
Type: string
Limit: 2-letter code
For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.
companyRepFirstName Yes Company representative's first name
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
companyRepLastName Yes Company representative's last name
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
companyRepDateOfBirth Yes Company representative's date of birth.
Type: numeric
Limit: Must be in the format of MM/DD/YYYY
companyRepGovID Yes Company representative's government ID number
Type: alphanumeric
Limit:
  • no special characters
  • US: Last 4 of the SSN
  • Other: Maximum 50
companyRepPhone Yes Company representative's personal phone number
Type: string
Limit:
  • No spaces, dashes, or any other characters
  • US: Maximum 10
  • Other: Maximum 15
companyRepAddress Yes Company representative's home street address
Type: string
Limit:
  • US: Maximum 40
  • Other: Maximum 60
companyRepCity Yes Company representative's home address city
Type: string
Limit:
  • US: Maximum 25
  • Other: Maximum 60
companyRepState Only if companyRepCountry is US or CA Company representative's home address state/province/county/region
Type: string
Limit: 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
Limit:
  • US: Maximum 10
  • Other: Maximum 15
companyRepCountry Yes Company representative's home address country
Type: string
Limit: 2-letter code
For Great Britain, Wales, or Scotland, use GB. For all other countries, refer to Country Codes.)
serviceAgreementDate Yes

Date the merchant signed the merchant service agreement.

You must present the merchant with a link to the BlueSnap Merchant Agreement (available here) and the merchant must sign it before they begin using BlueSnap.

Type: string
Must be in the format MM/DD/YYYY

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
merchantIp Yes Merchant's IP address
Type: string
Limit: Maximum 45 characters
Format: IPv4 xxx.xxx.xxx.xxx
IPv6 xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx

Create Merchant API Request examples

Here are some examples.
Note: Before using Test mode, review the Customer Onboarding steps.

Create Merchant: Test mode
Live mode
with Secure Customer Data Fields token
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "approvalTesting": "APPROVED",
  "businessInfo": {
    "businessName": "Business Name",
    "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",
    "address": "1234 Main Street",
    "city": "City",
    "state": "fl",
    "zip": "12345",
    "country": "US",
    "email": "[email protected]",
    "accountUsername": "MerchantUsername7707",
    "salesVolume": "100000"
  },
  "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": "15551234567",
      "address": "1234 Main Street",
      "city": "Waltham",
      "state": "FL",
      "zip": "02453",
      "country": "US"
    },
    {
      "ownerFirstName": "Jamie",
      "ownerLastName": "Doe",
      "ownerDateOfBirth": "02/01/2000",
      "ownerGovID": "2222",
      "ownerPhone": "15551234567",
      "address": "200 Broadway",
      "city": "Happy",
      "state": "FL",
      "zip": "12345",
      "country": "US"
    }
  ],
  "companyRep": {
    "companyRepFirstName": "Jesse",
    "companyRepLastName": "Smith",
    "companyRepDateOfBirth": "12/13/1967",
    "companyRepGovID": "1234",
    "companyRepAddress": "123 South Street",
    "companyRepCity": "Happy",
    "companyRepState": "FL",
    "companyRepZip": "12345",
    "companyRepCountry": "US",
    "companyRepPhone": "15551234567"
  },
  "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/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": "5555555555",
    "website": "https://www.website.com",
    "businessType": "Public Corporation ",
    "businessCategory": "Software",
    "taxId": "77-0770770",
    "address": "1234 Main Street",
    "city": "City",
    "state": "fl",
    "zip": "12345",
    "country": "US",
    "email": "[email protected]",
    "accountUsername": "MerchantUsername7707",
    "salesVolume": "100000"
  },
  "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": "15551234567",
      "address": "1234 Main Street",
      "city": "Waltham",
      "state": "FL",
      "zip": "02453",
      "country": "US"
    },
    {
      "ownerFirstName": "Jamie",
      "ownerLastName": "Doe",
      "ownerDateOfBirth": "02/01/2000",
      "ownerGovID": "2222",
      "ownerPhone": "15551234567",
      "address": "200 Broadway",
      "city": "Happy",
      "state": "FL",
      "zip": "12345",
      "country": "US"
    }
  ],
  "companyRep": {
    "companyRepFirstName": "Jesse",
    "companyRepLastName": "Smith",
    "companyRepDateOfBirth": "12/13/1967",
    "companyRepGovID": "1234",
    "companyRepAddress": "123 South Street",
    "companyRepCity": "Happy",
    "companyRepState": "FL",
    "companyRepZip": "12345",
    "companyRepCountry": "US",
    "companyRepPhone": "15551234567"
  },
  "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/application \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "approvalTesting": "APPROVED",
  "pfToken": "5ad59e4389abba704ee2d61580d1d5cc1ba0ccf114470d404f771a198d99891b_"
}'

Response

If your request is successful, you receive a 200 OK response from BlueSnap. When our automated review is complete, you receive an IPN explaining the status of your merchant approval process.

What's next?

Return to Step 3 in the Customer Onboarding process to continue.