{"_id":"58af21bc9afab3250060e8a7","project":"55dd0853d2d97337001800e2","user":"55dd080d0efd5821000d53b3","__v":0,"githubsync":"","parentDoc":null,"version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"category":{"_id":"58af1bf6ebd7370f0078ba09","__v":0,"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-23T17:29:26.972Z","from_sync":false,"order":12,"slug":"payouts","title":"Payouts"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T17:54:04.765Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"5693eae65f1c951900644c21","examples":{"codes":[]},"method":"post","results":{"codes":[{"code":"","language":"text"}]},"auth":"required","params":[],"url":"/vendors"},"isReference":false,"order":4,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Only create vendors from properly verified customers\",\n  \"body\": \"Though it is certainly possible to create vendors immediately after creating the customer that the vendor represents, the customer can only receive payout funds in their bank account once they are marked as verified.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"0-0\": \"customerId\",\n    \"0-1\": \"Required\",\n    \"1-0\": \"name\",\n    \"1-1\": \"Optional\",\n    \"2-0\": \"email\",\n    \"2-1\": \"Optional\",\n    \"3-0\": \"contact\",\n    \"3-1\": \"Optional\",\n    \"4-0\": \"address\",\n    \"4-1\": \"Optional\",\n    \"5-0\": \"meta\",\n    \"5-1\": \"Optional\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"Authorization\\\": \\\"Bearer 8xwEjewopIwfasp28ai6VnqNJEEr2Gow\\\",\\n  \\\"X-CUSTOMER-ID\\\": \\\"1ad07cc4c0094164fdeae30\\\",\\n  \\\"Accept\\\": \\\"application/json\\\",\\n  \\\"Content-Type\\\": \\\"application/json\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Headers\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"Systems Vendor\\\",\\n  \\\"email\\\": \\\"system:::at:::vendor.com\\\",\\n  \\\"address\\\": {\\n    \\\"street1\\\": \\\"123 Street\\\",\\n    \\\"city\\\": \\\"Santa Cruz\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"postalCode\\\": \\\"95066\\\",\\n    \\\"country\\\": \\\"USA\\\"\\n  },\\n  \\\"contact\\\": {\\n    \\\"fullName\\\": \\\"Joshi Blair\\\",\\n    \\\"firstName\\\": \\\"Joshi\\\",\\n    \\\"lastName\\\": \\\"Blair\\\",\\n    \\\"email\\\": \\\"Joshi.Blair@vendor.com\\\",\\n    \\\"phone\\\": \\\"8318318311\\\",\\n    \\\"dateOfBirth\\\": \\\"08-15-1994\\\"\\n  },\\n  \\\"customerId\\\": \\\"227dzij9qengkide1x2ln3zw\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Request\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"object\\\": \\\"vendor\\\",\\n  \\\"id\\\": \\\"80uhozbkyflokvldgwsjrked\\\",\\n  \\\"name\\\": \\\"Systems Vendor\\\",\\n  \\\"email\\\": \\\"system@vendor.com\\\",\\n  \\\"address\\\": {\\n    \\\"street1\\\": \\\"123 Street\\\",\\n    \\\"city\\\": \\\"Santa Cruz\\\",\\n    \\\"state\\\": \\\"CA\\\",\\n    \\\"postalCode\\\": \\\"95066\\\",\\n    \\\"country\\\": \\\"USA\\\"\\n  },\\n  \\\"contact\\\": {\\n    \\\"fullName\\\": \\\"Joshi Blair\\\",\\n    \\\"firstName\\\": \\\"Joshi\\\",\\n    \\\"lastName\\\": \\\"Blair\\\",\\n    \\\"email\\\": \\\"Joshi.Blair@vendor.com\\\",\\n    \\\"phone\\\": \\\"8318318311\\\",\\n    \\\"dateOfBirth\\\": \\\"08-15-1994\\\"\\n  },\\n  \\\"customerId\\\": \\\"227dzij9qengkide1x2ln3zw\\\",\\n  \\\"status\\\": \\\"active\\\",\\n  \\\"created\\\": \\\"2017-02-14T05:36:18.000Z\\\",\\n  \\\"lastUpdated\\\": \\\"2017-02-14T05:36:18.000Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"Create a vendor to be paid out","slug":"create-a-vendor","type":"endpoint","title":"Create a vendor"}

postCreate a vendor

Create a vendor to be paid out

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:callout] { "type": "danger", "title": "Only create vendors from properly verified customers", "body": "Though it is certainly possible to create vendors immediately after creating the customer that the vendor represents, the customer can only receive payout funds in their bank account once they are marked as verified." } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Required", "0-0": "customerId", "0-1": "Required", "1-0": "name", "1-1": "Optional", "2-0": "email", "2-1": "Optional", "3-0": "contact", "3-1": "Optional", "4-0": "address", "4-1": "Optional", "5-0": "meta", "5-1": "Optional" }, "cols": 2, "rows": 6 } [/block] [block:code] { "codes": [ { "code": "{\n \"Authorization\": \"Bearer 8xwEjewopIwfasp28ai6VnqNJEEr2Gow\",\n \"X-CUSTOMER-ID\": \"1ad07cc4c0094164fdeae30\",\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\"\n}", "language": "json", "name": "Headers" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"name\": \"Systems Vendor\",\n \"email\": \"system@vendor.com\",\n \"address\": {\n \"street1\": \"123 Street\",\n \"city\": \"Santa Cruz\",\n \"state\": \"CA\",\n \"postalCode\": \"95066\",\n \"country\": \"USA\"\n },\n \"contact\": {\n \"fullName\": \"Joshi Blair\",\n \"firstName\": \"Joshi\",\n \"lastName\": \"Blair\",\n \"email\": \"Joshi.Blair@vendor.com\",\n \"phone\": \"8318318311\",\n \"dateOfBirth\": \"08-15-1994\"\n },\n \"customerId\": \"227dzij9qengkide1x2ln3zw\"\n}", "language": "json", "name": "Request" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"object\": \"vendor\",\n \"id\": \"80uhozbkyflokvldgwsjrked\",\n \"name\": \"Systems Vendor\",\n \"email\": \"system@vendor.com\",\n \"address\": {\n \"street1\": \"123 Street\",\n \"city\": \"Santa Cruz\",\n \"state\": \"CA\",\n \"postalCode\": \"95066\",\n \"country\": \"USA\"\n },\n \"contact\": {\n \"fullName\": \"Joshi Blair\",\n \"firstName\": \"Joshi\",\n \"lastName\": \"Blair\",\n \"email\": \"Joshi.Blair@vendor.com\",\n \"phone\": \"8318318311\",\n \"dateOfBirth\": \"08-15-1994\"\n },\n \"customerId\": \"227dzij9qengkide1x2ln3zw\",\n \"status\": \"active\",\n \"created\": \"2017-02-14T05:36:18.000Z\",\n \"lastUpdated\": \"2017-02-14T05:36:18.000Z\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]