{"_id":"5bedd214812951004a2ad9a7","category":{"_id":"5bedd214812951004a2ad94e","version":"5bedd214812951004a2ad9df","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"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5bedd214812951004a2ad9df","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bcf36ac4eaaa605217d94b8","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5bedd214812951004a2ad943","5bedd214812951004a2ad944","5bedd214812951004a2ad945","5bedd214812951004a2ad946","5bedd214812951004a2ad947","5bedd214812951004a2ad948","5bedd214812951004a2ad949","5bedd214812951004a2ad94a","5bedd214812951004a2ad94b","5bedd214812951004a2ad94c","5bedd214812951004a2ad94d","5bedd214812951004a2ad94e","5bedd214812951004a2ad94f","5bedd214812951004a2ad950","5bedd214812951004a2ad951"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.28 Release","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-02T17:06:33.565Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":50,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`firstName`\",\n    \"2-0\": \"`address`\",\n    \"4-0\": \"`city`\",\n    \"5-0\": \"`country`\",\n    \"7-0\": \"`dob`\",\n    \"1-0\": \"`lastName`\",\n    \"6-0\": \"`zip`\",\n    \"11-0\": \"`email`\",\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Description\",\n    \"0-1\": \"*string*\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"11-1\": \"*string*\",\n    \"7-1\": \"*string*\",\n    \"0-2\": \"**Required**\",\n    \"1-2\": \"**Required**\",\n    \"2-2\": \"**Required**\",\n    \"4-2\": \"**Required**\",\n    \"6-2\": \"**Required**\",\n    \"7-2\": \"**Required**\",\n    \"11-2\": \"**Required**\",\n    \"5-2\": \"**Required**\",\n    \"0-3\": \"First name of vendor principal owner. Maximum 40 characters.\",\n    \"2-3\": \"Address of vendor principal owner. Maximum 60 characters.\",\n    \"1-3\": \"Last name of vendor principal owner. Maximum 40 characters.\",\n    \"4-3\": \"City of vendor principal owner. Maximum 40 characters.\",\n    \"5-3\": \"Country code of vendor principal owner. See [Country Codes](doc:country-codes).\",\n    \"6-3\": \"Zip of vendor principal owner. Maximum 20 characters.\",\n    \"7-3\": \"Date of Birth of vendor principal owner\\n\\nFormat: dd-mm-yyyy\",\n    \"11-3\": \"Email address of vendor principal owner. Maximum 150 characters.\",\n    \"3-0\": \"`address2`\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"Optional\",\n    \"3-3\": \"Address line 2 of vendor principal owner. Maximum 60 characters.\",\n    \"8-0\": \"`personalIdentificationNumber`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"**Required**\",\n    \"8-3\": \"In the US, this value is the last four digits of the principal owner's Social Security Number. \\n\\nIn countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number. \\n\\nMaximum 25 characters.\",\n    \"9-0\": \"`driverLicenseNumber`\",\n    \"9-1\": \"*string*\",\n    \"9-2\": \"**Required** if vendor principal country is US\",\n    \"9-3\": \"Driver license number of vendor principal owner. Maximum 20 alphanumeric characters.\",\n    \"10-0\": \"`passportNumber`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"**Required** if vendor principal country is not US\",\n    \"10-3\": \"Passport number of vendor principal owner. Maximum 20 alphanumeric characters.\"\n  },\n  \"cols\": 4,\n  \"rows\": 12\n}\n[/block]","excerpt":"","slug":"vendorprincipal","type":"basic","title":"vendorPrincipal"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

vendorPrincipal

Request

Property Name
Type
Required
Description

firstName

string

Required

First name of vendor principal owner. Maximum 40 characters.

lastName

string

Required

Last name of vendor principal owner. Maximum 40 characters.

address

string

Required

Address of vendor principal owner. Maximum 60 characters.

address2

string

Optional

Address line 2 of vendor principal owner. Maximum 60 characters.

city

string

Required

City of vendor principal owner. Maximum 40 characters.

country

string

Required

Country code of vendor principal owner. See Country Codes.

zip

string

Required

Zip of vendor principal owner. Maximum 20 characters.

dob

string

Required

Date of Birth of vendor principal owner

Format: dd-mm-yyyy

personalIdentificationNumber

string

Required

In the US, this value is the last four digits of the principal owner's Social Security Number.

In countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number.

Maximum 25 characters.

driverLicenseNumber

string

Required if vendor principal country is US

Driver license number of vendor principal owner. Maximum 20 alphanumeric characters.

passportNumber

string

Required if vendor principal country is not US

Passport number of vendor principal owner. Maximum 20 alphanumeric characters.

email

string

Required

Email address of vendor principal owner. Maximum 150 characters.