{"_id":"58af1e9412cf192700afef42","githubsync":"","project":"55dd0853d2d97337001800e2","__v":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"},"parentDoc":null,"user":"55dd080d0efd5821000d53b3","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-23T17:40:36.959Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Vendor Definition\",\n  \"body\": \"A Vendor is a **payout sender's private view** of the customer receiving the payout.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Vendors related to the same customer can be different from each other and the original customer\",\n  \"body\": \"Since a Vendor is a payout customer's private view of another customer they can send a payout to, Vendor details representing the same receiver of payouts may differ from one customer sending payouts to another. Moreover it is the customer owning the vendor's prerogative to modify the vendor details to their own needs.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Platform use of Vendors\",\n  \"body\": \"A platform can leverage the vendor concept to present their payout sending customers with an editable representation of the receiver of their payouts by simply using the access controls PayStand provides and without the need for the platform to keep track of all the data and relationships.\"\n}\n[/block]\n\n## Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"0-0\": \"name\",\n    \"1-0\": \"email\",\n    \"2-0\": \"address\",\n    \"3-0\": \"contact\",\n    \"5-0\": \"meta\",\n    \"0-1\": \"**Type**: String\\n**Length**: 0-256 characters\\n**Example**: \\\"Lin Enterprises\\\"\\n**Description**: Vendor name\",\n    \"1-1\": \"**Type**: String\\n**Format**: user:::at:::domain\\n**User Length**: 0-64 characters\\n**Total Length**: 0-256 characters\\n**Example**: \\\"seabass@paystand.com\\\"\",\n    \"2-1\": \"**Type**: JSON Object\\n**Format**: [Address](/docs/address) \\n**Description**: Vendor address.\",\n    \"3-1\": \"**Type**: JSON Object\\n**Format**: [Contact](/docs/contact) \\n**Description**: Vendor contact information.\",\n    \"5-1\": \"**Type**: JSON Object\\n**Format**: [Meta](/docs/meta) \\n**Description**: An optional object to store custom data for the Vendor.\",\n    \"4-0\": \"customerId\",\n    \"4-1\": \"**Type**: String\\n**Format**: PayStand Id\\n**Description**: The PayStand Id for the customer who is to receive a payout.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n## Response\n\nAll Request parameters will also be returned in the Response. The following additional parameters will also be included in responses.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"object\",\n    \"2-0\": \"status__*__\",\n    \"3-0\": \"created\",\n    \"4-0\": \"lastUpdated\",\n    \"0-1\": \"The unique identifier for the vendor.\",\n    \"1-1\": \"Will have value \\\"vendor\\\" indicating that the object is a vendor response.\",\n    \"3-1\": \"The date the bank was created.\",\n    \"4-1\": \"The date the bank was last updated.\",\n    \"2-1\": \"The current status of the vendor account. One of: \\\"created\\\", \\\"active\\\", \\\"inactive\\\"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n__*__ The status is for future use in public networks. Currently the status will alway be 'active' after creation.\n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"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}\",\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":"Payout vendor resource","slug":"vendor-resource","type":"basic","title":"Vendor resource"}

Vendor resource

Payout vendor resource

[block:callout] { "type": "success", "title": "Vendor Definition", "body": "A Vendor is a **payout sender's private view** of the customer receiving the payout." } [/block] [block:callout] { "type": "warning", "title": "Vendors related to the same customer can be different from each other and the original customer", "body": "Since a Vendor is a payout customer's private view of another customer they can send a payout to, Vendor details representing the same receiver of payouts may differ from one customer sending payouts to another. Moreover it is the customer owning the vendor's prerogative to modify the vendor details to their own needs." } [/block] [block:callout] { "type": "info", "title": "Platform use of Vendors", "body": "A platform can leverage the vendor concept to present their payout sending customers with an editable representation of the receiver of their payouts by simply using the access controls PayStand provides and without the need for the platform to keep track of all the data and relationships." } [/block] ## Request [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specification", "0-0": "name", "1-0": "email", "2-0": "address", "3-0": "contact", "5-0": "meta", "0-1": "**Type**: String\n**Length**: 0-256 characters\n**Example**: \"Lin Enterprises\"\n**Description**: Vendor name", "1-1": "**Type**: String\n**Format**: user@domain\n**User Length**: 0-64 characters\n**Total Length**: 0-256 characters\n**Example**: \"seabass@paystand.com\"", "2-1": "**Type**: JSON Object\n**Format**: [Address](/docs/address) \n**Description**: Vendor address.", "3-1": "**Type**: JSON Object\n**Format**: [Contact](/docs/contact) \n**Description**: Vendor contact information.", "5-1": "**Type**: JSON Object\n**Format**: [Meta](/docs/meta) \n**Description**: An optional object to store custom data for the Vendor.", "4-0": "customerId", "4-1": "**Type**: String\n**Format**: PayStand Id\n**Description**: The PayStand Id for the customer who is to receive a payout." }, "cols": 2, "rows": 6 } [/block] ## Response All Request parameters will also be returned in the Response. The following additional parameters will also be included in responses. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "id", "1-0": "object", "2-0": "status__*__", "3-0": "created", "4-0": "lastUpdated", "0-1": "The unique identifier for the vendor.", "1-1": "Will have value \"vendor\" indicating that the object is a vendor response.", "3-1": "The date the bank was created.", "4-1": "The date the bank was last updated.", "2-1": "The current status of the vendor account. One of: \"created\", \"active\", \"inactive\"" }, "cols": 2, "rows": 5 } [/block] __*__ The status is for future use in public networks. Currently the status will alway be 'active' after creation. [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]