{"_id":"59dfa5858b51880010b74aed","category":{"_id":"59dfa5828b51880010b74abf","version":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T19:23:42.327Z","from_sync":false,"order":8,"slug":"marketplace","title":"Marketplace"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"59dfa5828b51880010b74ab6","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-10-12T17:25:22.850Z","releaseDate":"2017-10-12T17:25:22.850Z","categories":["59dfa5828b51880010b74ab7","59dfa5828b51880010b74ab8","59dfa5828b51880010b74ab9","59dfa5828b51880010b74aba","59dfa5828b51880010b74abb","59dfa5828b51880010b74abc","59dfa5828b51880010b74abd","59dfa5828b51880010b74abe","59dfa5828b51880010b74abf","59dfa5828b51880010b74ac0","59dfa5828b51880010b74ac1","59dfa5828b51880010b74ac2","59dfa5828b51880010b74ac3","59dfa5828b51880010b74ac4","59dfa5828b51880010b74ac5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.23 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T19:24:26.895Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","auth":"optional","params":[],"url":"/vendors"},"isReference":false,"order":1,"body":"The Create Vendor request enables you to set up a new vendor who will be associated with your marketplace.  The Create Vendor request is where you submit the vendors KYC information, their banking information, the agreed upon commission split and so on. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Important: Vendor verification requirements\",\n  \"body\": \"To begin processing transactions, the vendor's country and email are required. \\n\\nTo be eligible for payout, additional vendor information is needed. To see the payout requirements, click [here](/docs/vendor-verification-requirements#section-requirements-for-payout).\"\n}\n[/block]\n###Request Content\n`vendor` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vendor](doc:vendorinfo)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`email` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`name` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`firstName` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`lastName` *string* &nbsp;&nbsp;&nbsp; optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`phone` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`address` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`city` *string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`country` *string* &nbsp;&nbsp; <span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`state` *string* &nbsp;&nbsp;optional &nbsp;&nbsp; applicable if country = US or CA (See [State and Province Codes](http://developers.bluesnap.com/docs/state-and-province-codes)). \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`zip` *string* &nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`taxId` *string* &nbsp;&nbsp;&nbsp;optional \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vatId` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`defaultPayoutCurrency` *string* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`frequency` *string* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`delay` *integer* &nbsp;&nbsp;&nbsp;optional &nbsp;&nbsp;&nbsp;\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendorPrincipal` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendorPrincipal](doc:vendorprincipal))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`vendorAgreement` *container* &nbsp;&nbsp;&nbsp; optional; (see [vendorAgreement](doc:vendoragreement)) \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payoutInfo` *container* &nbsp;&nbsp;&nbsp;optional; (see [payoutInfo](doc:payoutinfo))\n\n###Response Details\nIf successful, the response HTTP status code is 201 Created.\nThe response body contains the `vendorId`.\nThe `vendorId` is required for all future transactions associated with this vendor.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"email\\\": \\\"vendor:::at:::example.com\\\",\\n    \\\"firstName\\\": \\\"Joe\\\",\\n    \\\"lastName\\\": \\\"Smith\\\",\\n    \\\"phone\\\": \\\"1-123-456-7890\\\",\\n    \\\"address\\\": \\\"123 Main Street\\\",\\n    \\\"city\\\": \\\"Boston\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"state\\\":\\\"MA\\\",\\n    \\\"zip\\\": \\\"123456\\\",\\n    \\\"defaultPayoutCurrency\\\": \\\"USD\\\", \\n    \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"zip\\\": \\\"123456\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n      \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"individual.vendor@bluesnap.com\\\"\\n    },\\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30\\n    },\\n    \\\"payoutInfo\\\": [{\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"vendor\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n        \\\"bankName\\\": \\\"Leumi\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\", \\n        \\\"minimalPayoutAmount\\\": 50\\n    }]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Create Vendor - Individual \"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"name\\\": \\\"Business ABC\\\", \\n    \\\"email\\\": \\\"vendor@example.com\\\", \\n    \\\"phone\\\": \\\"1-123-455-8765\\\", \\n    \\\"address\\\": \\\"25 Business Avenue\\\", \\n    \\\"city\\\": \\\"Boston\\\", \\n    \\\"country\\\": \\\"US\\\", \\n    \\\"state\\\": \\\"MA\\\", \\n    \\\"zip\\\": \\\"123456\\\", \\n    \\\"taxId\\\": \\\"123456789\\\",\\n    \\\"defaultPayoutCurrency\\\": \\\"USD\\\", \\n    \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n      \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"principal.vendor@email.com\\\"\\n    }, \\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30\\n      },\\n    \\\"payoutInfo\\\": [{\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"name of vendor account\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"CORPORATE\\\",\\n        \\\"bankName\\\": \\\"Bank of America\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\",\\n        \\\"minimalPayoutAmount\\\": 50\\n      }]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Business \"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{ \\n    \\\"email\\\": \\\"jane.shopper@bluesnap.com\\\", \\n    \\\"country\\\": \\\"US\\\"\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Minimal Details \"\n    },\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n    \\\"email\\\": \\\"individual_vendor@example.com\\\",\\n    \\\"firstName\\\": \\\"Joe\\\",\\n    \\\"lastName\\\": \\\"Smith\\\",\\n    \\\"phone\\\": \\\"1-123-456-7890\\\",\\n    \\\"address\\\": \\\"123 Main Street\\\",\\n    \\\"city\\\": \\\"Boston\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"state\\\":\\\"MA\\\",\\n    \\\"zip\\\": \\\"123456\\\",\\n    \\\"defaultPayoutCurrency\\\": \\\"USD\\\", \\n    \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"zip\\\": \\\"123456\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n      \\t\\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"individual_vendor@bluesnap.com\\\"\\n    },\\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30\\n    },\\n    \\\"payoutInfo\\\": [\\n    {\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"vendor\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n        \\\"bankName\\\": \\\"Leumi\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\"\\n    }, \\n    {\\n       \\\"payoutType\\\": \\\"CHAPS\\\",\\n       \\\"baseCurrency\\\": \\\"GBP\\\",\\n       \\\"nameOnAccount\\\": \\\"Jane Shopper\\\",\\n       \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n       \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n       \\\"bankName\\\": \\\"Barclays\\\",\\n       \\\"bankId\\\": \\\"12445\\\",\\n       \\\"iban\\\": \\\"377438437843847300022\\\",\\n       \\\"country\\\": \\\"UK\\\",\\n       \\\"city\\\": \\\"Luton\\\",\\n       \\\"address\\\": \\\"28 George St\\\",\\n       \\\"zip\\\": \\\"LU1 2AE\\\",\\n       \\\"bankAccountId\\\": \\\"36628822\\\"\\n  }\\n  ]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"with 2 bank accounts\"\n    }\n  ]\n}\n[/block]\n###Response Examples \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 201 Created\\nLocation: https://sandbox.bluesnap.com/services/2/vendors/19575974\",\n      \"language\": \"curl\",\n      \"name\": \"Create Vendor - Response\"\n    }\n  ]\n}\n[/block]\n##Example Descriptions\n\n###Create Vendor: Individual\nThis example shows a Create Vendor request with sufficient information to fully board an individual vendor. To see the required information for payout, click [here](/docs/vendor-verification-requirements#section-requirements-for-payout). Since `frequency` and `delay` were not included in the request, the vendor's payout schedule will default to the Marketplace Merchant's approved schedule with BlueSnap. \n\n###Create Vendor: Business\nThis example shows a Create Vendor request with sufficient information to fully board a business vendor. Note that the primary difference between boarding a business vendor and an individual vendors is that business vendors will require the `name` and a `taxId` or `vatId`. To see the required information for payout, click [here](/docs/vendor-verification-requirements#section-requirements-for-payout). Since `frequency` and `delay` were not included in the request, the vendor's payout schedule will default to the Marketplace Merchant's approved schedule with BlueSnap. \n\n###Create Vendor: minimal details\nThis example shows a Create Vendor request with the minimal required fields to get started boarding a new vendor.  These details will allow you to send transactions for processing on behalf of the vendor. However, until all necessary vendor information is submitted, payout will be on-hold.\n\n###Create Vendor: with 2 bank accounts\nThis example shows a Create Vendor request for an individual vendor with 2 bank accounts. The vendor's bank account details are included within separate objects inside the `payoutInfo` container (1 bank account per object). In this particular example, the vendor will be paid out in USD (via ACH) and GBP (via CHAPS). Their default payout currency is USD. \n\nThe following conversion logic will apply: \n* Since the vendor's payout currencies are USD and GBP, if a sale occurs in a either of these currencies, the sales funds will be paid out to the associated bank account. \n* Since the vendor's default payout currency is USD, if a sale occurs in a currency other than USD or GBP, the sales funds will be converted to USD and paid out to the associated bank account. \n \n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**Tip**: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n    \\\"email\\\": \\\"vendor@bluesnap.com\\\",\\n    \\\"name\\\": \\\"Important Vendor\\\",\\n    \\\"firstName\\\": \\\"Joe\\\",\\n    \\\"lastName\\\": \\\"Smith\\\",\\n    \\\"phone\\\": \\\"0549766778\\\",\\n    \\\"address\\\": \\\"123 Main Street\\\",\\n    \\\"city\\\": \\\"Juneau\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"state\\\":\\\"MA\\\",\\n    \\\"zip\\\": \\\"4640802\\\",\\n    \\\"taxId\\\": \\\"123456789\\\",\\n    \\\"defaultPayoutCurrency\\\": \\\"USD\\\", \\n    \\\"vendorPrincipal\\\": {\\n        \\\"firstName\\\": \\\"Joe\\\",\\n        \\\"lastName\\\": \\\"Smith\\\",\\n        \\\"address\\\": \\\"123 Main Street\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"dob\\\": \\\"28-09-9999\\\",\\n        \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n        \\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n        \\\"email\\\": \\\"principal.name@vendor.com\\\"\\n    },\\n    \\\"vendorAgreement\\\": {\\n        \\\"commissionPercent\\\": 30\\n    },\\n    \\\"payoutInfo\\\": [{\\n        \\\"payoutType\\\": \\\"ACH\\\",\\n        \\\"baseCurrency\\\": \\\"USD\\\",\\n        \\\"nameOnAccount\\\": \\\"vendor\\\",\\n        \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n        \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n        \\\"bankName\\\": \\\"Leumi\\\",\\n        \\\"bankId\\\": \\\"12445\\\",\\n        \\\"country\\\": \\\"US\\\",\\n        \\\"state\\\":\\\"MA\\\",\\n        \\\"city\\\": \\\"Juneau\\\",\\n        \\\"address\\\": \\\"1 bank address\\\",\\n        \\\"zip\\\": \\\"12345\\\",\\n        \\\"bankAccountId\\\": \\\"36628822\\\", \\n      \\t\\\"minimalPayoutAmount\\\": 50\\n    }]\\n  }\",\n      \"language\": \"json\",\n      \"name\": \"JSON\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"create-vendor","type":"post","title":"Create Vendor"}

Definition

{{ api_url }}{{ page_api_url }}

Documentation

The Create Vendor request enables you to set up a new vendor who will be associated with your marketplace. The Create Vendor request is where you submit the vendors KYC information, their banking information, the agreed upon commission split and so on.

Important: Vendor verification requirements

To begin processing transactions, the vendor's country and email are required.

To be eligible for payout, additional vendor information is needed. To see the payout requirements, click here.

Request Content

vendor container    required, contains the following properties (see vendor):
      email string    required      
      name string     optional
      firstName string     optional
      lastName string     optional
      phone string    optional
      address string    optional
      city string   optional
      country string    required
      state string   optional    applicable if country = US or CA (See State and Province Codes).
      zip string   optional
      taxId string    optional
      vatId string    optional
      defaultPayoutCurrency string    optional    
      frequency string    optional    
      delay integer    optional    
      vendorPrincipal container     optional; (see vendorPrincipal)
      vendorAgreement container     optional; (see vendorAgreement)
      payoutInfo container    optional; (see payoutInfo)

Response Details

If successful, the response HTTP status code is 201 Created.
The response body contains the vendorId.
The vendorId is required for all future transactions associated with this vendor.


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "email": "vendor@example.com",
    "firstName": "Joe",
    "lastName": "Smith",
    "phone": "1-123-456-7890",
    "address": "123 Main Street",
    "city": "Boston",
    "country": "US",
    "state":"MA",
    "zip": "123456",
    "defaultPayoutCurrency": "USD", 
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "123456",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "561196411",
        "email": "individual.vendor@bluesnap.com"
    },
    "vendorAgreement": {
        "commissionPercent": 30
    },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "vendor",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "PERSONAL",
        "bankName": "Leumi",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Juneau",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822", 
        "minimalPayoutAmount": 50
    }]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "name": "Business ABC", 
    "email": "vendor@example.com", 
    "phone": "1-123-455-8765", 
    "address": "25 Business Avenue", 
    "city": "Boston", 
    "country": "US", 
    "state": "MA", 
    "zip": "123456", 
    "taxId": "123456789",
    "defaultPayoutCurrency": "USD", 
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "12345",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "561196411",
        "email": "principal.vendor@email.com"
    }, 
    "vendorAgreement": {
        "commissionPercent": 30
      },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "name of vendor account",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "CORPORATE",
        "bankName": "Bank of America",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Boston",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822",
        "minimalPayoutAmount": 50
      }]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{ 
    "email": "jane.shopper@bluesnap.com", 
    "country": "US"
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
    "email": "individual_vendor@example.com",
    "firstName": "Joe",
    "lastName": "Smith",
    "phone": "1-123-456-7890",
    "address": "123 Main Street",
    "city": "Boston",
    "country": "US",
    "state":"MA",
    "zip": "123456",
    "defaultPayoutCurrency": "USD", 
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Boston",
        "country": "US",
        "zip": "123456",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
      	"driverLicenseNumber": "561196411",
        "email": "individual_vendor@bluesnap.com"
    },
    "vendorAgreement": {
        "commissionPercent": 30
    },
    "payoutInfo": [
    {
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "vendor",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "PERSONAL",
        "bankName": "Leumi",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Juneau",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822"
    }, 
    {
       "payoutType": "CHAPS",
       "baseCurrency": "GBP",
       "nameOnAccount": "Jane Shopper",
       "bankAccountType": "CHECKING",
       "bankAccountClass": "PERSONAL",
       "bankName": "Barclays",
       "bankId": "12445",
       "iban": "377438437843847300022",
       "country": "UK",
       "city": "Luton",
       "address": "28 George St",
       "zip": "LU1 2AE",
       "bankAccountId": "36628822"
  }
  ]
}'

