Reject Benefit Request - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/ops/benefits/requests/{passengerBenefitRequestId}/reject \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "rejectionReason": "<string>" } '

{ "passengerBenefitRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "fareBenefitProgramId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "requestedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "reviewedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "code": "<string>", "notes": "<string>", "rejectionReason": "<string>", "validFrom": "2023-11-07T05:31:56Z", "validUntil": "2023-11-07T05:31:56Z", "reviewedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

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:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

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.

Body

application/json

Rejection reason payload

rejectionReason

string

required

Rejection reason

Minimum string length: 1

Response

Solicitação de gratuidade ou desconto feita por um passageiro

passengerBenefitRequestId

string<uuid>

required

Identificador único

customerId

string<uuid>

required

Cliente/passageiro solicitante

fareBenefitProgramId

string<uuid>

required

Programa de benefício solicitado

requestedByUserId

string<uuid>

required

Usuário que abriu a solicitação

reviewedByUserId

string<uuid> | null

required

Usuário que analisou a solicitação

code

string

required

Código legível da solicitação

notes

string | null

required

Observações informadas pelo passageiro

rejectionReason

string | null

required

Motivo de rejeição, quando aplicável

status

enum<string>

required

Status atual da solicitação

Available options:

PENDING,

IN_REVIEW,

APPROVED,

REJECTED,

CANCELED,

EXPIRED

validFrom

string<date-time> | null

required

Início da validade do benefício aprovado

validUntil

string<date-time> | null

required

Fim da validade do benefício aprovado

reviewedAt

string<date-time> | null

required

Data de análise da solicitação

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção lógica