> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devmob.app.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Benefit Request

> Cancels a benefit request.



## OpenAPI

````yaml /api-reference/customer/openapi.json post /api/v1/customer/benefits/requests/{passengerBenefitRequestId}/cancel
openapi: 3.0.0
info:
  title: OABUS Customer API
  description: OABUS API
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/v1/customer/benefits/requests/{passengerBenefitRequestId}/cancel:
    post:
      tags:
        - Benefit Category
      summary: Cancel Benefit Request
      description: Cancels a benefit request.
      operationId: cancelPassengerBenefitRequest
      parameters:
        - name: passengerBenefitRequestId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            description: Benefit request identifier
            example: 0197f712-8a7e-7a53-9d28-51f8f3c77d41
        - name: fields
          required: false
          in: query
          description: >-
            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.
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/CancelPassengerBenefitRequest200Response'
        '400':
          $ref: '#/components/responses/CancelPassengerBenefitRequest400Response'
        '401':
          $ref: '#/components/responses/CancelPassengerBenefitRequest401Response'
        '500':
          $ref: '#/components/responses/CancelPassengerBenefitRequest500Response'
      security:
        - bearer: []
components:
  responses:
    CancelPassengerBenefitRequest200Response:
      content:
        application/json:
          schema:
            type: object
            properties:
              passengerBenefitRequestId:
                type: string
                format: uuid
                description: Benefit request identifier
                example: 0197f712-8a7e-7a53-9d28-51f8f3c77d41
              customerId:
                type: string
                format: uuid
                description: Customer identifier
                example: 0197a7f6-4d36-7c0a-a7cb-54fcb33a3148
              fareBenefitCategoryId:
                type: string
                format: uuid
                description: Fare benefit category identifier
                example: 0197f710-b826-77f0-a60b-6c62b9fdd301
              requestedByUserId:
                type: string
                format: uuid
                description: Requesting user identifier
                example: 0197a7f6-2c4d-74ae-b89b-9d36d9c341f2
              reviewedByUserId:
                description: Reviewing user identifier
                example: null
                nullable: true
                type: string
                format: uuid
              code:
                type: string
                description: Benefit request code
                example: BEN-20260704-0001
              notes:
                description: Customer notes
                example: Student half-fare request
                nullable: true
                type: string
              rejectionReason:
                description: Rejection reason
                example: null
                nullable: true
                type: string
              status:
                type: string
                enum:
                  - PENDING
                  - IN_REVIEW
                  - APPROVED
                  - REJECTED
                  - CANCELED
                  - EXPIRED
                description: Benefit request status
                example: PENDING
              createdBy:
                description: Created by
                example: null
                nullable: true
                type: string
                format: uuid
              updatedBy:
                description: Updated by
                example: null
                nullable: true
                type: string
                format: uuid
              deletedBy:
                description: Deleted by
                example: null
                nullable: true
                type: string
                format: uuid
              createdAt:
                type: string
                format: date-time
                description: Created at
                example: '2026-07-04T11:30:00.000Z'
              deletedAt:
                description: Deleted at
                example: null
                nullable: true
                type: string
                format: date-time
              reviewedAt:
                description: Reviewed at
                example: null
                nullable: true
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
                description: Updated at
                example: '2026-07-04T12:00:00.000Z'
              validFrom:
                description: Benefit validity start
                example: null
                nullable: true
                type: string
                format: date-time
              validUntil:
                description: Benefit validity end
                example: null
                nullable: true
                type: string
                format: date-time
            required:
              - passengerBenefitRequestId
              - customerId
              - fareBenefitCategoryId
              - requestedByUserId
              - code
              - status
              - createdAt
              - updatedAt
            additionalProperties: false
            description: Passenger benefit request
      description: OK
    CancelPassengerBenefitRequest400Response:
      content:
        application/json:
          example:
            errors:
              - message: required
                path: name
            message: Bad Request Error
            statusCode: 400
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 400
                type: number
              errors:
                items:
                  properties:
                    message:
                      type: string
                    path:
                      type: string
                  required:
                    - message
                    - path
                  type: object
                type: array
            required:
              - message
              - statusCode
            type: object
      description: Bad Request Error
    CancelPassengerBenefitRequest401Response:
      content:
        application/json:
          example:
            message: Missing or invalid access token
            statusCode: 401
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 401
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Unauthorized
    CancelPassengerBenefitRequest500Response:
      content:
        application/json:
          example:
            message: Internal Server Error
            statusCode: 500
          schema:
            properties:
              message:
                type: string
              statusCode:
                enum:
                  - 500
                type: number
            required:
              - message
              - statusCode
            type: object
      description: Internal Server Error
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````