{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Onboarding","type":"basic","slug":"onboarding","excerpt":"","body":"# BlueSnap Dash™ Overview\nWith BlueSnap Dash™, your platform will quickly go live with zero to very little development effort. BlueSnap Dash™ provides an out-of-the-box, code-free hosted application for your merchants and customers. Our global merchant application is localized and optimized for a frictionless user experience.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/01b307c-dash-onboarding-1.png\",\n        \"dash-onboarding-1.png\",\n        471,\n        576,\n        \"#333\"\n      ]\n    }\n  ]\n}\n[/block]\n# Account Application\nAs a platform, you will get a unique URL for your BlueSnap Hosted Application. You can embed this URL on your platform, website, or share it via email or chat. When your merchant opens the link, they will signup for a BlueSnap Test account. Using the test account, they can submit an account application. As a platform, you do not need to do any onboarding work. BlueSnap will do the heavy lifting for you.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Merchants do not need to submit the application in one sitting; their answers will automatically be saved and they can continue their application where they left off at anytime.\",\n  \"title\": \"Note\"\n}\n[/block]\n# KYC/AML Process Details\nAs a payments technology company, BlueSnap is required to collect and verify information about all BlueSnap merchant accounts. Our regulators require these steps in order to prevent money laundering, tax evasion, and other financial crimes.\n\nOnce we receive your merchant’s account application data from you, we will run a series of background checks automatically. In certain cases, the information provided may need further verification. We may ask for additional documents such as:\n• A government-issued photo ID\n• A voided check or bank letter\n• Business registration documents etc.\n• Financial statements\n• Processing statements\n• Forward delivery schedule\n• Website and description of goods related documents\n\nIf we need additional documents, someone from our underwriting team will reach out to the merchant with instructions. Submitting accurate information is crucial and it reduces the likelihood we will reach out to you for more documents. Your merchants are responsible for providing requested documents in a timely manner. As a platform, you also have the ability to track the status of your merchant’s application.\n\n# BlueSnap reviews the merchant account\nYou will receive an [IPN](http://support.bluesnap.com/docs/ipn-setup) based on the outcome of the review. Keep in mind that the IPN is sent only ***after*** the review process is complete.\n\nThe IPN can contain the following:\n* Merchant Name (`merchantName`)\n* Merchant Email (`merchantEmail`)\n* Merchant ID (`merchantId`) [The presence of this depends on the review outcome.]\n* Sandbox ID (`sandboxId`)\n* Processing (`accountCanProcess`) = `Y`, `N`, or  `Pending`\n * Payout (`payoutStatus`) = `Y`, `N`, or  `Pending`\n\nUse the IPN details to determine what to do next.\n[block:html]\n{\n  \"html\": \"<div>\\n    <table id=\\\"ipn_details\\\">\\n        <tr>\\n            <th>Merchant ID</th>\\n            <th>Processing</th>\\n            <th>Payout</th>\\n            <th>Next Step</th>\\n        </tr>\\n        <tr>\\n          <td>&#x2714;</td>\\n          <td><span class=\\\"api\\\">Y</span></td>\\n          <td><span class=\\\"api\\\">Y</span></td>\\n          <td class=\\\"left\\\">You can <a href=\\\"https://developers.bluesnap.com/v8976-Embedded-Payments/docs/onboarding#section-create-credentials-for-your-merchant\\\">create the merchant credentials</a> and begin processing.</td>\\n        </tr>\\n          <tr>\\n          <td>&#x2714;</td>\\n          <td><span class=\\\"api\\\">Y</span></td>\\n          <td><span class=\\\"api\\\">Pending</span></td>\\n          <td class=\\\"left\\\">You can <a href=\\\"https://developers.bluesnap.com/v8976-Embedded-Payments/docs/onboarding#section-create-credentials-for-your-merchant\\\">create the merchant credentials</a> to begin processing. <br />You will receive a second IPN when the merchant is approved for payout.</td>\\n        </tr>\\n          <tr>\\n          <td>&#x2716;</td>\\n          <td><span class=\\\"api\\\">Pending</span></td>\\n          <td><span class=\\\"api\\\">Pending</span></td>\\n          <td class=\\\"left\\\">You cannot create merchant credentials to begin processing. <br />You will receive a second IPN when the merchant is approved.</td>\\n        </tr>\\n          <tr>\\n          <td>&#x2716;</td>\\n          <td><span class=\\\"api\\\">N</span></td>\\n          <td><span class=\\\"api\\\">N</span></td>\\n          <td class=\\\"left\\\">The merchant has been declined; no further updates will be sent.</td>\\n        </tr>\\n    </table>\\n</div>\\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      text-align: center;\\n    }\\n\\n    table th {\\n        display: table-cell;\\n        vertical-align: top;\\n    }\\n</style>\"\n}\n[/block]\n# Account Setup\nOnce your merchant passes the KYC/AML verification, their account will automatically and instantly get created in our global payments network. Your merchants will then get a signup email to access their production account.\n\nIn order to connect your platform account to your merchant accounts and run transactions on their behalf, you can simply follow the instructions below.\n\n#Create credentials for your merchant\nUse the Merchant ID (`merchantId`) from the IPN 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\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    <table id=\\\"section-get-api-credentials\\\">\\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 class=\\\"left\\\"><span class=\\\"api\\\">approvalTesting</span></td>\\n            <td>No</td>\\n          <td><i>boolean</i></td>\\n          <td class=\\\"left\\\">Default=<span class=\\\"api\\\">false</span>.  If you include this parameter and set it to <span class=\\\"api\\\">true</span>, you are testing the feature.</td>\\n        </tr>\\n        <tr>\\n            <td class=\\\"left\\\"><span class=\\\"api\\\">merchantId</span></td>\\n            <td>Yes</td>\\n          <td><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 class=\\\"left\\\"><span class=\\\"api\\\">username</span></td>\\n            <td>No</td>\\n          <td><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 class=\\\"left\\\"><span class=\\\"api\\\">password</span></td>\\n            <td>No</td>\\n            <td><i>string</i></td>\\n            <td class=\\\"left\\\">The password for the merchant account. Minimum 8 characters and maximum 64 characters.<br />If you don't include a password, the response will provide it.</td>\\n        </tr>\\n        <tr>\\n            <td class=\\\"left\\\"><span class=\\\"api\\\">dataProtectionKey</span></td>\\n            <td>No</td>\\n            <td><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    </table>\\n</div>\\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      text-align: center;\\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\": \"curl\",\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:::at:::3aA\\\",\\n  \\\"dataProtectionKey\\\": \\\"Kru5Y50p\\\"\\n}\",\n      \"language\": \"curl\",\n      \"name\": \"with all data\"\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  \\\"approvalTesting\\\": true,\\n  \\\"merchantId\\\": 857345,\\n  \\\"username\\\": \\\"MerchantUsername\\\",\\n  \\\"password\\\": \\\"[email protected]\\\",\\n  \\\"dataProtectionKey\\\": \\\"Kru5Y50p\\\"\\n}\",\n      \"language\": \"curl\",\n      \"name\": \"Request in TEST mode\"\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\\\": \\\"[email protected]\\\",\\n    \\\"dataProtectionKey\\\": \\\"Kru5Y50p\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Successful response: 200 OK\"\n    }\n  ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"62178e15528a76002de1e8db","createdAt":"2022-02-24T13:54:29.047Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"BlueSnap Dash™","slug":"payment-api-essentials","order":1,"from_sync":false,"reference":false,"_id":"62178c1e445ec2009631ebec","version":"62178c1e445ec2009631ec4d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-01T16:42:25.324Z","__v":1},"version":{"version":"8976-Embedded-Payments","version_clean":"8976.0.0-Embedded-Payments","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["62178c1e445ec2009631ebeb","62178c1e445ec2009631ebec","62178c1e445ec2009631ebed","62178c1e445ec2009631ebee","62178c1e445ec2009631ebef","62178c1e445ec2009631ebf0","5beb278ac442ab0213f00990","62178c1e445ec2009631ebf1","5c3f542c12c4ac004bc51718","62178c1e445ec2009631ebf2","5df806ccecebde0059f17225","5dfa8a8f340c2b007418eb8a","62178c1e445ec2009631ebf3","5e597199fd2b0200117c2c1c"],"_id":"62178c1e445ec2009631ec4d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6183ed028202aa00161024e9","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

BlueSnap Dash™ Overview

With BlueSnap Dash™, your platform will quickly go live with zero to very little development effort. BlueSnap Dash™ provides an out-of-the-box, code-free hosted application for your merchants and customers. Our global merchant application is localized and optimized for a frictionless user experience.

Account Application

As a platform, you will get a unique URL for your BlueSnap Hosted Application. You can embed this URL on your platform, website, or share it via email or chat. When your merchant opens the link, they will signup for a BlueSnap Test account. Using the test account, they can submit an account application. As a platform, you do not need to do any onboarding work. BlueSnap will do the heavy lifting for you.

Note

Merchants do not need to submit the application in one sitting; their answers will automatically be saved and they can continue their application where they left off at anytime.

KYC/AML Process Details

As a payments technology company, BlueSnap is required to collect and verify information about all BlueSnap merchant accounts. Our regulators require these steps in order to prevent money laundering, tax evasion, and other financial crimes.

Once we receive your merchant’s account application data from you, we will run a series of background checks automatically. In certain cases, the information provided may need further verification. We may ask for additional documents such as:
• A government-issued photo ID
• A voided check or bank letter
• Business registration documents etc.
• Financial statements
• Processing statements
• Forward delivery schedule
• Website and description of goods related documents

If we need additional documents, someone from our underwriting team will reach out to the merchant with instructions. Submitting accurate information is crucial and it reduces the likelihood we will reach out to you for more documents. Your merchants are responsible for providing requested documents in a timely manner. As a platform, you also have the ability to track the status of your merchant’s application.

BlueSnap reviews the merchant account

You will receive an IPN based on the outcome of the review. Keep in mind that 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.]
  • Sandbox ID (sandboxId)
  • Processing (accountCanProcess) = Y, N, or Pending
    • Payout (payoutStatus) = Y, N, or Pending