Response Examples

HTTP/ 1.1 201 Created
Location: https://sandbox.bluesnap.com/services/2/vendors/19575974

Example Descriptions

Create Vendor: Individual

This example shows a Create Vendor request with sufficient information to fully board an individual vendor. To see the required information for payout, click here. Since frequency and delay were not included in the request, the vendor's payout schedule will default to the Marketplace Merchant's approved schedule with BlueSnap.

Create Vendor: Business

This example shows a Create Vendor request with sufficient information to fully board a business vendor. Note that the primary difference between boarding a business vendor and an individual vendors is that business vendors will require the name and a taxId or vatId. To see the required information for payout, click here. Since frequency and delay were not included in the request, the vendor's payout schedule will default to the Marketplace Merchant's approved schedule with BlueSnap.

Create Vendor: minimal details

This example shows a Create Vendor request with the minimal required fields to get started boarding a new vendor. These details will allow you to send transactions for processing on behalf of the vendor. However, until all necessary vendor information is submitted, payout will be on-hold.

Create Vendor: with 2 bank accounts

This example shows a Create Vendor request for an individual vendor with 2 bank accounts. The vendor's bank account details are included within separate objects inside the payoutInfo container (1 bank account per object). In this particular example, the vendor will be paid out in USD (via ACH) and GBP (via CHAPS). Their default payout currency is USD.

