{"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    \"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]","updates":[],"order":50,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e5d3aa2dc4d35003d784d4e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":13,"from_sync":false,"reference":false,"_id":"5e5d3aa2dc4d35003d784cfb","version":"5e5d3aa2dc4d35003d784d9d","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":"Live","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e5d3aa2dc4d35003d784cf0","5e5d3aa2dc4d35003d784cf1","5e5d3aa2dc4d35003d784cf2","5e5d3aa2dc4d35003d784cf3","5e5d3aa2dc4d35003d784cf4","5e5d3aa2dc4d35003d784cf5","5e5d3aa2dc4d35003d784cf6","5e5d3aa2dc4d35003d784cf7","5e5d3aa2dc4d35003d784cf8","5e5d3aa2dc4d35003d784cf9","5e5d3aa2dc4d35003d784cfa","5e5d3aa2dc4d35003d784cfb","5e5d3aa2dc4d35003d784cfc","5e5d3aa2dc4d35003d784cfd","5e5d3aa2dc4d35003d784cfe","5e5d57ed1362cf0064910881","5e7a7ac40efab8003ae688c3"],"_id":"5e5d3aa2dc4d35003d784d9d","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5c6c23e4735b81006177d0a4","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-12-02T17:06:44.491Z","githubsync":"","__v":0}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Local Bank Transfer transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

vendorAgreement

Request

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.

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