Use the IPN details to determine what to do next.

Merchant ID Processing Payout Next Step
Y Y You can create the merchant credentials and begin processing.
Y Pending You can create the merchant credentials to begin processing.
You will receive a second IPN when the merchant is approved for payout.
Pending Pending You cannot create merchant credentials to begin processing.
You will receive a second IPN when the merchant is approved.
N N The merchant has been declined; no further updates will be sent.

Account Setup

Once your merchant passes the KYC/AML verification, their account will automatically and instantly get created in our global payments network. Your merchants will then get a signup email to access their production account.

In order to connect your platform account to your merchant accounts and run transactions on their behalf, you can simply follow the instructions below.

Create credentials for your merchant

Use the Merchant ID (merchantId) from the IPN 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.

New Get Merchant API Credentials request

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

Get Merchant API Credentials Parameters

Parameter Required Details Description
approvalTesting No boolean Default=false. If you include this parameter and set it to true, you are testing the feature.
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. Minimum 8 characters and maximum 64 characters.
If you don't include a password, the response will provide it.
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":"[email protected]",
  "dataProtectionKey": "Kru5Y50p"
}
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 '
{
  "approvalTesting": true,
  "merchantId": 857345,
  "username": "MerchantUsername",
  "password": "[email protected]",
  "dataProtectionKey": "Kru5Y50p"
}

Get Merchant API Credentials Response examples

{
    "merchantId": 857345,
    "username": "MerchantUsername",
    "password": "[email protected]",
    "dataProtectionKey": "Kru5Y50p"
}