POST/v1/trains/order/:gdsprovider/:orderId/refund

Solicitar un reembolso de tren

Inicia una operación de reembolso para ítems seleccionados de la orden.

Compartir

Inicia una operación de reembolso para ítems seleccionados de la orden.

Autenticación y headers

HeaderDescripción
AuthorizationBearer <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 tiene el formato dp_<12 alfanuméricos>.
Content-Typeapplication/json para peticiones con body JSON.

Petición

El body requiere un array no vacío itemIds con strings no vacíos.

Schema de parámetros

gdsprovider
enum
0
Sí
Currently 0
orderId
stringSí
Order id returned by order creation.

Schema del body

itemIds
arraySí
itemIds[]
string[]Sí

Respuesta exitosa

Devuelve result con id de operación, estado, fecha, importe total e información por ítem. El estado puede ser success, pending o error.

Schema de respuesta

result
objectSí
resultid
stringSí
resultstate
enum
successpendingerror
Sí
resultcreatedAt
string
Formato: ISO 8601
Sí
resulttotalRefundAmount
objectSí
resulttotalRefundAmountamount
numberSí
resulttotalRefundAmountcurrency
stringSí
resultitems
arraySí
resultitems[]id
stringSí
resultitems[]state
enum
successpendingerror
Sí
resultitems[]amount
objectSí
resultitems[]amountamount
numberSí
resultitems[]amountcurrency
stringSí

Errores

  • 400 por validación o campos desconocidos.
  • 401 o 403 por credenciales API inválidas.
  • 500 internal_communication_error o unknown_error por fallos del proveedor.
  • order_already_refunded cuando la orden ya fue reembolsada.
  • order_refund_items_not_found cuando no existen los ítems solicitados.

Notas de uso

Una respuesta HTTP exitosa aún puede tener estado pending. Consulta el endpoint de estado para verificar la finalización.

Ejemplo cURL

bash
bash
curl --request POST \
  --url "https://api.sandbox.travelandz.com/v1/trains/order/0/order_123/refund" \
  --header "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  --header "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE" \
  --header "Content-Type: application/json" \
  --data '{"itemIds":["refund_item_123"]}'