{"_id":"5cf953591d2ee10039b264d6","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5beb278ac442ab0213f009cf","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z","categories":["5c6c238ff7d548003953555d","5c6c238ff7d548003953555e","5c6c238ff7d548003953555f","5c6c238ff7d5480039535560","5c6c238ff7d5480039535561","5c6c238ff7d5480039535562","5beb278ac442ab0213f00990","5c6c238ff7d5480039535563","5c3f542c12c4ac004bc51718","5c928dba4aa821001ae4f050"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Main","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"category":{"_id":"5c928dba4aa821001ae4f050","project":"57336fd5a6a9c40e00e13a0b","version":"5c6c238ff7d54800395355a0","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-03-20T19:00:10.025Z","from_sync":false,"order":4,"slug":"partners","title":"Partners"},"user":"5beb1b96bc2003003ecd645e","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-06T17:54:33.823Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"##Before you begin\n*  You must have worked with a BlueSnap Implementation Engineer to register your platform with us.\n*  You must be set up to receive IPNs. To enable IPNs, you must set up a server and URL on your side and then configure IPNs in your BlueSnap account. Refer to [Setting up IPNs](http://support.bluesnap.com/docs/ipn-setup) for more information.\n* Determine the email address you want to use for the customer's merchant account. You need to specify an `email` address in the `businessInfo`.  This email will receive all communications related to the account, including:\n   * requests for additional information, if necessary\n   * emailed decisions from BlueSnap's review\n   * the link set up the payout\n   * all other email communications\n\n##Process\n1. [Collect your customer's information](#section-step-1-collect-your-merchant-s-information)\n2. [Create the merchant account](#section-step-2-create-the-merchant-account)\n3. [BlueSnap reviews the account](#section-step-3-bluesnap-reviews-the-merchant-account)\n4. [Create the credentials for your merchant](#section-step-4-create-the-credentials-for-your-merchant)\n\n&nbsp; &nbsp; &nbsp; &nbsp;[**Start processing transactions!**](#section-start-processing-transactions-)\n<br />\n<hr />\n\n##Step 1: Collect your customer's information\nCreate the form where your customers can enter their information on your site.  When you create your form, be sure to include all the information we need to create the merchant account for the customer.  All the data elements you need to include in your form are listed in the [Parameters](#section-create-merchant-api-parameters) table below.\n\n<hr />\n##Step 2: Create the merchant account\nWhen you have collected all your merchant information, use the Create-Merchant API request to send to BlueSnap for review.  If your request is successful, you will receive a `200 OK` response from BlueSnap. When our automated review is complete, you'll receive an IPN explaining the status of your merchant approval process.  Refer to [Step 3](#section-step-3-bluesnap-reviews-the-merchant-account) for more information.\n\n###Create Merchant API Request\n\n`https://platform.bluesnap.com/services/2/merchants/application`\n\n####Create Merchant API Parameters\n[block:html]\n{\n  \"html\": \"<div>\\n\\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        <!--businessInfo container-->\\n        <tbody>\\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\\\">(Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font></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 60\\n                    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 characters\\n                </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 customers\\n                    and the merchant's products, services, or both<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 with no spaces or dashes\\n                    <!-- <ul>\\n                        <li>Maximum 15 characters</li>\\n                        <li>Accepts numbers, letters, and these characters: <span class=\\\"api\\\">+&nbsp;.&nbsp;*&nbsp;#&nbsp;/&nbsp;\\\\&nbsp;(&nbsp;)&nbsp;-</span></li>\\n                    </ul> -->\\n                </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: Maximum\\n                    200 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\\\">Private Corporation</span></li>\\n                        <li><span class=\\\"api\\\">Public Corporation</span></li>\\n                        <li><span class=\\\"api\\\">Non-profit</span></li>\\n                        <li><span class=\\\"api\\\">Limited Liability</span></li>\\n                        <li><span class=\\\"api\\\">Partnership</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\\\">Education</span></li>\\n                        <li><span class=\\\"api\\\">Non-profit</span></li>\\n                        <li><span class=\\\"api\\\">Physical Goods</span></li>\\n                        <li><span class=\\\"api\\\">Personal Services</span></li>\\n                        <li><span class=\\\"api\\\">Business Services</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>numeric</i> <br />For US merchants: 9 digits with no spaces or dashes\\n                </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<br />Type: <i>string</i> <br />Limit: Maximum 60 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 60\\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 code\\n                    (Refer to <a href=\\\"https://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 15\\n                    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 code\\n                    (Refer to <a href=\\\"https://developers.bluesnap.com/docs/country-codes\\\" 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 150 characters</li>\\n                    </ul>\\n                    <p><b>Note:</b> The email entered here will receive all communications related to the account. This\\n                        is the address where the link will be sent to set up the payout. In addition, the address\\n                        <i>may</i> receive other messages such as emailed decisions from BlueSnap's review.</p>\\n                   \\n                </td>\\n                </td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">accountUsername</span></td>\\n                <td class=\\\"left\\\">No</td>\\n                <td class=\\\"left\\\">Name for the merchant account (for your reference only)<br />Type: <i>string</i>\\n                    <br />Limit: Maximum 500 characters</td>\\n            </tr>\\n        </tbody>\\n\\n\\n        <!--bankingInfo container-->\\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\\\">(Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font></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 60 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 60 characters</td>\\n            </tr>\\n        </tbody>\\n\\n\\n        <!--ownershipInfoArr container-->\\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\\\">(Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font></td>\\n                <td class=\\\"left\\\">No</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 owners</li>\\n                            <li>If no one owns at least 25%, don't 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 the\\n                        owner, not 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: Maximum 60 characters</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: Maximum 60 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\">\\n                    <span class=\\\"api\\\">ownerLast4SsnDigits</span>\\n                </td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Last 4 digits of the business owner's social security number<br />Type: <i>numeric</i> <br />Limit: Maximum 4 digits</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: Maximum 60 characters</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: Maximum 60 characters</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\\\">Yes</td>\\n                <td class=\\\"left\\\">Business owner's home address state<br />Type: <i>string</i> <br />Limit: 2-letter code\\n                    (Refer to <a href=\\\"https://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\\\">\\n                    <span class=\\\"api\\\">zip</span>\\n                </td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business owner's home address zip code<br />Type: <i>string</i> <br />Limit: Maximum 15 characters</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 code\\n                    (Refer to <a href=\\\"https://developers.bluesnap.com/docs/country-codes\\\" target=\\\"_blank\\\">Country\\n                        Codes</a>.)</td>\\n            </tr>\\n        </tbody>\\n\\n\\n\\n        <!--companyRep container-->\\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\\\">(Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font></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 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 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\\\"><span class=\\\"api\\\">companyRepFirstName</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's first name<br />Type: <i>string</i> <br />Limit: Maximum 60 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepLastName</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's last name<br />Type: <i>string</i> <br />Limit: Maximum 60 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepDateOfBirth</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's date of birth<br />Type: <i>string</i> <br />Format: mm/dd/yyyy</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepLast4SsnDigits</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Last 4 digits of the business representative's social security number<br />Type: <i>numeric</i> <br />Limit: Maximum 4 digits</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepAddress</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's home street address<br />Type: <i>string</i> <br />Limit: Maximum 60 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepCity</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's home address city<br />Type: <i>string</i> <br />Limit: Maximum 60 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepState</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's home address state<br />Type: <i>string</i> <br />Limit: 2-letter code\\n                    (Refer to <a href=\\\"https://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\\\">companyRepZip</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's home address zip code<br />Type: <i>string</i> <br />Limit: Maximum 15 characters</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepCountry</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's home address country<br />Type: <i>string</i> <br />Limit: 2-letter code\\n                    (Refer to <a href=\\\"https://developers.bluesnap.com/docs/country-codes\\\" target=\\\"_blank\\\">Country\\n                        Codes</a>.)</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 40px\\\"><span class=\\\"api\\\">companyRepPhone</span></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Business representative's phone number<br />Type: <i>string</i> <br />For US merchants: 10 digits with no spaces or dashes\\n                    <!-- <ul>\\n                        <li>Maximum 15 characters</li>\\n                        <li>Accepts numbers, letters, and these characters: <span class=\\\"api\\\">+&nbsp;.&nbsp;*&nbsp;#&nbsp;/&nbsp;\\\\&nbsp;(&nbsp;)&nbsp;-</span></li>\\n                    </ul> -->\\n                </td>\\n            </tr>\\n        </tbody>\\n\\n\\n        <!--merchantAgreementsSign container-->\\n        <tbody>\\n            <tr class=\\\"clickable\\\" data-toggle=\\\"collapse\\\" data-target=\\\"#merchantAgreementsSign-rows\\\"\\n                aria-expanded=\\\"false\\\" aria-controls=\\\"merchantAgreementsSign-rows\\\">\\n                <td><span\\n                        class=\\\"api\\\">merchantAgreementsSign</span><br />\\n                    <font size=\\\"1\\\" color=\\\"blue\\\">(Click&nbsp;this&nbsp;row&nbsp;to&nbsp;show/hide&nbsp;the&nbsp;full&nbsp;list.)</font></td>\\n                <td class=\\\"left\\\">Yes</td>\\n                <td class=\\\"left\\\">Container for the <span class=\\\"api\\\">merchantAgreementsSign</span>\\n                    parameters</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\\\">No</td>\\n                <td class=\\\"left\\\">Date the merchant signed the service agreement<br /><b>Note</b>:  This is not required but is recommended.\\n                  <br />Type: <i>string</i> <br />Format: mm/dd/yyyy</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 30px\\\"><span class=\\\"api\\\">pricingAgreementDate</span></td>\\n                <td class=\\\"left\\\">No</td>\\n                <td class=\\\"left\\\">Date the merchant signed the pricing agreement<br /><b>Note</b>:  This is not required but is recommended.\\n                  <br />Type: <i>string</i> <br />Format: mm/dd/yyyy</td>\\n            </tr>\\n            <tr bgcolor=\\\"#f8f8f8\\\">\\n                <td style=\\\"padding-left: 30px\\\"><span class=\\\"api\\\">merchantIp</span></td>\\n                <td class=\\\"left\\\">No</td>\\n              <td class=\\\"left\\\">Merchant's IP address<br /><b>Note</b>:  This is not required but is recommended.\\n                  <br />Type: <i>string</i> <br />Format: xxx.xxx.xxx.xxx</td>\\n            </tr>\\n\\n        </tbody>\\n\\n    </table>\\n\\n\\n</div>\\n\\n\\n\\n<style>\\n    .api {\\n        font-family: 'Courier New';\\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\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  \\\"businessInfo\\\": {\\n    \\\"businessName\\\": \\\"My Business\\\",\\n    \\\"legalName\\\": \\\"Business Affiliates, LLC\\\",\\n    \\\"productAndServiceDesc\\\": \\\"Provide a detailed description of the company's products, services, or both.\\\",\\n    \\\"phone\\\": \\\"15551234567\\\",\\n    \\\"website\\\": \\\"https://www.website.com\\\",\\n    \\\"businessType\\\": \\\"Private Corporation\\\",\\n    \\\"businessCategory\\\": \\\"EDUCATION\\\",\\n    \\\"taxId\\\": \\\"770770770\\\",\\n    \\\"address\\\": \\\"1234 Main Street\\\",\\n    \\\"city\\\": \\\"Waltham\\\",\\n    \\\"state\\\": \\\"MA\\\",\\n    \\\"zip\\\": \\\"02453\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"email\\\": \\\"first.last:::at:::merchant.com\\\",\\n    \\\"accountUsername\\\": \\\"MerchantUsername\\\"\\n  },\\n  \\\"bankingInfo\\\": {\\n    \\\"routingNumber\\\": \\\"123-456-789\\\",\\n    \\\"accountNumber\\\": \\\"123456789\\\"\\n  },\\n  \\\"ownershipInfoArr\\\": [\\n    {\\n      \\\"ownerFirstName\\\": \\\"Chris\\\",\\n      \\\"ownerLastName\\\": \\\"Jones\\\",\\n      \\\"ownerLast4SsnDigits\\\": \\\"1111\\\",\\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      \\\"ownerLast4SsnDigits\\\": \\\"2222\\\",\\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    \\\"companyRepLast4SsnDigits\\\": \\\"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\\\": \\\"03/31/2019\\\",\\n    \\\"pricingAgreementDate\\\": \\\"03/31/2019\\\",\\n    \\\"merchantIp\\\": \\\"192.168.20.15\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Create Merchant API: Request\"\n    }\n  ]\n}\n[/block]\n####Create Merchant API Response examples\nIf it's successful, BlueSnap returns a `200 OK` response.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 200\\nLocation: https://platform.bluesnap.com/services/2/merchants/application\",\n      \"language\": \"json\",\n      \"name\": \"Successful response:  200 OK\"\n    }\n  ]\n}\n[/block]\n<br />\n<hr />\n##Step 3: BlueSnap reviews the merchant account\nYou will receive an [IPN](http://support.bluesnap.com/docs/ipn-setup) based on the outcome of the review. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"The IPN is sent only ***after*** the review process is complete.\"\n}\n[/block]\nThe IPN can contain the following:\n\n&nbsp;&nbsp;&nbsp;&nbsp; Merchant Name (`merchantName`)\n&nbsp;&nbsp;&nbsp;&nbsp; Merchant Email (`merchantEmail`)\n&nbsp;&nbsp;&nbsp;&nbsp; Merchant ID (`merchantId`) [The presence of this depends on the review outcome.]\n&nbsp;&nbsp;&nbsp;&nbsp; Payout (`payoutStatus`) = `Yes`, `No`, or  `Pending`\n&nbsp;&nbsp;&nbsp;&nbsp; Processing (`accountCanProcess`) = `Yes`, `No`, or  `Pending`\n\nUse the IPN details to determine what to do next:\n * If the IPN includes a Merchant ID **and** Processing = `Yes`, <br />then you can [create the merchant credentials](#section-step-4-create-the-credentials-for-your-merchant) and begin processing.\n * If the IPN includes a Merchant ID **and** Payout is not `Yes`, <br />then you can [create the merchant credentials](#section-step-4-create-the-credentials-for-your-merchant) to begin processing and you will receive a second IPN when the merchant is approved.\n * If the IPN does **not** include a Merchant ID **and** Payout = `No`, <br />then the merchant has been declined and no further updates will be sent.\n\n<br />\n<hr />\n##Step 4: Create the credentials for your merchant\nUse the Merchant ID (`merchantId`) from the IPN ([Step 3](#section-step-3-bluesnap-reviews-the-merchant-account)) to create the merchant's credentials using the Get Merchant Credentials API request.  These credentials are used to send transactions to BlueSnap on behalf of the merchant.  \n\nIf your request is successful, you will receive a `200 OK` response from BlueSnap with the merchant's credentials.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Caution\",\n  \"body\": \"If you provide the merchant with these credentials, they can log into their console and make changes, potentially causing transactions not to be processed.\"\n}\n[/block]\n###New Get Merchant API Credentials request\n\n`https://platform.bluesnap.com/services/2/merchants/api-credentials`\n\n####Get Merchant API Credentials Parameters\n[block:html]\n{\n  \"html\": \"<div>\\n\\n    <table id=\\\"section-get-api-credentials\\\">\\n\\n        <tr>\\n            <th>Parameter</th>\\n            <th style=\\\"text-align:left\\\">Required</th>\\n            <th style=\\\"text-align:left\\\">Details</th>\\n            <th style=\\\"text-align:left\\\">Description</th>\\n        </tr>\\n        <tr>\\n            <td><span class=\\\"api\\\">merchantId</span></td>\\n            <td class=\\\"left\\\">Yes</td>\\n          <td class=\\\"left\\\"><i>numeric</i></td>\\n            <td class=\\\"left\\\">The merchant ID assigned to the merchant and included in the IPN.</td>\\n        </tr>\\n        <tr>\\n            <td><span class=\\\"api\\\">username</span></td>\\n            <td class=\\\"left\\\">No</td>\\n          <td class=\\\"left\\\"><i>string</i></td>\\n            <td class=\\\"left\\\">The username for the merchant account.<br />If you don't include it, the response will provide the username.</td>\\n        </tr>\\n        <tr>\\n            <td><span class=\\\"api\\\">password</span></td>\\n            <td class=\\\"left\\\">No</td>\\n            <td class=\\\"left\\\"><i>string</i></td>\\n            <td class=\\\"left\\\">The password for the merchant account.<br />If you don't include it, the response will provide the password.</td>\\n        </tr>\\n        <tr>\\n            <td><span class=\\\"api\\\">dataProtectionKey</span></td>\\n            <td class=\\\"left\\\">No</td>\\n            <td class=\\\"left\\\"><i>string</i></td>\\n            <td class=\\\"left\\\">The Data Protection Key for the merchant account.<br />If you don't include it, the response will provide it.\\n              <p>The <a href=\\\"https://support.bluesnap.com/page/setting-up-your-data-protection-key-1\\\" target=\\\"_blank\\\">Data Protection Key</a> is required to perform certain functions.</p></td>\\n        </tr>\\n      \\n    </table>\\n\\n\\n</div>\\n\\n\\n\\n<style>\\n    .api {\\n        font-family: 'Courier New';\\n        background-color: #efefef;\\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</style>\"\n}\n[/block]\n####Get Merchant API Credentials Request examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://platform.bluesnap.com/services/2/merchants/api-credentials \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"merchantId\\\":857345\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Get API Credentials: Request with only merchantId\"\n    },\n    {\n      \"code\": \"curl -v -X POST https://platform.bluesnap.com/services/2/merchants/api-credentials \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"merchantId\\\":857345,\\n  \\\"username\\\":\\\"MerchantUsername\\\",\\n  \\\"password\\\":\\\"kjhdA@3aA\\\",\\n  \\\"dataProtectionKey\\\": \\\"Kru5Y50p\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"with all data\"\n    }\n  ]\n}\n[/block]\n####Get Merchant API Credentials Response examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"merchantId\\\": 857345,\\n    \\\"username\\\": \\\"MerchantUsername\\\",\\n    \\\"password\\\": \\\"kjhdA@3aA\\\",\\n    \\\"dataProtectionKey\\\": \\\"Kru5Y50p\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Successful response: 200 OK\"\n    }\n  ]\n}\n[/block]\n\n<br />\n<hr />\n\n##Start processing transactions!\nYou can begin processing transactions.\n\n##What's next?\nYou should now configure your payout information.  Everything you need to know is [here](https://support.bluesnap.com/docs/launch-get-paid#section-get-paid).","excerpt":"An easy 4-step process to onboard customers to your platform","slug":"cmp-process","type":"basic","title":"Customer Onboarding"}

Customer Onboarding

An easy 4-step process to onboard customers to your platform

Before you begin

  • You must have worked with a BlueSnap Implementation Engineer to register your platform with us.
  • You must be set up to receive IPNs. To enable IPNs, you must set up a server and URL on your side and then configure IPNs in your BlueSnap account. Refer to Setting up IPNs for more information.
  • Determine the email address you want to use for the customer's merchant account. You need to specify an email address in the businessInfo. This email will receive all communications related to the account, including:
    • requests for additional information, if necessary
    • emailed decisions from BlueSnap's review
    • the link set up the payout
    • all other email communications

Process

  1. Collect your customer's information
  2. Create the merchant account
  3. BlueSnap reviews the account
  4. Create the credentials for your merchant

       Start processing transactions!


Step 1: Collect your customer's information

Create the form where your customers can enter their information on your site. When you create your form, be sure to include all the information we need to create the merchant account for the customer. All the data elements you need to include in your form are listed in the Parameters table below.


Step 2: Create the merchant account

When you have collected all your merchant information, use the Create-Merchant API request to send to BlueSnap for review. If your request is successful, you will receive a 200 OK response from BlueSnap. When our automated review is complete, you'll receive an IPN explaining the status of your merchant approval process. Refer to Step 3 for more information.

Create Merchant API Request

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

Create Merchant API Parameters

Parameter Required Details
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 or dashes
website Yes Main website for the merchant's business
Type: string
Limit: Maximum 200 characters
businessType Yes Type of business
Valid values:
  • Private Corporation
  • Public Corporation
  • Non-profit
  • Limited Liability
  • Partnership
  • Sole Proprietorship
businessCategory Yes Category of the business
Valid values:
  • Education
  • Non-profit
  • Physical Goods
  • Personal Services
  • Business Services
  • Software
  • Travel
  • Other
taxId Yes Merchant's tax ID number
Type: numeric
For US merchants: 9 digits with no spaces or dashes
address Yes Merchant's business address
Type: string
Limit: Maximum 60 characters
city Yes Merchant's business address city
Type: string
Limit: Maximum 60 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 15 characters
country Yes Merchant's business address country
Type: string
Limit: 2-letter code (Refer to Country Codes.)
email Yes Email address of the entity to receive all communications.
Type: string
Limits:
  • Minimum 7 characters
  • Maximum 150 characters

Note: The email entered here will receive all communications related to the account. This is the address where the link will be sent to set up the payout. In addition, the address may receive other messages such as emailed decisions from BlueSnap's review.

accountUsername No Name for the merchant account (for your reference only)
Type: string
Limit: Maximum 500 characters
routingNumber Yes Routing number for the merchant's business bank account
Type: string
Limit: Maximum 60 characters
accountNumber Yes Account number for the merchant's business bank account
Type: string
Limit: Maximum 60 characters
ownerFirstName Yes Business owner's first name
Type: string
Limit: Maximum 60 characters
ownerLastName Yes Business owner's last name
Type: string
Limit: Maximum 60 characters
ownerLast4SsnDigits Yes Last 4 digits of the business owner's social security number
Type: numeric
Limit: Maximum 4 digits
address Yes Business owner's home street address
Type: string
Limit: Maximum 60 characters
city Yes Business owner's home address city
Type: string
Limit: Maximum 60 characters
state Yes Business owner's home address state
Type: string
Limit: 2-letter code (Refer to State Codes.)
zip Yes Business owner's home address zip code
Type: string
Limit: Maximum 15 characters
country Yes Business owner's home address country
Type: string
Limit: 2-letter code (Refer to Country Codes.)
companyRepFirstName Yes Business representative's first name
Type: string
Limit: Maximum 60 characters
companyRepLastName Yes Business representative's last name
Type: string
Limit: Maximum 60 characters
companyRepDateOfBirth Yes Business representative's date of birth
Type: string
Format: mm/dd/yyyy
companyRepLast4SsnDigits Yes Last 4 digits of the business representative's social security number
Type: numeric
Limit: Maximum 4 digits
companyRepAddress Yes Business representative's home street address
Type: string
Limit: Maximum 60 characters
companyRepCity Yes Business representative's home address city
Type: string
Limit: Maximum 60 characters
companyRepState Yes Business representative's home address state
Type: string
Limit: 2-letter code (Refer to State Codes.)
companyRepZip Yes Business representative's home address zip code
Type: string
Limit: Maximum 15 characters
companyRepCountry Yes Business representative's home address country
Type: string
Limit: 2-letter code (Refer to Country Codes.)
companyRepPhone Yes Business representative's phone number
Type: string
For US merchants: 10 digits with no spaces or dashes
serviceAgreementDate No Date the merchant signed the service agreement
Note: This is not required but is recommended.
Type: string
Format: mm/dd/yyyy
pricingAgreementDate No Date the merchant signed the pricing agreement
Note: This is not required but is recommended.
Type: string
Format: mm/dd/yyyy
merchantIp No Merchant's IP address
Note: This is not required but is recommended.
Type: string
Format: xxx.xxx.xxx.xxx

Create Merchant API Request examples

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": "My Business",
    "legalName": "Business Affiliates, LLC",
    "productAndServiceDesc": "Provide a detailed description of the company's products, services, or both.",
    "phone": "15551234567",
    "website": "https://www.website.com",
    "businessType": "Private Corporation",
    "businessCategory": "EDUCATION",
    "taxId": "770770770",
    "address": "1234 Main Street",
    "city": "Waltham",
    "state": "MA",
    "zip": "02453",
    "country": "US",
    "email": "first.last@merchant.com",
    "accountUsername": "MerchantUsername"
  },
  "bankingInfo": {
    "routingNumber": "123-456-789",
    "accountNumber": "123456789"
  },
  "ownershipInfoArr": [
    {
      "ownerFirstName": "Chris",
      "ownerLastName": "Jones",
      "ownerLast4SsnDigits": "1111",
      "address": "1234 Main Street",
      "city": "Waltham",
      "state": "FL",
      "zip": "02453",
      "country": "US"
    },
    {
      "ownerFirstName": "Jamie",
      "ownerLastName": "Doe",
      "ownerLast4SsnDigits": "2222",
      "address": "200 Broadway",
      "city": "Happy",
      "state": "FL",
      "zip": "12345",
      "country": "US"
    }
  ],
  "companyRep": {
    "companyRepFirstName": "Jesse",
    "companyRepLastName": "Smith",
    "companyRepDateOfBirth": "12/13/1967",
    "companyRepLast4SsnDigits": "1234",
    "companyRepAddress": "123 South Street",
    "companyRepCity": "Happy",
    "companyRepState": "FL",
    "companyRepZip": "12345",
    "companyRepCountry": "US",
    "companyRepPhone": "15551234567"
  },
  "merchantAgreementsSign": {
    "serviceAgreementDate": "03/31/2019",
    "pricingAgreementDate": "03/31/2019",
    "merchantIp": "192.168.20.15"
  }
}

