Skip to main content
POST
/
vendor
Create a vendor
curl --request POST \
  --url https://rest.staging.nickel.com/vendor \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "emails": [
    "<string>"
  ],
  "address": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "type": "BUSINESS",
  "syncToQbo": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "emails": [
    "<string>"
  ],
  "address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "type": "<string>",
  "vendorPayoutMethods": [
    {
      "id": "<string>",
      "type": "<string>",
      "routingNumber": "<string>",
      "accountType": "<string>",
      "bankName": "<string>",
      "street": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "swiftCode": "<string>",
      "iban": "<string>",
      "countryCode": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Create a new vendor

​
name
string
required
​
emails
string[]
​
address
object
​
type
enum<string>
Available options:
BUSINESS,
INDIVIDUAL
​
syncToQbo
boolean

Response

Successful operation

​
id
string
​
name
string | null
​
emails
string[]
​
address
string | null
​
city
string | null
​
state
string | null
​
zip
string | null
​
type
string | null
​
vendorPayoutMethods
object[]