Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync payees API

The payees end point

Roadsync payees API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include payees. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

4 operations 2 paths 23 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync payees API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

payees 4

The payees end point

GET
/payees
Get a List of All Payees
get-payees 2 params → 200
POST
/payees
Create a Payee
post-payees 1 param body → 201400409
GET
/payees/{payee_id}
Get a Single Payee
get-payees-id 2 params → 200
PATCH
/payees/{payee_id}
Update a Single Payee
patch-payees-id 2 params body → 201400401403404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed is payee (21 properties). Each schema is shown below with its type and property counts.

id
integer
The id number of the object being returned.
carrierPayeeIds
array
If “isfactoringcompany“ is true, add the “payeeid” for each associated carrier.
mcNumber
string
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.
isFactoringCompany
boolean
Send "true" if this Payee is a Factoring Company, "false" otherwise.
firstName
string
The first name of a contact or user.
addressLineOne
string
The valid address of a person or business in the United States.
payeeCandidateId
integer
This field is displayed if the Payee is available in RoadSync Pay’s Directory.
state
string
A valid 2 character state code in the United States.
paymentTarget
A valid Payee payment target.
postalCode
string
A valid postal code in the United States.
payeeCandidateImportId
integer
A valid ID of the payee candidate you are importing
payee
object
21 properties
availablePaymentTypes
array
A list of the availablepayment methods a Payee is able to receive. Possible values are PAPERCHECK, ACH, RTP
addressLineTwo
string
If necessary, add a second line of the address in the United States.
lastName
string
The last name of a user or contact.
emailAddress
string
A valid email belonging to the person or company.
fundingSourceId
Id representing the funding source (papercheck, ach or wallet).
brokerId
integer
The identifier of a Broker to which the Payee will be assigned or has already been assigned.
payeeName
string
The name of the Carrier or Factoring Company.
city
string
A valid city in the United States.
phoneNumber
string
A valid phone number belonging to a person or company.
dotNumber
string
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…
isVerified
boolean
A verified Payee is visible to all brokers in the RoadSync Pay environment. Some partners are allowed to verify a Payee by setting the isverified flag to true…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-payees-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payment API
Roadsync ping API