Skip to main content
GET
/
api
/
v1
/
ops
/
benefits
/
requests
/
{passengerBenefitRequestId}
Get Benefit Request
curl --request GET \
  --url https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "passengerBenefitRequestId": "0197f712-8a7e-7a53-9d28-51f8f3c77d41",
  "customerId": "0197a7f6-4d36-7c0a-a7cb-54fcb33a3148",
  "fareBenefitCategoryId": "0197f710-b826-77f0-a60b-6c62b9fdd301",
  "requestedByUserId": "0197a7f6-2c4d-74ae-b89b-9d36d9c341f2",
  "code": "BEN-20260704-0001",
  "status": "PENDING",
  "createdAt": "2026-07-04T11:30:00.000Z",
  "updatedAt": "2026-07-04T12:00:00.000Z",
  "reviewedByUserId": null,
  "notes": "Student half-fare request",
  "rejectionReason": null,
  "createdBy": null,
  "updatedBy": null,
  "deletedBy": null,
  "deletedAt": null,
  "reviewedAt": null,
  "validFrom": null,
  "validUntil": null
}
{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}
{
"message": "Missing or invalid access token",
"statusCode": 401
}
{
"message": "Insufficient permissions",
"statusCode": 403
}
{
"message": "Internal Server Error",
"statusCode": 500
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

passengerBenefitRequestId
string<uuid>
required

Benefit request identifier

Example:

"0197f712-8a7e-7a53-9d28-51f8f3c77d41"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Passenger benefit request

passengerBenefitRequestId
string<uuid>
required

Benefit request identifier

Example:

"0197f712-8a7e-7a53-9d28-51f8f3c77d41"

customerId
string<uuid>
required

Customer identifier

Example:

"0197a7f6-4d36-7c0a-a7cb-54fcb33a3148"

fareBenefitCategoryId
string<uuid>
required

Fare benefit category identifier

Example:

"0197f710-b826-77f0-a60b-6c62b9fdd301"

requestedByUserId
string<uuid>
required

Requesting user identifier

Example:

"0197a7f6-2c4d-74ae-b89b-9d36d9c341f2"

code
string
required

Benefit request code

Example:

"BEN-20260704-0001"

status
enum<string>
required

Benefit request status

Available options:
PENDING,
IN_REVIEW,
APPROVED,
REJECTED,
CANCELED,
EXPIRED
Example:

"PENDING"

createdAt
string<date-time>
required

Created at

Example:

"2026-07-04T11:30:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-07-04T12:00:00.000Z"

reviewedByUserId
string<uuid> | null

Reviewing user identifier

Example:

null

notes
string | null

Customer notes

Example:

"Student half-fare request"

rejectionReason
string | null

Rejection reason

Example:

null

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

deletedBy
string<uuid> | null

Deleted by

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null

reviewedAt
string<date-time> | null

Reviewed at

Example:

null

validFrom
string<date-time> | null

Benefit validity start

Example:

null

validUntil
string<date-time> | null

Benefit validity end

Example:

null