{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vendors/:vendorId","auth":"optional","examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","params":[{"name":"vendorId","type":"int","default":"","desc":"BlueSnap identifier for the vendor","required":true,"in":"path","ref":"","_id":"586e74439d4a1d3700763687"}]},"next":{"description":"","pages":[]},"title":"Retrieve Vendor","type":"endpoint","slug":"retrieve-vendor","excerpt":"","body":"[block:html]\n{\n \"html\": \"<script>\\n // hide body textbox of API Explorer\\n $(document).ready(function() {\\n $(\\\"textarea[placeholder='Body Content']\\\").hide(); \\n }); \\n</script>\"\n}\n[/block]\nThe Retrieve Vendor request enables you to retrieve details about one existing vendor.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer-for-request-based-on-vendorid-\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nEnter the `vendorId` into the web service URL, in the format:\n`services/2/vendors/{vendorId}`\n\nFor example:\n`services/2/vendors/2111111`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved [vendor](doc:vendorinfo).\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors/837389 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Vendor Request\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"vendorId\\\": 837389,\\n \\\"email\\\": \\\"vendor:::at:::example.com\\\",\\n \\\"name\\\": \\\"Default Vendor\\\",\\n \\\"ipnUrl\\\": \\\"https://ipnaddress.com\\\",\\n \\\"firstName\\\": \\\"Joe\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"address\\\": \\\"123 Main Street\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"zip\\\": \\\"123456\\\",\\n \\\"country\\\": \\\"us\\\",\\n \\\"phone\\\": \\\"1-123-456-7890\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"defaultPayoutCurrency\\\": \\\"USD\\\",\\n \\\"frequency\\\": \\\"MONTHLY\\\",\\n \\\"delay\\\": 15,\\n \\\"vendorPrincipal\\\": {\\n \\\"firstName\\\": \\\"Joe\\\",\\n \\\"lastName\\\": \\\"Smith\\\",\\n \\\"address\\\": \\\"123 Main Street\\\",\\n \\\"city\\\": \\\"Boston\\\",\\n \\\"zip\\\": \\\"123456\\\",\\n \\\"country\\\": \\\"US\\\",\\n \\\"dob\\\": \\\"28-09-9999\\\",\\n \\\"personalIdentificationNumber\\\": \\\"1234\\\",\\n \\\"driverLicenseNumber\\\": \\\"561196411\\\",\\n \\\"email\\\": \\\"[email protected]\\\"\\n },\\n \\\"payoutInfo\\\": [\\n {\\n \\\"payoutType\\\": \\\"ACH\\\",\\n \\\"baseCurrency\\\": \\\"USD\\\",\\n \\\"minimalPayoutAmount\\\": \\\"50\\\",\\n \\\"nameOnAccount\\\": \\\"vendor\\\",\\n \\\"bankAccountClass\\\": \\\"PERSONAL\\\",\\n \\\"bankAccountType\\\": \\\"CHECKING\\\",\\n \\\"bankName\\\": \\\"Leumi\\\",\\n \\\"bankId\\\": \\\"123456789\\\",\\n \\\"country\\\": \\\"us\\\",\\n \\\"city\\\": \\\"Juneau\\\",\\n \\\"address\\\": \\\"1 bank address\\\",\\n \\\"state\\\": \\\"MA\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"bankAccountId\\\": \\\"36628822\\\",\\n \\\"intermediaryBankInfo\\\": {},\\n \\\"paymentReference\\\": \\\"Payment for vendor 1234\\\"\\n }\\n ],\\n \\\"vendorAgreement\\\": {\\n \\\"commissionPercent\\\": 30,\\n \\\"accountStatus\\\": \\\"ACTIVE\\\",\\n \\\"recurringCommission\\\": \\\"Y\\\"\\n },\\n \\\"verification\\\": {\\n \\\"payoutStatus\\\": \\\"Approved\\\",\\n \\\"processingStatus\\\": \\\"Active\\\"\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve Vendor Response\"\n }\n ]\n}\n[/block]\n##Example Descriptions\n\n###Retrieve Vendor: full details\nThis example shows a vendor retrieval based on `vendorId`. This vendor's processing status is **Active**, which means they can have transactions processed on their behalf. Their payout status is **Incomplete**, which means BlueSnap has not been provided with sufficient information to fully board this vendor (payout is suspended at this time). `missingItems` inside of `verification` provides a list of the missing information needed for the vendor to be eligible for payout. \n\nThe following properties are missing: \n* `phone` and `address` inside `vendor`\n* `personalIdentificationNumber` inside `vendorPrincipal` \n\nFor more information, visit the [Marketplace Guide](/docs/vendor-onboarding#section-understanding-your-vendor-s-statuses).\n<hr>\n\n##API Explorer (for request based on vendorId)\nTo test out a call, enter an existing vendor ID (e.g *837389*) in the `vendorId` field. This will automatically insert the ID into the request URL.","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff39c12e2e8fa00503ad5a6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Marketplace","slug":"marketplace","order":12,"from_sync":false,"reference":false,"_id":"5ff39c12e2e8fa00503ad535","version":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-11-23T19:23:42.327Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff39c12e2e8fa00503ad52d","5ff39c12e2e8fa00503ad52e","5ff39c12e2e8fa00503ad52f","5ff39c12e2e8fa00503ad530","5ff39c12e2e8fa00503ad531","5ff39c12e2e8fa00503ad532","5ff39c12e2e8fa00503ad533","5ff39c12e2e8fa00503ad534","5ff39c12e2e8fa00503ad535","5ff39c12e2e8fa00503ad536","5ff39c12e2e8fa00503ad537","5ff39c12e2e8fa00503ad538","5ff39c12e2e8fa00503ad539","5ff39c12e2e8fa00503ad53a","5ff39c12e2e8fa00503ad53b","5ff39c12e2e8fa00503ad53c","5ff39c12e2e8fa00503ad53d","5ff39c12e2e8fa00503ad53e","5ff39c12e2e8fa00503ad53f"],"_id":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fc6c6094cb8fa066b0d2ea3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-11-23T19:25:17.640Z","githubsync":"","__v":6}getRetrieve Vendor
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
vendorId:
required
integer
BlueSnap identifier for the vendor
Documentation
The Retrieve Vendor request enables you to retrieve details about one existing vendor.
Request Content
Enter the vendorId into the web service URL, in the format:services/2/vendors/{vendorId}
For example:services/2/vendors/2111111
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the retrieved vendor.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors/837389 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='{
"vendorId": 837389,
"email": "[email protected]",
"name": "Default Vendor",
"ipnUrl": "https://ipnaddress.com",
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"zip": "123456",
"country": "us",
"phone": "1-123-456-7890",
"state": "MA",
"defaultPayoutCurrency": "USD",
"frequency": "MONTHLY",
"delay": 15,
"vendorPrincipal": {
"firstName": "Joe",
"lastName": "Smith",
"address": "123 Main Street",
"city": "Boston",
"zip": "123456",
"country": "US",
"dob": "28-09-9999",
"personalIdentificationNumber": "1234",
"driverLicenseNumber": "561196411",
"email": "[email protected]"
},
"payoutInfo": [
{
"payoutType": "ACH",
"baseCurrency": "USD",
"minimalPayoutAmount": "50",
"nameOnAccount": "vendor",
"bankAccountClass": "PERSONAL",
"bankAccountType": "CHECKING",
"bankName": "Leumi",
"bankId": "123456789",
"country": "us",
"city": "Juneau",
"address": "1 bank address",
"state": "MA",
"zip": "12345",
"bankAccountId": "36628822",
"intermediaryBankInfo": {},
"paymentReference": "Payment for vendor 1234"
}
],
"vendorAgreement": {
"commissionPercent": 30,
"accountStatus": "ACTIVE",
"recurringCommission": "Y"
},
"verification": {
"payoutStatus": "Approved",
"processingStatus": "Active"
}
}Example Descriptions
Retrieve Vendor: full details
This example shows a vendor retrieval based on vendorId. This vendor's processing status is Active, which means they can have transactions processed on their behalf. Their payout status is Incomplete, which means BlueSnap has not been provided with sufficient information to fully board this vendor (payout is suspended at this time). missingItems inside of verification provides a list of the missing information needed for the vendor to be eligible for payout.
The following properties are missing:
phoneandaddressinsidevendorpersonalIdentificationNumberinsidevendorPrincipal
For more information, visit the Marketplace Guide.
API Explorer (for request based on vendorId)
To test out a call, enter an existing vendor ID (e.g 837389) in the vendorId field. This will automatically insert the ID into the request URL.
