{"_id":"5ab0f574ade4f4003cf6afac","category":{"_id":"5ab0f55fade4f4003cf6af44","version":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5ab0f559ade4f4003cf6af38","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-03-20T11:49:45.000Z","releaseDate":"2018-03-20T11:49:45.000Z","categories":["5ab0f55fade4f4003cf6af39","5ab0f55fade4f4003cf6af3a","5ab0f55fade4f4003cf6af3b","5ab0f55fade4f4003cf6af3c","5ab0f55fade4f4003cf6af3d","5ab0f55fade4f4003cf6af3e","5ab0f55fade4f4003cf6af3f","5ab0f55fade4f4003cf6af40","5ab0f55fade4f4003cf6af41","5ab0f55fade4f4003cf6af42","5ab0f55fade4f4003cf6af43","5ab0f55fade4f4003cf6af44","5ab0f55fade4f4003cf6af45","5ab0f55fade4f4003cf6af46","5ab0f55fade4f4003cf6af47"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-02T17:06:44.491Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":45,"body":"###Request\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    \"1-0\": \"accountStatus\",\n    \"0-1\": \"decimal\",\n    \"1-1\": \"string\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"Optional\",\n    \"0-3\": \"Defines the vendor's commission percentage for marketplace transactions. \\n\\nThis value should be between 0-100.\",\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\": \"Required\",\n    \"0-0\": \"commissionPercent\",\n    \"0-1\": \"decimal\",\n    \"0-2\": \"**Required**\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Optional\",\n    \"1-0\": \"accountStatus\",\n    \"2-0\": \"recurringCommission\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Optional\",\n    \"0-3\": \"Commission percentage split on transactions shared between merchant and vendor\\n\\nThis value should be between 0-100\",\n    \"1-3\": \"Indicates vendor [account status](/docs/vendor-onboarding#section-account-status). \\n\\nValues returned:\\n**ACTIVE**\\n**INACTIVE**\",\n    \"2-3\": \"be included as part of a recurring transaction (subscription)\\n\\nValid values:\\n**Y**\\n**N**\",\n    \"h-3\": \"Description\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"vendoragreement","type":"basic","title":"vendorAgreement"}

Request

Property Name
Type
Required
Description

commissionPercent

decimal

Required

Defines the vendor's commission percentage for marketplace transactions.

This value should be between 0-100.

accountStatus

string

Optional

Indicates vendor account status.

Possible values:
ACTIVE
INACTIVE

recurringCommission

string

Optional

Indicates if commissions will be included as part of a recurring transaction (subscription)

Valid values:
Y
N

Response

Property Name
Type
Required
Description

commissionPercent

decimal

Required

Commission percentage split on transactions shared between merchant and vendor

This value should be between 0-100

accountStatus

string

Optional

Indicates vendor account status.

Values returned:
ACTIVE
INACTIVE

recurringCommission

string

Optional

be included as part of a recurring transaction (subscription)

Valid values:
Y
N