Search toll transactions

POST

api

{version}

tolls

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/tolls/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "TransponderId": "<string>",
  "UnitIds": [
    "<string>"
  ],
  "DateRange": {
    "Start": "2023-11-07T05:31:56Z",
    "End": "2023-11-07T05:31:56Z"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    TransponderId: '<string>',
    UnitIds: ['<string>'],
    DateRange: {Start: '2023-11-07T05:31:56Z', End: '2023-11-07T05:31:56Z'}
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/tolls/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/tolls/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "TransponderId": "<string>",
    "UnitIds": ["<string>"],
    "DateRange": {
        "Start": "2023-11-07T05:31:56Z",
        "End": "2023-11-07T05:31:56Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/tolls/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'TransponderId' => '<string>',
    'UnitIds' => [
        '<string>'
    ],
    'DateRange' => [
        'Start' => '2023-11-07T05:31:56Z',
        'End' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/tolls/search"

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TransponderId\": \"<string>\",\n  \"UnitIds\": [\n    \"<string>\"\n  ],\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/tolls/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TransponderId\": \"<string>\",\n  \"UnitIds\": [\n    \"<string>\"\n  ],\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "Id": "<string>",
      "Source": "<string>",
      "Agency": "<string>",
      "PrePaid": true,
      "Amount": {
        "Amount": 123,
        "Currency": 123
      },
      "TransactionDate": "2023-11-07T05:31:56Z",
      "SubsidiaryId": "<string>",
      "TransactionId": "<string>",
      "TransponderId": "<string>",
      "UnitId": "<string>",
      "UnitNumber": "<string>",
      "LicenseState": "<string>",
      "LicensePlate": "<string>",
      "Service": "<string>",
      "CostCenter": "<string>",
      "EntryLane": "<string>",
      "EntryPlazaId": "<string>",
      "EntryPlazaName": "<string>",
      "EntryTime": "2023-11-07T05:31:56Z",
      "ExitLane": "<string>",
      "ExitPlazaId": "<string>",
      "ExitPlazaName": "<string>",
      "ExitTime": "2023-11-07T05:31:56Z",
      "FormattedLocation": "<string>",
      "RunningBalance": {
        "Amount": 123,
        "Currency": 123
      },
      "Fee": {
        "Amount": 123,
        "Currency": 123
      },
      "PostedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

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: <Table> ParameterTypeRequiredDescription PageIntegerYesThe page number to retrieve.PageSizeIntegerYesThe number of results per page.
PageSize must be greater than 0.TransponderIdStringConditionallyThe transponder ID used for the toll transactions. This field is required if the other conditionally required fields are left empty.UnitIdsArray of StringsConditionallyA list of unit IDs to filter by. This field is required if the other conditionally required fields are left empty.DateRangeObjectConditionallyThe date range for the toll transactions. This field is required if the other conditionally required fields are left empty.DateRange.StartString (Date-Time)ConditionallyThe start date of the transaction range. This field is required if the other conditionally required fields are left empty.DateRange.EndString (Date-Time)ConditionallyThe end date of the transaction range. This field is required if the other conditionally required fields are left empty. </Table>

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.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Body

Page

integer<int32>

required

PageSize

integer<int32>

required

TransponderId

string | null

UnitIds

string[] | null

DateRange

object | null

Show child attributes

Response

Page

integer<int32>

required

PageSize

integer<int32>

required

Total

integer<int64>

required

Items

object[]

required

Show child attributes

Facets

object | null

Show child attributes

⌘I

Search toll transactions

curl --request POST \
  --url https://integrations.alvys.com/api/p/v{version}/tolls/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "Page": 123,
  "PageSize": 123,
  "TransponderId": "<string>",
  "UnitIds": [
    "<string>"
  ],
  "DateRange": {
    "Start": "2023-11-07T05:31:56Z",
    "End": "2023-11-07T05:31:56Z"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Page: 123,
    PageSize: 123,
    TransponderId: '<string>',
    UnitIds: ['<string>'],
    DateRange: {Start: '2023-11-07T05:31:56Z', End: '2023-11-07T05:31:56Z'}
  })
};

fetch('https://integrations.alvys.com/api/p/v{version}/tolls/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://integrations.alvys.com/api/p/v{version}/tolls/search"

payload = {
    "Page": 123,
    "PageSize": 123,
    "TransponderId": "<string>",
    "UnitIds": ["<string>"],
    "DateRange": {
        "Start": "2023-11-07T05:31:56Z",
        "End": "2023-11-07T05:31:56Z"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/tolls/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Page' => 123,
    'PageSize' => 123,
    'TransponderId' => '<string>',
    'UnitIds' => [
        '<string>'
    ],
    'DateRange' => [
        'Start' => '2023-11-07T05:31:56Z',
        'End' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/tolls/search"

	payload := strings.NewReader("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TransponderId\": \"<string>\",\n  \"UnitIds\": [\n    \"<string>\"\n  ],\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integrations.alvys.com/api/p/v{version}/tolls/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"TransponderId\": \"<string>\",\n  \"UnitIds\": [\n    \"<string>\"\n  ],\n  \"DateRange\": {\n    \"Start\": \"2023-11-07T05:31:56Z\",\n    \"End\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

{
  "Page": 123,
  "PageSize": 123,
  "Total": 123,
  "Items": [
    {
      "Id": "<string>",
      "Source": "<string>",
      "Agency": "<string>",
      "PrePaid": true,
      "Amount": {
        "Amount": 123,
        "Currency": 123
      },
      "TransactionDate": "2023-11-07T05:31:56Z",
      "SubsidiaryId": "<string>",
      "TransactionId": "<string>",
      "TransponderId": "<string>",
      "UnitId": "<string>",
      "UnitNumber": "<string>",
      "LicenseState": "<string>",
      "LicensePlate": "<string>",
      "Service": "<string>",
      "CostCenter": "<string>",
      "EntryLane": "<string>",
      "EntryPlazaId": "<string>",
      "EntryPlazaName": "<string>",
      "EntryTime": "2023-11-07T05:31:56Z",
      "ExitLane": "<string>",
      "ExitPlazaId": "<string>",
      "ExitPlazaName": "<string>",
      "ExitTime": "2023-11-07T05:31:56Z",
      "FormattedLocation": "<string>",
      "RunningBalance": {
        "Amount": 123,
        "Currency": 123
      },
      "Fee": {
        "Amount": 123,
        "Currency": 123
      },
      "PostedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "Facets": {}
}

{
  "Errors": {},
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Request Body

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Body

Response

Request Parameters

Request Body

Example CURL request

Response Parameters

Example Response

Rate Limits