payment

Payment API Operations

Create a payment

Create a payment

SecurityApiKey
Request
Request Body schema: application/json
paymentType
required
string

The type of payment

Enum: "comdataexpresscode" "efscheck" "tchek" "cardonfile" "wexfuelcard" "comdatafuelcard"
invoiceId
string

The id of a RoadSync Invoice.

locationId
required
string

The RoadSync ID of the location creating the invoice

firstName
string

The payer's first name

lastName
string

The payer's last name

email
string

The payer's email address. Either email or phone is required.

phone
string

The payer's phone number. Either phone or email is required.

address
string

The payer's street address

city
string

The payer's city

state
string

The payer's state

zipCode
string

The payer's zip code

token
string

For credit card payments, the token returned from the front end tokenization service

amount
number

The amount of the payment

customFields
object

Values for fields configured for the current location. These can be configured to be required.

expressCode
string

A numeric identifier that represents a prespecified amount the driver can use to pay for something. This is required when the paymentType is comdataexpresscode.

driverNumber
string

Driver employee ID - may be required by some payment types

unitNumber
string

Vehicle identifier - may be required by some payment types

tripNumber
string

Job identifier - may be required by some payment types

deleteCardOnFile
boolean

For cardonfile payment type, removes the card on file once payment is complete if set to true.

hubReading
number

Tractor milage - may be required by some payment types

trailerNumber
string

Trailer identifier - may be required by some payment types

trailerHubReading
number

Trailer milage - may be required by some payment types

trailerHours
number

Trailer hours of service - may be required by some payment types

licenseNumber
string

Driver's license number - may be required by some payment types

licenseState
string

Driver's license state - may be required by some payment types

poNumber
string

Load identifier - may be required by some payment types

Responses
201

Payment Created Successfully

400

Missing or invalid data

post/
Request samples
application/json
{
  • "paymentType": "comdataexpresscode",
  • "expressCode": "11111111111111",
  • "locationId": "2PQN9G4VElWxqaMoQBz5dMwkmAyYno",
  • "firstName": "Test",
  • "lastName": "Payer",
  • "phone": "4041231234",
  • "amount": 20,
  • "customFields": {
    }
}
Response samples
application/json
{
  • "data": {
    },
  • "errors": [
    ]
}

Update fields for a payment by id.

SecurityApiKey
Request
path Parameters
id
required
string

The id of the payment to update.

Request Body schema: application/json
expressCode
string

A numeric identifier that represents a prespecified amount the driver can use to pay for something.

firstName
string

The payer's first name

lastName
string

The payer's last name

email
string

The payer's email address. Either email or phone is required.

phone
string

The payer's phone number. Either phone or email is required.

customFields
object

Values for fields configured for the current location. These can be configured to be required.

driverNumber
string

Driver employee ID - may be required by some payment types

unitNumber
string

Vehicle identifier - may be required by some payment types

tripNumber
string

Job identifier - may be required by some payment types

hubReading
number

Tractor milage - may be required by some payment types

trailerNumber
string

Trailer identifier - may be required by some payment types

trailerHubReading
number

Trailer milage - may be required by some payment types

trailerHours
number

Trailer hours of service - may be required by some payment types

licenseNumber
string

Driver's license number - may be required by some payment types

licenseState
string

Driver's license state - may be required by some payment types

poNumber
string

Load identifier - may be required by some payment types

Responses
200

Payment Updated

404

Payment resource not found

patch/{id}
Request samples
application/json
{
  • "expressCode": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string",
  • "customFields": { },
  • "driverNumber": "string",
  • "unitNumber": "string",
  • "tripNumber": "string",
  • "hubReading": 0,
  • "trailerNumber": "string",
  • "trailerHubReading": 0,
  • "trailerHours": 0,
  • "licenseNumber": "string",
  • "licenseState": "string",
  • "poNumber": "string"
}
Response samples
application/json
{
  • "data": {
    }
}

Retrieve a payment by id

Retrieve a payment by id

SecurityApiKey
Request
path Parameters
id
required
string

The id of the payment to update.

Responses
200

Success

404

Payment resource not found

get/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "errors": [
    ]
}
Copyright © RoadSync 2023. All right reserved.