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

Payment API Operations

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

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

This API exposes 3 operations across 2 paths, and defines 5 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 5 schemas 1 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 payment 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 — 1 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

payment 3

Payment API Operations

POST
/
Create a payment
payment_post body → 201400
PATCH
/{id}
Update fields for a payment by id.
payment_patch 1 param body → 200404
GET
/{id}
Retrieve a payment by id
payment_get 1 param → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PaymentRequest (26 properties), PatchPaymentRequest (16 properties), Error (2 properties), PaymentResponse (2 properties). Each schema is shown below with its type and property counts.

PaymentResponse
object
2 properties
PatchPaymentRequest
object
16 properties
Errors
array
A list of errors that occurred during payment processing
PaymentRequest
object
26 properties 2 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-payment-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 ping API