The following conversion logic will apply:

  • Since the vendor's payout currencies are USD and GBP, if a sale occurs in a either of these currencies, the sales funds will be paid out to the associated bank account.
  • Since the vendor's default payout currency is USD, if a sale occurs in a currency other than USD or GBP, the sales funds will be converted to USD and paid out to the associated bank account.



Back to Top

API Explorer

To test out a call, enter the request content below and then click Try it!

Tip: Use the JSON code below as a starting point. You can enter different parameters to see how your test scenario would work. The request headers, including authorization, are already built in for you in this test area, so you should not include them here.

 {
    "email": "vendor@bluesnap.com",
    "name": "Important Vendor",
    "firstName": "Joe",
    "lastName": "Smith",
    "phone": "0549766778",
    "address": "123 Main Street",
    "city": "Juneau",
    "country": "US",
    "state":"MA",
    "zip": "4640802",
    "taxId": "123456789",
    "defaultPayoutCurrency": "USD", 
    "vendorPrincipal": {
        "firstName": "Joe",
        "lastName": "Smith",
        "address": "123 Main Street",
        "city": "Juneau",
        "country": "US",
        "zip": "12345",
        "dob": "28-09-9999",
        "personalIdentificationNumber": "1234",
        "driverLicenseNumber": "561196411",
        "email": "principal.name@vendor.com"
    },
    "vendorAgreement": {
        "commissionPercent": 30
    },
    "payoutInfo": [{
        "payoutType": "ACH",
        "baseCurrency": "USD",
        "nameOnAccount": "vendor",
        "bankAccountType": "CHECKING",
        "bankAccountClass": "PERSONAL",
        "bankName": "Leumi",
        "bankId": "12445",
        "country": "US",
        "state":"MA",
        "city": "Juneau",
        "address": "1 bank address",
        "zip": "12345",
        "bankAccountId": "36628822", 
      	"minimalPayoutAmount": 50
    }]
  }

User Information

Try It Out


post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}