payees

The payees end point

Get a List of All Payees

Return a list of all Payees associated with a Broker.

Securityx-api-key
Request
header Parameters
broker-id
required
integer (broker_id)

The id of the broker

Example: 66305
Responses
200

Example response

get/payees
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a Payee
Create a Payee.


Securityx-api-key 
Request 
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Request Body schema: application/json
One of:
type
string
Create a New Payee


 Value: "NEW"  
object
 
Responses 
201
Example response


400
Bad Request


409
Conflict


post/payees
Request samples 
application/json
{
  • "type": "NEW",
  • "data": {
    }
}
Response samples 
application/json
{
  • "id": 87346
}
Get a Single Payee
Retrieve the information of one specific Payee.


Securityx-api-key 
Request 
path Parameters
payee_id
required
integer (id) 
The id number of the object being returned.


 
 Example:  87346
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Responses 
200
Example response


get/payees/{payee_id}
Request samples 
Response samples 
application/json
{
  • "id": 87346,
  • "payee_name": "Camila Trucking LLC",
  • "mc_number": "MC612791",
  • "dot_number": "2428196",
  • "email_address": "crogers@camilatrucking.com",
  • "phone_number": "3243444347",
  • "first_name": "Camila",
  • "last_name": "Rogers",
  • "address_line_one": "715 Peachtree St",
  • "address_line_two": "APT 23",
  • "address_city": "Atlanta",
  • "address_state": "GA",
  • "address_zip": "30306",
  • "is_factoring_company": true,
  • "ach_funding_source_id": 87346,
  • "paper_check_funding_source_id": 87346,
  • "available_payment_types": [
    ],
  • "is_verified": false,
  • "payee_candidate_id": 896876,
  • "carrier_payee_ids": [
    ],
  • "factoring_company": {
    }
}
Update a Single Payee
Edit the information of the specified Payee. Only Payees that are not verified can be updated.


Securityx-api-key 
Request 
path Parameters
payee_id
required
integer (id) 
The id number of the object being returned.


 
 Example:  87346
header Parameters
broker-id
required
integer (broker_id) 
The id of the broker


 
 Example:  66305
Request Body schema: application/json
payee_name
string (payee_name) 
The name of the Carrier or Factoring Company.


 
mc_number
string (mc_number) 
Motor Carrier Number is a a nine-digit identifier assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will be validated.


 
dot_number
string (dot_number) 
U.S. Department of Transportation Number is an up to ten-digit assigned by the FMCSA to moving companies operating in interstate commerce. If inserted, it will be validated.


 
email_address
string (email_address) 
A valid email belonging to the person or company.


 
phone_number
string (phone_number) 
A valid phone number belonging to a person or company.


 
address_line_one
string (address_line_one) 
The valid address of a person or business in the United States.


 
address_line_two
string or null (address_line_two) 
If necessary, add a second line of the address in the United States.


 
address_city
string (city) 
A valid city in the United States.


 
address_state
string (state) 
A valid 2 character state code in the United States.


 
address_zip
string (postal_code) 
A valid postal code in the United States.


 
first_name
string (first_name) 
The first name of a contact or user.


 
last_name
string (last_name) 
The last name of a user or contact.


 
factoring_company_id
integer (id) 
The id number of the object being returned.


 
carrier_payee_ids
Array of integers (carrier_payee_ids) 
If “is_factoring_company“ is true, add the “payee_id” for each associated carrier.


 
Responses 
201
Example response


400
Bad Request


401
Unauthorized


403
Example response


404
Not Found


patch/payees/{payee_id}
Request samples 
application/json
{
  • "payee_name": "Camila Trucking LLC",
  • "mc_number": "MC612791",
  • "dot_number": "2428196",
  • "email_address": "crogers@camilatrucking.com",
  • "phone_number": "3243444347",
  • "address_line_one": "715 Peachtree St",
  • "address_line_two": "APT 23",
  • "address_city": "Atlanta",
  • "address_state": "GA",
  • "address_zip": "30306",
  • "first_name": "Camila",
  • "last_name": "Rogers",
  • "factoring_company_id": 87346,
  • "carrier_payee_ids": [
    ]
}
Response samples 
application/json
{
  • "id": 87346
}
Copyright © RoadSync 2023. All right reserved.