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.

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

API console

Try it

Send a real request to the sandbox API and inspect the response.

Credentials

Profile code

Public key

Secret key

Path parameters

2 fields

gdsproviderenumRequired

GDS provider

Global Distribution System used to source flight content. Select 0 for the default provider.

orderIdstringRequired

Order ID

Identifier of the order returned when the booking was created.

cURL request

cURL

bash

curl -X POST 'https://api.sandbox.travelandz.com/v1/flights/order/pending/cancel/0/:orderId' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

Add your credentials to send a request.

Response

Click "Try it!" to send a request and see the response here.

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

Endpoint

Method	Path	Auth
`POST`	`/v1/flights/order/pending/cancel/:gdsprovider/:orderId`	Required API key

Required headers:

Header	Description
`Authorization`	`Bearer <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-Type`	Use `application/json` for requests with a body.

Request Params Schema

gdsprovider

numberYes

Only gdsprovider "0" supports this flow

orderId

stringYes

Request Body

No request body is required.

Success Response

Returns the pending cancellation id, refund context, dates, airline credits and liveMode.

Response Body Schema

cancellationId

stringYes

orderId

stringYes

refund

objectYes

refundto

stringYes

refundamount

stringYes

refundcurrency

stringYes

createdAt

string

Format: ISO 8601

Yes

expiresAt

string

Format: ISO 8601

Yes

confirmedAt

string

Format: ISO 8601

Nullable

airlineCredits

arrayYes

airlineCredits[]passengerId

stringYes

airlineCredits[]issuedOn

string

Format: ISO 8601

Yes

airlineCredits[]id

stringYes

airlineCredits[]creditName

stringYes

airlineCredits[]creditCurrency

stringYes

airlineCredits[]creditCode

stringYes

airlineCredits[]creditAmount

stringYes

liveMode

booleanYes

True when the request is served by the live Travelandz environment. This value comes from Travelandz, not the provider payload.

Operational Notes

Only gdsprovider "0" supports this flow. Travelandz returns the adapted public cancellation payload and persists the pending cancellation internally.

Example

bash

curl -X POST https://api.sandbox.travelandz.com/v1/flights/order/pending/cancel/0/order_123 \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"

Responses

Code	Description
`200`	Pending flight cancellation created successfully.
`400`	Bad request – invalid payload.
`401`	Unauthorized – invalid or missing credentials.
`403`	Forbidden – invalid credentials.
`500`	Internal server error

200 Response Body

Media type: application/json

json

{
  "cancellationId": "ore_0000B7awtcMBc20FXigs1Z",
  "orderId": "ord_0000B7aw6DtypHDaOdA5hV",
  "refund": {
    "to": "balance",
    "amount": "221.89",
    "currency": "EUR"
  },
  "createdAt": "2026-06-22T15:07:18.622Z",
  "expiresAt": "2026-06-22T16:07:18.000Z",
  "confirmedAt": null,
  "airlineCredits": [],
  "liveMode": false
}