{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"vendorAgreement","type":"basic","slug":"vendoragreement","excerpt":"","body":"###Request\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"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.\",\n \"title\": \"Vendor requirements\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"0-0\": \"commissionPercent\",\n \"0-1\": \"decimal\",\n \"0-2\": \"Optional\",\n \"0-3\": \"Defines the vendor's commission percentage for marketplace transactions. \\n\\nThis value should be between 0-100. If the parameter is not included, it will be set to 0.\",\n \"1-0\": \"accountStatus\",\n \"1-1\": \"string\",\n \"1-2\": \"Optional\",\n \"1-3\": \"Indicates vendor [account status](/docs/vendor-onboarding#section-account-status). \\n\\nPossible values:\\n**ACTIVE**\\n**INACTIVE**\",\n \"2-0\": \"recurringCommission\",\n \"2-1\": \"string\",\n \"2-2\": \"Optional\",\n \"2-3\": \"Indicates if commissions will be included as part of a recurring transaction (subscription)\\n\\nValid values:\\n**Y**\\n**N**\"\n },\n \"cols\": 4,\n \"rows\": 3\n}\n[/block]\n###Response\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"commissionPercent\",\n \"0-1\": \"decimal\",\n \"0-2\": \"Commission percentage split on transactions shared between merchant and vendor\\n\\nThis value should be between 0-100\",\n \"1-0\": \"accountStatus\",\n \"1-1\": \"string\",\n \"1-2\": \"Indicates vendor [account status](/docs/vendor-onboarding#section-account-status). \\n\\nValues returned:\\n**ACTIVE**\\n**INACTIVE**\",\n \"0-3\": \"\",\n \"1-3\": \"\",\n \"h-3\": \"Description\",\n \"2-0\": \"recurringCommission\",\n \"2-1\": \"string\",\n \"2-2\": \"Included as part of a recurring transaction (subscription)\\n\\nValid values:\\n**Y**\\n**N**\"\n },\n \"cols\": 3,\n \"rows\": 3\n}\n[/block]","updates":[],"order":55,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"628531cd1258c8003f6dd217","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"628531cd1258c8003f6dd1ca","version":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.42 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["628531cd1258c8003f6dd1bf","628531cd1258c8003f6dd1c0","628531cd1258c8003f6dd1c1","628531cd1258c8003f6dd1c2","628531cd1258c8003f6dd1c3","628531cd1258c8003f6dd1c4","628531cd1258c8003f6dd1c5","628531cd1258c8003f6dd1c6","628531cd1258c8003f6dd1c7","628531cd1258c8003f6dd1c8","628531cd1258c8003f6dd1c9","628531cd1258c8003f6dd1ca","628531cd1258c8003f6dd1cb","628531cd1258c8003f6dd1cc","628531cd1258c8003f6dd1cd","628531cd1258c8003f6dd1ce","628531cd1258c8003f6dd1cf","628531cd1258c8003f6dd1d0","628531cd1258c8003f6dd1d1","628531cd1258c8003f6dd1d2"],"_id":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"622783372cd60c003782d77e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-12-02T17:06:44.491Z","githubsync":"","__v":0}
vendorAgreement
Vendor 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.
commissionPercent
decimal
Optional
Defines the vendor's commission percentage for marketplace transactions.
This value should be between 0-100. If the parameter is not included, it will be set to 0.
recurringCommission
string
Optional
Indicates if commissions will be included as part of a recurring transaction (subscription)
Valid values:
Y
N
commissionPercent
decimal
Commission percentage split on transactions shared between merchant and vendor
This value should be between 0-100
recurringCommission
string
Included as part of a recurring transaction (subscription)
Valid values:
Y
N