Fuel Card API
Create fuel card.
Create fuel card.
Endpoint
POST - https://api.travisroadservices.com/v1/fuel_cards
Copy
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
provider
|
integer | Yes | ID of the fuel card provider. |
cardNumber
|
string | Yes | The fuel card number. |
expirationDate
|
string | No | Expiration date of the fuel card in YYYY-MM format. |
serviceCode
|
integer | No | Service code associated with the fuel card. |
mainCard
|
boolean | No | Indicates whether this is the main fuel card for the vehicle. |
Example
Response body
Response 201
FuelCardResource resource created
Fields
| Field | Type | Description |
|---|---|---|
id
|
integer | Unique identifier of the fuel card. |
provider
|
integer | ID of the fuel card provider. |
cardNumber
|
string | The fuel card number. |
expirationDate
|
string | Expiration date of the fuel card in YYYY-MM format. |
serviceCode
|
integer | Service code associated with the fuel card. |
linkedVehiclesAmount
|
integer | Number of vehicles linked to this fuel card. |
mainCard
|
boolean | Indicates whether this is the main fuel card for the vehicle. |
status
|
string | Current status of the fuel card (e.g. pending, activated, blocked, expired). |
import
|
object | Import reference that created this fuel card, if applicable. |
id
|
string (uuid) | Unique identifier of the import. |
Example
Response 400
Invalid input
Fields
| Field | Type | Description |
|---|---|---|
title
|
string | A short, human-readable summary of the problem. |
detail
|
string | A human-readable explanation specific to this occurrence of the problem. |
status
|
integer | The HTTP status code applicable to this problem. |
instance
|
string | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type
|
string | A URI reference that identifies the problem type |
Example
Response 401
No response body - No bearer token set verify if your token is added as bearer tokenResponse 403
No response body - You don't have access to this API resourceResponse 422
An error occurred
Fields
| Field | Type | Description |
|---|---|---|
status
|
integer | The HTTP status code (422). |
violations
|
array | A list of constraint violations that caused the error. |
detail
|
string | A human-readable description of the validation errors. |
type
|
string | A URI reference identifying the validation error type. |
title
|
string | A short summary of the error. |
instance
|
string | A URI reference identifying the specific occurrence of the error. |
Example