| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint provides detailed information about each toll transaction that matches the search criteria, facilitating efficient management and retrieval of toll transaction records.
The Search Toll Transactions API endpoint allows you to search for toll transactions within the Alvys system based on various criteria such as transponder ID, unit IDs, and date range. This endpoint provides detailed information about each toll transaction that matches the search criteria, facilitating efficient management and retrieval of toll transaction records.
Request Parameters
The following parameter is required in the URL path:
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | String | Yes | The API version to use. |
Request Body
The following fields are required in the request body to filter the search results:
| Parameter | Type | Required | Description |
|---|---|---|---|
| Page | Integer | Yes | The page number to retrieve. |
| PageSize | Integer | Yes | The number of results per page. PageSize must be greater than 0. |
| TransponderId | String | Conditionally | The transponder ID used for the toll transactions. This field is required if the other conditionally required fields are left empty. |
| UnitIds | Array of Strings | Conditionally | A list of unit IDs to filter by. This field is required if the other conditionally required fields are left empty. |
| DateRange | Object | Conditionally | The date range for the toll transactions. This field is required if the other conditionally required fields are left empty. |
| DateRange.Start | String (Date-Time) | Conditionally | The start date of the transaction range. This field is required if the other conditionally required fields are left empty. |
| DateRange.End | String (Date-Time) | Conditionally | The end date of the transaction range. This field is required if the other conditionally required fields are left empty. |
Example CURL request
Use the Current API version number and make sure to replace the Authorization header value with your actual Bearer token for the request:
curl --location 'https://integrations.alvys.com/api/p/v1/tolls/search' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...' \
--header 'Content-Type: application/json' \
--data '{
"Page": 0,
"PageSize": 100,
"TransponderId": "",
"UnitIds": [
"TR25123456789"
],
"DateRange": {
"Start": "2021-07-23T14:48:05.234Z",
"End": "2024-07-23T14:48:05.234Z"
}
}'Response Parameters
The following table lists the parameters included in the response for toll transaction search requests:
| Parameter | Type | Required | Description |
|---|---|---|---|
| Page | Integer | Yes | The current page number of the results. |
| PageSize | Integer | Yes | The number of results per page. |
| Total | Integer | Yes | The total number of matching toll transactions. |
| Items | Array of Objects | Yes | The list of toll transaction records matching the criteria. |
| Items.Id | String | Yes | The unique identifier of the toll transaction. |
| Items.SubsidiaryId | String | No | The subsidiary ID associated with the transaction. |
| Items.TransactionId | String | No | The external transaction ID from the toll provider. |
| Items.TransponderId | String | No | The transponder ID associated with the transaction. |
| Items.Source | String | Yes | The toll provider (e.g., PrePass, BestPass, IPass). |
| Items.Agency | String | Yes | The tolling agency that issued the transaction. |
| Items.UnitId | String | No | The Alvys unit ID associated with the transaction. |
| Items.UnitNumber | String | No | The unit number associated with the transaction. |
| Items.LicenseState | String | No | The state where the vehicle is licensed. |
| Items.LicensePlate | String | No | The license plate of the vehicle. |
| Items.PrePaid | Boolean | Yes | Indicates whether the toll was prepaid. |
| Items.Service | String | No | The toll road or service (e.g., Texas Toll Roads, PA Turnpike). |
| Items.CostCenter | String | No | The cost center associated with the transaction. |
| Items.EntryLane | String | No | The lane used at entry. |
| Items.EntryPlazaId | String | No | The identifier of the entry plaza. |
| Items.EntryPlazaName | String | No | The name of the entry plaza. |
| Items.EntryTime | String (Date-Time) | No | The date and time of entry. |
| Items.ExitLane | String | No | The lane used at exit. |
| Items.ExitPlazaId | String | No | The identifier of the exit plaza. |
| Items.ExitPlazaName | String | No | The name of the exit plaza. |
| Items.ExitTime | String (Date-Time) | No | The date and time of exit. |
| Items.FormattedLocation | String | No | The formatted location of the toll transaction. |
| Items.Amount | Object | Yes | The toll amount. |
| Items.Amount.Amount | Number | Yes | The monetary value of the toll. |
| Items.Amount.Currency | Integer | Yes | The currency identifier of the toll amount. |
| Items.RunningBalance | Object | No | The running account balance after the transaction. |
| Items.RunningBalance.Amount | Number | No | The monetary value of the running balance. |
| Items.RunningBalance.Currency | Integer | No | The currency identifier of the running balance. |
| Items.Fee | Object | No | The fee charged for the transaction. |
| Items.Fee.Amount | Number | No | The monetary value of the fee. |
| Items.Fee.Currency | Integer | No | The currency identifier of the fee. |
| Items.PostedAt | String (Date-Time) | No | The date and time when the transaction was posted. |
| Items.TransactionDate | String (Date-Time) | Yes | The date and time when the toll transaction occurred. |
Example Response
On the right side, you can see examples of different error codes by clicking "Example" and selecting the response code.
Rate Limits
All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section.
This page is interactive, allowing you to try a request by specifying the API version in the URL path and providing the necessary request body. As you fill out the parameters, the Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.