DELETE/v1/transfers/reservations/:reservationId

Cancelar una reserva de transfer

Cancela una reserva y consulta el resultado del reembolso.

DELETE/v1/transfers/reservations/:reservationId

Consola API

Pruébalo

Envía una petición real al entorno sandbox e inspecciona la respuesta.

Credenciales

Profile code

Public key

Secret key

Inicia sesión para elegir entre tus API keys guardadas en vez de pegarlas.

Parámetros de ruta

1 campo

reservationIdstringObligatorio

ID de reserva

Identificador de reserva devuelto al crear el booking. En el endpoint de detalles unificados, envía solo uno entre reservationId, confirmationNumber o searchId.

Parámetros de consulta

2 campos

currencystring ISO 4217Opcional

Moneda

Moneda de los importes devueltos. Debe coincidir con la oferta o la reserva cuando ya existe una.

languagestringOpcional

Idioma

Campo de idioma legacy. Es preferible usar el header LANG o Accept-Language.

Petición cURL

cURL

bash

curl -X DELETE 'https://api.sandbox.travelandz.com/v1/transfers/reservations/:reservationId?currency=USD' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

Añade tus credenciales para enviar una petición.

Esta petición necesita identificadores o tokens de una llamada anterior. Ejecuta primero el paso previo y pega aquí sus valores.

Respuesta

Pulsa «¡Pruébalo!» para enviar una petición y ver la respuesta aquí.

Cancela una reserva y consulta el resultado del reembolso.

Autenticación y headers

Header	Descripción
`Authorization`	`Bearer <secret_key>`. Conserva el secret en el servidor y nunca lo escribas en logs del cliente.
`X-Travelandz-Id`	`<public_key>:<profile_code>`, donde el profile code persistido usa el formato `dp_<12 alfanuméricos>`.
`LANG`	Header recomendado para el idioma. También se acepta `Accept-Language`.
`Content-Type`	`application/json` para peticiones con body JSON.

Petición

Este endpoint no recibe body. reservationId va en el path. Si envías currency, debe coincidir con la moneda en la que se cobró la reserva.

Schema de parámetros

reservationId

stringSí

Reservation identifier returned when the booking was created.

Schema de query params

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Lowercase values are accepted and normalized. Defaults to USD on a new search and is inherited afterwards.

language

enum

en-USes-ESde-DEfr-FRpt-BRzh-CNit-IT

Legacy field. Prefer the LANG or Accept-Language header.

Respuesta exitosa

Devuelve si la reserva se canceló y si corresponde un reembolso. El reembolso sigue la política de cancelación que se mostró en la oferta.

cancelled: false y refunded: false son resultados válidos con HTTP 200, no errores. Lee siempre ambos campos en lugar de fiarte del código de estado.

Schema de respuesta

cancelled

booleanSí

False is a valid HTTP 200 outcome.

refunded

booleanSí

False is a valid HTTP 200 outcome.

refundAmount

numberNo

Amount refunded to the traveller.

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

refundPercent

numberNo

Ejemplos de respuesta

json

{
  "cancelled": true,
  "refunded": true,
  "refundAmount": 181.97,
  "currency": "USD",
  "refundPercent": 100
}

Errores

HTTP	Código	Significado	Acción recomendada
`400`		El body, la query o el path son inválidos, o incluyen una propiedad desconocida.	Corrige la petición usando el array `message`.
`400`	`transfer_invalid_currency`	La moneda está fuera de la lista soportada.	Usa una moneda soportada.
`400`	`transfer_invalid_language`	El idioma solicitado no está soportado.	Usa uno de los valores de idioma documentados.
`429`	`transfer_provider_error`	El servicio está temporalmente limitado por rate limit.	Reintenta con backoff exponencial.
`502`	`transfer_provider_error`	La petición no pudo completarse.	No asumas que tuvo éxito. Conserva tus identificadores y consulta la reserva cuando la operación pudiera haberse creado.
`400`	`transfer_currency_mismatch`	La moneda no coincide con la oferta, la cotización o la reserva.	Reutiliza la moneda devuelta por el paso anterior, u omite el campo para heredarla.
`503`		El precio no pudo confirmarse en este momento.	Reintenta más tarde. No reserves ni cobres al viajero.

Notas de uso

Cuando refunded sea true, muestra refundAmount con la currency devuelta en la misma respuesta. Revisa la política de cancelación de la oferta antes de que el viajero reserve, para que el reembolso nunca sea una sorpresa.

Ejemplo cURL

bash

curl --request DELETE \
  --url "https://api.sandbox.travelandz.com/v1/transfers/reservations/f390daff1fdf4cccb19b7abd825dc011?currency=USD" \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"