Create Merchant API Response examples

If it's successful, BlueSnap returns a 200 OK response.

HTTP/ 1.1 200
Location: https://platform.bluesnap.com/services/2/merchants/application



Step 3: BlueSnap reviews the merchant account

You will receive an IPN based on the outcome of the review.

Note

The IPN is sent only after the review process is complete.

The IPN can contain the following:

     Merchant Name (merchantName)
     Merchant Email (merchantEmail)
     Merchant ID (merchantId) [The presence of this depends on the review outcome.]
     Payout (payoutStatus) = Yes, No, or Pending
     Processing (accountCanProcess) = Yes, No, or Pending

Use the IPN details to determine what to do next:

  • If the IPN includes a Merchant ID and Processing = Yes,
    then you can create the merchant credentials and begin processing.
  • If the IPN includes a Merchant ID and Payout is not Yes,
    then you can create the merchant credentials to begin processing and you will receive a second IPN when the merchant is approved.
  • If the IPN does not include a Merchant ID and Payout = No,
    then the merchant has been declined and no further updates will be sent.



Step 4: Create the credentials for your merchant

Use the Merchant ID (merchantId) from the IPN (Step 3) to create the merchant's credentials using the Get Merchant Credentials API request. These credentials are used to send transactions to BlueSnap on behalf of the merchant.

