APIPay Out endpointsVendor

Create vendor

Creates a vendor in an entrypoint.

Authentication

requestTokenstring
API Key authentication via header

Path Parameters

entrystringRequired
Entrypoint identifier.

Request

This endpoint expects an object.
vendorNumberstringOptional
Custom number identifying the vendor. Must be unique in paypoint.
AdditionalDatamap from strings to optional maps from strings to anyOptional
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developers/developer-guides/entities-customers), pass those in this object. Max length for a value is 100 characters. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
address1stringOptional
Vendor's address
address2stringOptional
Additional line for vendor's address.
billingDataobjectOptional
Object containing vendor's bank information.
citystringOptional
Vendor's city.
contactslist of objectsOptional
Array of objects describing the vendor's contacts.
countrystringOptional
Vendor's country.
customField1stringOptional
Custom field 1 for vendor
customField2stringOptional
Custom field 2 for vendor
customerVendorAccountstringOptional
Account number of paypoint in the vendor side.
einstringOptional

EIN/Tax ID for vendor.

emailstringOptionalformat: "email"<=320 characters
Vendor's email address. Required for vCard.
internalReferenceIdlongOptional
Internal identifier for global vendor account.
locationCodestringOptional
A location code used to identify the vendor's location.
mccstringOptional
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes.
name1stringOptional
Primary name for vendor. Required for new vendor.
name2stringOptional
Secondary name for vendor.
payeeName1stringOptional
Alternative name used to receive paper check.
payeeName2stringOptional
Alternative name used to receive paper check.
paymentMethodstringOptional
The vendor's preferred payment method. Can be one of: - `"managed"` - Managed payment method - `"vcard"` - Virtual card payment method - `"check"` - Check payment method - `"ach"` - ACH payment method
phonestringOptionalformat: "^[0-9]+$"

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

remitAddress1stringOptional
Remittance address. Used for mailing paper checks.
remitAddress2stringOptional
Remittance address additional line. Used for mailing paper checks.
remitCitystringOptional
Remittance address city. Used for mailing paper checks.
remitCountrystringOptional
Remittance address country. Used for mailing paper checks.
remitEmailstringOptionalformat: "email"
Remittance email address. Used for sending virtual cards and other information about payouts.
remitStatestringOptional
Remittance address state. Used for mailing paper checks.
remitZipstringOptional
Remittance address ZIP code. Used for mailing paper checks.
statestringOptional
Vendor's state. Must be a 2 character state code.
vendorStatusintegerOptional

Vendor’s status. Allowed status:

  • 0 Inactive

  • 1 Active

zipstringOptional
Vendor's zip code.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean or null

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

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
responseCodeinteger or null

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

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

Errors