Manage Vendors with the API

Vendors are the entities that provide goods or services to paypoints and organizations. They’re who gets paid in money out (pay out) transactions. Before you can use vendors in bills and payouts, you must add them. This guide explains how to add and manage vendors using .

You can also manage existing vendors using the API:

• Update Vendor
• Delete Vendor
• Get Vendor

​

Build the request

First, choose an endpoint. If you’re testing, use the Sandbox endpoint..

​

Authenticate

Authenticate by sending your API token in the request header with the key requestToken:
--header 'requestToken: API TOKEN'

​

Path parameter

For complete details about available parameters, see the API reference for this endpoint.

This request has a required path parameter, entry.

Update the body parameter as needed. Be sure to check out the VendorData Object Model for a complete reference on each available field.

​

Example request

This example creates a new vendor record.

curl --request POST \
     --url https://api-sandbox.payabli.com/api/Vendor/single/e56ce00572 \
     --header "accept: application/json" \
     --header "content-type: application/*+json" \
     --header "requestToken: <API TOKEN>" \
     --data '
{
  "contacts": [
    {
      "contactName": "Chet",
      "contactEmail": "Okawamin",
      "contactTitle": "Owner"
    }
  ],
  "billingData": {
    "bankName": "Eastman Credit Union",
    "routingAccount": "123123123",
    "accountNumber": "123123123",
    "typeAccount": "Checking"
  },
  "vendorNumber": "12345",
  "name1": "Brass Supply Co",
  "email": "info@brasssupplyco.com",
  "address1": "123 Main Street",
  "address2": "Suite 300",
  "city": "Bristol",
  "state": "TN",
  "zip": "37600",
  "paymentMethod": "check",
  "vendorStatus": 1
}
'

​

Example response

A successful request returns a JSON response. The IdVendor is returned as responseData.

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": 215,
  "pageidentifier": null
}