​
vendorNumber
string | null

Custom number identifying the vendor. Must be unique in paypoint.

Example:

"1234"

​
name1
string

Primary name for vendor. Required for new vendor.

Example:

"Herman's Coatings and Masonry"

​
name2
string | null

Secondary name for vendor.

​
ein
string

EIN/Tax ID for vendor.

Example:

"12-3456789"

​
phone
string | null

Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.

Example:

"5555555555"

​
email
string | null

Vendor's email address. Required for vCard.

Maximum length: 320
Example:

"example@email.com"

​
address1
string | null

Vendor's address

Example:

"123 Ocean Drive"

​
address2
string | null

Additional line for vendor's address.

Example:

"Suite 400"

​
city
string

Vendor's city.

Example:

"Miami"

​
state
string

Vendor's state. Must be a 2 character state code.

Example:

"FL"

​
zip
string

Vendor's zip code.

Example:

"33139"

​
country
string

Vendor's country.

Example:

"US"

​
mcc
string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Example:

"7777"

​
locationCode
string | null

Additional location code used to identify the vendor.

Example:

"MIA123"

​
contacts
object[] | null

Array of objects describing the vendor's contacts.

​
billingData
object

Object containing vendor's bank information.

​
paymentMethod
object

Object containing details about the payment method to use for the payout.

​
vendorStatus
integer | null

Vendor's status. Allowed status:

  • 0 Inactive

  • 1 Active

Example:

1

​
remitAddress1
string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

​
remitAddress2
string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

​
remitCity
string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

​
remitState
string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

​
remitZip
string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

​
remitCountry
string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

​
payeeName1
string | null

Alternative name used to receive paper check.

​
payeeName2
string | null

Alternative name used to receive paper check.

​
customerVendorAccount
string | null

Account number of paypoint in the vendor side.

Example:

"A-37622"

​
internalReferenceId
integer | null

Internal identifier for global vendor account.

​
AdditionalData
object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Was this page helpful?