The Create Vendor request enables you to set up a new vendor that will be associated with your marketplace. Use this request to submit the vendor's KYC information, their banking information, the agreed-upon commission split, etc.
Important: Vendor verification requirements
Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; however, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.
In addition, to be eligible for payout, the vendor must meet vendor verification requirements.
Tip
You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.
Request Content
vendor container required, contains the following properties (see vendor):
| Property | Type | Required |
|---|---|---|
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 |
vendorUrl | string | optional |
defaultPayoutCurrency | string | optional |
frequency | string | optional |
delay | integer | optional |
vendorPrincipal | container | optional; (see vendorPrincipal) |
vendorAgreement | container | optional; (see vendorAgreement) |
payoutInfo | container | Optional. Inherits BlueSnap merchant’s payout bank settings by default. (See payoutInfo) |
ipnUrl | string | optional |
Response Details
If successful, the response HTTP status code is 201 Created.
The response header 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 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"email": "[email protected]",
"firstName": "Joe",
"lastName": "Smith",
"phone": "1-123-456-7890",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"state": "MA",
"zip": "02453",
"defaultPayoutCurrency": "USD",
"ipnUrl": "https://ipnaddress.com",
"vendorPrincipal": {
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"zip": "02453",
"dob": "28-09-9999",
"personalIdentificationNumber": "1234",
"driverLicenseNumber": "561196411",
"email": "[email protected]"
},
"vendorAgreement": {
"commissionPercent": 30
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"nameOnAccount": "vendor",
"bankAccountType": "CHECKING",
"bankAccountClass": "PERSONAL",
"bankName": "Leumi",
"bankId": "123456789",
"country": "US",
"state": "MA",
"city": "Juneau",
"address": "1 bank address",
"zip": "02453",
"bankAccountId": "36628822",
"minimalPayoutAmount": 50,
"paymentReference": "Payment for vendor 1234",
"refundReserve": 200
}
]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"name": "Business ABC",
"email": "[email protected]",
"phone": "1-123-455-8765",
"address": "25 Business Avenue",
"city": "Boston",
"country": "US",
"state": "MA",
"zip": "02453",
"taxId": "123456789",
"vendorUrl": "http://mycompany.com",
"ipnUrl": "https://ipnaddress.com",
"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": "[email protected]"
},
"vendorAgreement": {
"commissionPercent": 30
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"nameOnAccount": "name of vendor account",
"bankAccountType": "CHECKING",
"bankAccountClass": "CORPORATE",
"bankName": "Bank of America",
"bankId": "123456789",
"country": "US",
"state": "MA",
"city": "Boston",
"address": "1 bank address",
"zip": "02453",
"bankAccountId": "36628822",
"minimalPayoutAmount": 50,
"paymentReference": "Payment for vendor 1234",
"refundReserve": 200
}
]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/vendors \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"email": "[email protected]",
"firstName": "Joe",
"lastName": "Smith",
"phone": "1-123-456-7890",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"state": "MA",
"zip": "02453",
"defaultPayoutCurrency": "USD",
"ipnUrl": "https://ipnaddress.com",
"vendorPrincipal": {
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"country": "US",
"zip": "123456",
"dob": "28-09-9999",
"personalIdentificationNumber": "1234",
"driverLicenseNumber": "561196411",
"email": "[email protected]"
},
"vendorAgreement": {
"commissionPercent": 30
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"nameOnAccount": "vendor",
"bankAccountType": "CHECKING",
"bankAccountClass": "PERSONAL",
"bankName": "Leumi",
"bankId": "123456789",
"country": "US",
"state": "MA",
"city": "Juneau",
"address": "1 bank address",
"zip": "02453",
"bankAccountId": "36628822",
"minimalPayoutAmount": 25,
"paymentReference": "Payment for vendor 1234",
"refundReserve": 200
},
{
"payoutType": "CHAPS",
"baseCurrency": "GBP",
"nameOnAccount": "Jane Shopper",
"bankAccountType": "CHECKING",
"bankAccountClass": "PERSONAL",
"bankName": "Barclays",
"bankId": "123456",
"country": "UK",
"city": "Luton",
"address": "28 George St",
"zip": "LU1 2AE",
"bankAccountId": "36628822",
"minimalPayoutAmount": 25,
"paymentReference": "Payment for vendor 1234"
}
]
}'
Response Examples
HTTP/ 1.1 201 Created
Location: https://sandbox.bluesnap.com/services/2/vendors/19575974
API Explorer
To test out a basic API request, click the "Try It!" button in the right-hand column to test using the default, pre-populated sample values. To test with your own values, edit the parameter fields below. You'll see them populate in the right-hand column and you can click the "Try It!" button to submit your test request and see a response.