POST/v1/flights/order/pending/cancel/:gdsprovider/:orderId

Create pending flight cancellation

Starts a pending cancellation flow so the integration can review refund data, penalties or provider confirmation before final cancellation.

Starts a pending cancellation flow so the integration can review refund data, penalties or provider confirmation before final cancellation.

Endpoint

MethodPathAuth
POST/v1/flights/order/pending/cancel/:gdsprovider/:orderIdRequired API key
Required headers:
HeaderDescription
AuthorizationBearer <secret_key>. The secret is shown only once when the credential is created.
X-Travelandz-Id<public_key>:<profile_code>. The profile_code is the dp_-prefixed Developer Profile code shown in your dashboard. This binds the request to a profile and credential.
Content-TypeUse application/json for requests with a body.

Request Params Schema

PropertyTypeDetailsRequiredNotes
gdsprovidernumberYesOnly gdsprovider "0" supports this flow
orderIdstringYes-

Success Response

Returns the pending cancellation id and provider state.

Response Body Schema

PropertyTypeDetailsRequiredNotes
dataobjectYes-
refund_tostringYes-
refund_currencystringYes-
refund_amountstringYes-
order_idstringYes-
live_modebooleanYes-
idstringYes-
expires_atstringFormat: ISO 8601Yes-
created_atstringFormat: ISO 8601Yes-
confirmed_atstringFormat: ISO 8601Yes-
airline_creditsarrayYes-
passenger_idstringYes-
issued_onstringFormat: ISO 8601Yes-
idstringYes-
credit_namestringYes-
credit_currencystringYes-
credit_codestringYes-
credit_amountstringYes-

Operational Notes

Only gdsprovider "0" supports this flow. Store the returned cancellation id and confirm details before finalizing.