POST
/
Vendor
/
single
/
{entry}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Vendor/single/{entry} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "vendorNumber": "1234",
  "name1": "Herman'\''s Coatings and Masonry",
  "name2": "<string>",
  "ein": "12-3456789",
  "phone": "5555555555",
  "email": "example@email.com",
  "address1": "123 Ocean Drive",
  "address2": "Suite 400",
  "city": "Miami",
  "state": "FL",
  "zip": "33139",
  "country": "US",
  "mcc": "7777",
  "locationCode": "MIA123",
  "contacts": [
    {
      "contactName": "Herman Martinez",
      "contactEmail": "example@email.com",
      "contactTitle": "Owner",
      "contactPhone": "3055550000"
    }
  ],
  "billingData": {
    "id": 123,
    "bankName": "Country Bank",
    "routingAccount": "123123123",
    "accountNumber": "123123123",
    "typeAccount": "Checking",
    "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
    "bankAccountHolderType": "Business",
    "bankAccountFunction": 0
  },
  "paymentMethod": {
    "method": "managed"
  },
  "vendorStatus": 1,
  "remitAddress1": "123 Walnut Street",
  "remitAddress2": "Suite 900",
  "remitCity": "Miami",
  "remitState": "FL",
  "remitZip": "31113",
  "remitCountry": "US",
  "payeeName1": "<string>",
  "payeeName2": "<string>",
  "customerVendorAccount": "A-37622",
  "internalReferenceId": 123,
  "AdditionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 3890,
  "pageIdentifier": null
}

Authorizations

requestToken
string
header
required

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

Path Parameters

entry
string
required

Entrypoint identifier.

Example:

"8cfec329267"

Body

VendorData object to add.
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"
}

Response

200 - application/json
Success
isSuccess
boolean

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

Example:

true

responseText
string | null

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

Example:

"Success"

responseCode
integer | null

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

Example:

1

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData
integer

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

Example:

3893

Was this page helpful?