If your request is successful, you will receive a 200 OK response from BlueSnap with the merchant's credentials.

Caution

If you provide the merchant with these credentials, they can log into their console and make changes, potentially causing transactions not to be processed.

New Get Merchant API Credentials request

https://platform.bluesnap.com/services/2/merchants/api-credentials

Get Merchant API Credentials Parameters

Parameter Required Details Description
merchantId Yes numeric The merchant ID assigned to the merchant and included in the IPN.
username No string The username for the merchant account.
If you don't include it, the response will provide the username.
password No string The password for the merchant account.
If you don't include it, the response will provide the password.
dataProtectionKey No string The Data Protection Key for the merchant account.
If you don't include it, the response will provide it.

The Data Protection Key is required to perform certain functions.

Get Merchant API Credentials Request examples

curl -v -X POST https://platform.bluesnap.com/services/2/merchants/api-credentials \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "merchantId":857345
}
curl -v -X POST https://platform.bluesnap.com/services/2/merchants/api-credentials \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "merchantId":857345,
  "username":"MerchantUsername",
  "password":"kjhdA@3aA",
  "dataProtectionKey": "Kru5Y50p"
}

Get Merchant API Credentials Response examples

{
    "merchantId": 857345,
    "username": "MerchantUsername",
    "password": "kjhdA@3aA",
    "dataProtectionKey": "Kru5Y50p"
}



Start processing transactions!

You can begin processing transactions.

What's next?

You should now configure your payout information. Everything you need to know is here.