Cancel Request - mynztrip

Send Cancel Request

POST Endpoint: [BaseUrl]/api/v1/flight-delay-pass/send-cancel-request

Overview

The Send Cancel Request API allows agents to request cancellation of an issued flight delay pass. This endpoint initiates the cancellation process for a specific booking.

Authentication

This endpoint requires Bearer token authentication. Include your access token in the Authorization header.

Request Parameters

Parameter	Type	Required	Description
uniqueTransId	String	Yes	Unique transaction ID of the booking to cancel

Request Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer token for authentication
Content-Type	String	Yes	application/json

Request

{
  "uniqueTransId": "NZFDP2508061933445232"
}

Response

Success Response

{
  "success": true,
  "uniqueTransId": "NZFDP2508061933445232",
  "code": 200,
  "message": "Cancellation request submitted successfully",
  "data": {
    "status": "VOID_REQUESTED",
    "requestDate": "2025-10-12T14:30:00.000000Z",
    "uniqueTransId": "NZFDP2508061933445232"
  }
}

Response Fields

Field	Type	Description
success	Boolean	Indicates if the request was successful
uniqueTransId	String	Transaction ID of the booking
code	Integer	HTTP status code
message	String	Response message
data.status	String	Updated booking status
data.requestDate	DateTime	Timestamp when cancellation was requested
data.uniqueTransId	String	Confirmation of the transaction ID

Cancellation Status Flow

Status	Description
ISSUED	Initial status - Pass is active
VOID_REQUESTED	Cancellation has been requested
VOIDED	Pass has been successfully cancelled
VOID_REJECTED	Cancellation request was rejected

Important Notes

Only passes with status ISSUED can be cancelled
Cancellation is subject to the terms and conditions of the delay pass product
Refund processing may take time depending on payment method and policies
Once voided, a pass cannot be reactivated
The agent will be notified of the final cancellation status via email or system notification

Cancellation Policy

⚠️ Important:

Cancellation requests must be made before the flight departure time
Some products may have non-refundable or partially refundable conditions
Cancellation fees may apply based on the product terms
Check the specific product's cancellation policy before requesting cancellation

Error Responses

Code	Message	Description
400	Invalid booking status	The booking is not in a cancellable state
404	Booking not found	The uniqueTransId doesn't exist or doesn't belong to the agent
401	Unauthorized	Invalid or expired authentication token
422	Validation error	Missing or invalid uniqueTransId
409	Conflict	A cancellation request already exists for this booking

Example Error Response

Error Response

{
  "success": false,
  "uniqueTransId": "NZFDP2508061933445232",
  "code": 400,
  "message": "Cancellation not allowed for this booking",
  "errors": {
    "status": [
      "Booking is already in VOIDED status"
    ]
  }
}

Verification

After submitting a cancellation request, you can verify the status using the Booking Details endpoint.

Best Practices

Check Status First: Always retrieve booking details to verify the current status before attempting cancellation
Handle Async Processing: Cancellation may not be instant; the status might change to VOID_REQUESTED initially
Monitor Status Changes: Implement webhook or polling to track when the status changes to VOIDED
Customer Communication: Inform customers about the cancellation process and expected timelines
Record Keeping: Store the cancellation request timestamp and response for audit purposes

Related Endpoints

Get Booking Details - Check current booking status
Issue Pass - Create a new booking if needed

Booking Details