Partner - Transaction API
Settle a parking exit.
Settles a parking exit by creating a new transaction or an overstay request based on existing bookings overlapping the provided period.
Endpoint
POST - https://api.travisroadservices.com/partners/v1/transactions/parking/exit
Copy
Header params
| Parameter | Type | Description |
|---|---|---|
location
|
string | Location ID of the requesting location. |
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
serviceInformation
|
object | No | Arrival and departure times of the parking exit event. |
arrival
|
string (date-time) | No | Arrival in local time. Must be in the past. |
departure
|
string (date-time) | No | Departure in local time. Must be in the past and after arrival. |
vehicles
|
object | No | Vehicles involved in the parking exit. At least one vehicle (truck or trailer) must be provided. |
truck
|
object | No | |
licensePlate
|
string | Yes | |
trailer
|
object | No | |
licensePlate
|
string | Yes | |
payment
|
object | No | Payment information. Only drive_in payments are accepted. |
type
|
string | No | Type of payment. For the parking exit endpoint only "drive_in" is allowed. Fuel card or travis payments must be sent through /partners/v1/transactions. |
information
|
object | No | |
licensePlateType
|
string | No | License plate identifier paying the transaction. Allowed values: "truck" or "trailer". |
price
|
object | No | Price to charge. Required when the location has no Travis pricing configured. If price provided, overrides any Travis pricing configuration. |
amount
|
number | No | Price amount in the specified currency. |
currency
|
string | No | ISO 4217 currency code. |
Example
Response body
Response 201
ParkingExitResource resource created
Fields
| Field | Type | Description |
|---|---|---|
amounts
|
object | Amounts breakdown: approved, pending and total. |
approved
|
object | Sum of approved transaction prices. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
pending
|
object | Pending transaction price. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
total
|
object | Total amount, approved plus pending. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
pendingTransaction
|
object | Pending transaction (id omitted). |
id
|
integer | Transaction id. Always null for pending transactions. |
service
|
string | Service for which the pending transaction was created. Always "parking". |
serviceInformation
|
object | Arrival and departure of the pending transaction. |
arrival
|
string (date-time) | In local time. Required and applicable only to the parking service. |
departure
|
string (date-time) | In local time. Required and applicable only to the parking service. |
orderNumber
|
string | Work order number for repair service. Required and applicable only to the repair service. |
reference
|
string | Optional partner reference. Applicable only to the tankcleaning service. |
costSpecification
|
array | Optional itemised cost specification. Applicable only to the tankcleaning service. When provided, the sum of the line costs must equal the transaction price amount. |
vehicles
|
object | Vehicles associated with the pending transaction. |
truck
|
object | |
licensePlate
|
string | |
trailer
|
object | |
licensePlate
|
string | |
driver
|
string | Driver. Always null for pending transaction. |
payment
|
object | Payment used for the related booking. |
type
|
string | The type of payment used. Available choices: travis_code, fuel_card. If "travis_code", then a travis code must be provided in "information". If "fuel_card", then the track data must be provided in "information.fuelCard". |
information
|
object | |
travisCode
|
string | Travis code for payment. |
fuelCard
|
object | |
provider
|
string | Fuel card provider. |
holder
|
string | Fuel card holder name. |
cardNumber
|
string | Fuel card number. |
expiryDate
|
string (date-time) | Fuel card expiration date. |
licensePlateType
|
string | Plate type that paid the transaction. "truck" or "trailer". Only set for drive_in payments. |
price
|
object | Pending transaction transaction price. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
payout
|
object | Payout for the pending transaction. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
customerDiscount
|
object | Customer discount for the pending transaction. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
status
|
string | Status of the rendered transaction. Always "pending". |
createdAt
|
string (date-time) | Date and time the pending transaction was created. |
cancelledAt
|
string (date-time) | Cancellation timestamp. Always null for pending transaction. |
creditTransactionId
|
integer | Credit transaction id. Always null for pending transaction. |
additionalCosts
|
array | Additional cost transactions. Always empty for pending transaction. |
priceParts
|
object | Repair price of parts. Always null for pending parking transaction. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
priceLabour
|
object | Repair price of labour. Always null for pending parking transaction. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
approvedTransactions
|
array | Approved transactions overlapping the parking exit settlement period. |
Example