{"_id":"59a45d477ee621000fc9d441","category":{"_id":"59a45d447ee621000fc9d3c1","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-23T18:27:07.992Z","from_sync":false,"order":9,"slug":"marketplace","title":"Marketplace"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T18:30:51.542Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"optional","params":[{"_id":"58403464c0507319000634dd","ref":"","in":"path","required":true,"desc":"BlueSnap identifier for the vendor","default":"","type":"int","name":"vendor-id"}],"url":"/vendors/:vendor-id"},"isReference":false,"order":33,"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\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nEnter the `vendor-id` into the web service URL, in the format:\n`services/2/vendors/{vendor-id}`\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-info](doc:vendor).\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/2283845 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Vendor\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<vendor xmlns=\\\"http://ws.plimus.com\\\">\\n  <vendor-id>2283845</vendor-id>\\n  <email>test.vendor:::at:::bluesnap.com</email>\\n  <name>BlueSnap test</name>\\n  <first-name>Jane</first-name>\\n  <last-name>Shopper</last-name>\\n  <city>Newton</city>\\n  <zip>67114</zip>\\n  <country>us</country>\\n  <state>MA</state>\\n  <default-payout-currency>USD</default-payout-currency>\\n  <frequency>DAILY</frequency>\\n  <delay>3</delay>\\n  <vendor-principal>\\n    <first-name>Jane</first-name>\\n    <last-name>Shopper</last-name>\\n    <address>13 Govenor's Street</address>\\n    <city>Boston</city>\\n    <zip>01914</zip>\\n    <country>IL</country>\\n    <dob>28-09-1979</dob>\\n    <driver-license-number>561196411</driver-license-number>\\n    <email>test.vendor@bluesnap.com</email>\\n  </vendor-principal>\\n  <payout-info>\\n    <payout-type>ACH</payout-type>\\n    <base-currency>USD</base-currency>\\n    <minimal-payout-amount>20</minimal-payout-amount>\\n    <name-on-account>Jane Shopper</name-on-account>\\n    <bank-account-class>PERSONAL</bank-account-class>\\n    <bank-account-type>CHECKING</bank-account-type>\\n    <bank-name>First Bank of Newton</bank-name>\\n    <bank-id>12445</bank-id>\\n    <country>us</country>\\n    <city>Newton</city>\\n    <address>128 E Broadway St</address>\\n    <state>KS</state>\\n    <zip>67114</zip>\\n    <bank-account-id>36628822</bank-account-id>\\n    <intermediary-bank-info />\\n  </payout-info>\\n  <vendor-agreement>\\n    <commission-percent>30</commission-percent>\\n    <account-status>ACTIVE</account-status>\\n    <recurring-commission>Y</recurring-commission>\\n  </vendor-agreement>\\n  <verification>\\n    <payout-status>Incomplete</payout-status>\\n    <processing-status>Active</processing-status>\\n    <missing-items>vendor.phone</missing-items>\\n    <missing-items>vendor.address</missing-items>\\n    <missing-items>vendor.principal.personalIdentificationNumber</missing-items>\\n  </verification>\\n</vendor>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Vendor\"\n    }\n  ]\n}\n[/block]\n##Example Descriptions\n\n###Retrieve Vendor: full details\nThis example shows a vendor retrieval based on `vendor-id`. 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). `missing-items` inside of `verification` provides 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* `personal-identification-number` inside `vendor-principal` \n\n<hr>\n\n##API Explorer (for request based on Vendor ID)\nTo test out a call, enter an existing vendor ID (e.g *514147*) in the `vendor-id` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"retrieve-vendor","type":"get","title":"Retrieve Vendor"}

getRetrieve Vendor


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

vendor-id:
required
integer
BlueSnap identifier for the vendor

Documentation

The Retrieve Vendor request enables you to retrieve details about one existing vendor.

Try it in the API Explorer

Request Content

Enter the vendor-id into the web service URL, in the format:
services/2/vendors/{vendor-id}

For example:
services/2/vendors/2111111

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved vendor-info.


Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/vendors/2283845 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

<vendor xmlns="http://ws.plimus.com">
  <vendor-id>2283845</vendor-id>
  <email>test.vendor@bluesnap.com</email>
  <name>BlueSnap test</name>
  <first-name>Jane</first-name>
  <last-name>Shopper</last-name>
  <city>Newton</city>
  <zip>67114</zip>
  <country>us</country>
  <state>MA</state>
  <default-payout-currency>USD</default-payout-currency>
  <frequency>DAILY</frequency>
  <delay>3</delay>
  <vendor-principal>
    <first-name>Jane</first-name>
    <last-name>Shopper</last-name>
    <address>13 Govenor's Street</address>
    <city>Boston</city>
    <zip>01914</zip>
    <country>IL</country>
    <dob>28-09-1979</dob>
    <driver-license-number>561196411</driver-license-number>
    <email>test.vendor@bluesnap.com</email>
  </vendor-principal>
  <payout-info>
    <payout-type>ACH</payout-type>
    <base-currency>USD</base-currency>
    <minimal-payout-amount>20</minimal-payout-amount>
    <name-on-account>Jane Shopper</name-on-account>
    <bank-account-class>PERSONAL</bank-account-class>
    <bank-account-type>CHECKING</bank-account-type>
    <bank-name>First Bank of Newton</bank-name>
    <bank-id>12445</bank-id>
    <country>us</country>
    <city>Newton</city>
    <address>128 E Broadway St</address>
    <state>KS</state>
    <zip>67114</zip>
    <bank-account-id>36628822</bank-account-id>
    <intermediary-bank-info />
  </payout-info>
  <vendor-agreement>
    <commission-percent>30</commission-percent>
    <account-status>ACTIVE</account-status>
    <recurring-commission>Y</recurring-commission>
  </vendor-agreement>
  <verification>
    <payout-status>Incomplete</payout-status>
    <processing-status>Active</processing-status>
    <missing-items>vendor.phone</missing-items>
    <missing-items>vendor.address</missing-items>
    <missing-items>vendor.principal.personalIdentificationNumber</missing-items>
  </verification>
</vendor>

Example Descriptions

Retrieve Vendor: full details

This example shows a vendor retrieval based on vendor-id. 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). missing-items inside of verification provides the missing information needed for the vendor to be eligible for payout.

The following properties are missing:

  • phone and address inside vendor
  • personal-identification-number inside vendor-principal


API Explorer (for request based on Vendor ID)

To test out a call, enter an existing vendor ID (e.g 514147) in the vendor-id field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.


User Information

Try It Out


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