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 transactions API

The transactions API from Roadsync — 2 operation(s) for transactions.

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

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

This API exposes 3 operations across 2 paths, and defines 24 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}.

3 operations 2 paths 24 schemas 2 GET1 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 transactions 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 3

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

transactions 3
GET
/transactions
Get a List of Transactions
get-transactions 2 params → 200
POST
/transactions
Create a Single Transaction
post-transactions 1 param body → 201
GET
/transactions/{id}
Get a Single Transaction
get-transactions-id 2 params → 200401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are transaction (11 properties), payeeShort (3 properties), brokerShort (2 properties). Each schema is shown below with its type and property counts.

id
integer
The id number of the object being returned.
brokerName
string
The name of the broker.
payeeId
integer
The unique identifier of the Payee who will receive the funds. It could be a Carrier or a Factoring Company.
idempotencyKey
integer
Provide a unique value to prevent duplicates during retries.
isFactoringCompany
boolean
Send "true" if this Payee is a Factoring Company, "false" otherwise.
amountAsString
string
Money in USD to transfer or has been transferred.
amount
number
Money in USD to transfer or has been transferred.
poNumber
string
A unique identifier that links the purchase order the payable.
carrierPayeeId
string
If the Transaction is created for a Factoring Company, then a Carrier can be associated to the Transaction.
updatedDatetime
string
Indicates the last time the entity was updated in ISO 8601 format.
invoiceNumber
string
The invoice number being paid by the payable/receivable. This is visible by the Payee in remittance emails as referenceid.
transaction
object
11 properties
paymentMethod
The method used to settle a payable.
scheduledForDate
string
A valid date in the future when the payment should be initiated or "now" indicating immediate payment.
brokerShort
object
The short description of the broker.
2 properties
referenceId
string
An identifier used by the Broker to correlate the Transaction with another system or document.
createdDatetime
string
Indicates the datetime when the object was created in ISO 8601 format.
payableId
integer
The Payable's ID
payeeShort
object
Details of the Payee receiving the funds. It could be a Carrier or Factoring Company.
3 properties
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.
status
The current status of the payable. UNKNOWN is returned when the status value is not recognized.
eta
string
The estimated time of arrival of the payment, based on the payment method selected and scheduled date in ISO 8601 format.
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-transactions-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 payees API
Roadsync payment API