Skip to main content
POST
Cancel Benefit Request

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