Read refund operations and the state of each refunded item.
Authentication and headers
| Header | Description |
|---|---|
Authorization | Bearer <secret_key>. Keep the secret on the server and never write it to client logs. |
X-Travelandz-Id | <public_key>:<profile_code>, where the persisted profile code has the form dp_<12 alphanumeric>. |
Content-Type | application/json for requests with a JSON body. |
Request
Path parameters: gdsprovider is currently 0; orderId comes from order creation.
Request Params Schema
gdsproviderCurrently
0orderIdOrder id returned by order creation.
Success response
Returns refunds[] with refund id, state, timestamps, total refunded amount and item-level states. A refund can be success, pending or error.
Response Body Schema
refundsrefunds[]idrefunds[]staterefunds[]createdAtrefunds[]totalRefundedrefunds[]totalRefundedamountrefunds[]totalRefundedcurrencyrefunds[]itemsrefunds[]items[]idrefunds[]items[]staterefunds[]items[]amountrefunds[]items[]amountamountrefunds[]items[]amountcurrencyrefunds[]items[]partsrefunds[]items[]parts[]segmentsrefunds[]items[]parts[]segments[]departureAtrefunds[]items[]parts[]segments[]arrivalAtrefunds[]items[]parts[]segments[]durationInMinutesrefunds[]items[]parts[]segments[]transportrefunds[]items[]parts[]segments[]identifierErrors
400for validation or unknown fields.401or403for invalid API credentials.500 internal_communication_errororunknown_errorfor provider failures.order_not_foundwhen the order does not exist.
Usage notes
Use this endpoint after starting a refund to distinguish completed, pending and failed refund items.
cURL example
bash
curl --request GET \
--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"