Create Vendor
Creates a vendor in an entrypoint.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Entrypoint identifier.
"8cfec329267"
Body
Custom number identifying the vendor. Must be unique in paypoint.
"1234"
Primary name for vendor. Required for new vendor.
"Herman's Coatings and Masonry"
Secondary name for vendor.
EIN/Tax ID for vendor.
"12-3456789"
Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.
"5555555555"
Vendor's email address. Required for vCard.
320
"example@email.com"
Vendor's address
"123 Ocean Drive"
Additional line for vendor's address.
"Suite 400"
Vendor's city.
"Miami"
Vendor's state. Must be a 2 character state code.
"FL"
Vendor's zip code.
"33139"
Vendor's country.
"US"
Business Merchant Category Code (MCC). This resource lists MCC codes.
"7777"
Additional location code used to identify the vendor.
"MIA123"
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
1
Remittance address. Used for mailing paper checks.
"123 Walnut Street"
Remittance address additional line. Used for mailing paper checks.
"Suite 900"
Remittance address city. Used for mailing paper checks.
"Miami"
Remittance address state. Used for mailing paper checks.
"FL"
Remittance address ZIP code. Used for mailing paper checks.
"31113"
Remittance address country. Used for mailing paper checks.
"US"
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Account number of paypoint in the vendor side.
"A-37622"
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
Code for the response. Learn more in API Response Codes.
1
Auxiliary validation used internally by payment pages and components.
null
If the request was successful, this field contains the identifier for the vendor.
3893
Was this page helpful?