Create Vendor

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Entrypoint identifier.

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

Primary name for vendor. Required for new vendor.

Secondary name for vendor.

EIN/Tax ID for vendor.

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

Vendor's email address. Required for vCard.

Vendor's address

Additional line for vendor's address.

Vendor's city.

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

Vendor's zip code.

Vendor's country.

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

Additional location code used to identify the vendor.

Array of objects describing the vendor's contacts.

Object containing vendor's bank information.

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

Vendor's status. Allowed status:

• 0 Inactive

• 1 Active

Remittance address. Used for mailing paper checks.

Remittance address additional line. Used for mailing paper checks.

Remittance address city. Used for mailing paper checks.

Remittance address state. Used for mailing paper checks.

Remittance address ZIP code. Used for mailing paper checks.

Remittance address country. Used for mailing paper checks.

Alternative name used to receive paper check.

Alternative name used to receive paper check.

Account number of paypoint in the vendor side.

Internal identifier for global vendor account.

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"
  }
}

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Response text for operation: 'Success' or 'Declined'.

Code for the response. Learn more in API Response Codes.

Auxiliary validation used internally by payment pages and components.

If the request was successful, this field contains the identifier for the vendor.