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

获取火车退款状态

读取退款操作及每个退款项目的状态。

分享

读取退款操作及每个退款项目的状态。

认证和请求头

请求头说明
AuthorizationBearer <secret_key>。密钥只能保存在服务器端，不能写入客户端日志。
X-Travelandz-Id<public_key>:<profile_code>，持久化的 profile code 格式为 dp_<12 位字母数字>。
Content-Type带 JSON body 的请求使用 application/json。

请求

Path 参数：gdsprovider 当前为 0；orderId 来自订单创建。

请求参数结构

gdsprovider
enum
0
是
Currently 0
orderId
string是
Order id returned by order creation.

成功响应

返回 refunds[]，包含退款 id、状态、时间戳、退款总额和项目级状态。退款可以是 success、pending 或 error。

响应体结构

refunds
array是
refunds[]id
string是
refunds[]state
enum
successpendingerror
是
refunds[]createdAt
string
格式: ISO 8601
是
refunds[]totalRefunded
object是
refunds[]totalRefundedamount
number是
refunds[]totalRefundedcurrency
string是
refunds[]items
array是
refunds[]items[]id
string是
refunds[]items[]state
enum
successpendingerror
是
refunds[]items[]amount
object是
refunds[]items[]amountamount
number是
refunds[]items[]amountcurrency
string是
refunds[]items[]parts
array是
refunds[]items[]parts[]segments
array是
refunds[]items[]parts[]segments[]departureAt
string
格式: ISO 8601
是
refunds[]items[]parts[]segments[]arrivalAt
string
格式: ISO 8601
是
refunds[]items[]parts[]segments[]durationInMinutes
number是
refunds[]items[]parts[]segments[]transport
enum
trainbusferry
是
refunds[]items[]parts[]segments[]identifier
string是

错误

  • 400 表示验证失败或存在未知字段。
  • 401 或 403 表示 API 凭证无效。
  • 供应方失败时返回 500 internal_communication_error 或 unknown_error。
  • 订单不存在时返回 order_not_found。

使用说明

发起退款后使用此端点区分已完成、进行中和失败的退款项目。

cURL 示例

bash
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"