文档中心 > 综合交通-商家对接

alitrip.ship.return.notify (船票退票退款回填接口)

此接口为接入商调用飞猪接口回填退票状态,飞猪平台给用户进行退票退款。飞猪平台保证数据幂等。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
confirm_refund_r_q ShipAgentConfirmRefundRq 可选 退票请求入参
  • └ agent_ext_attr
  • String
  • 可选
  • {"id":1}
  • 扩展属性
  • └ agent_order_id
  • String
  • 必须
  • 3929290
  • 商家订单id
  • └ agent_refund_amount
  • Number
  • 必须
  • 3000
  • 退款金额(分)
  • └ agent_refund_trans_id
  • String
  • 可选
  • x123
  • 退款资金号唯一ID
  • └ agent_return_mode
  • String
  • 可选
  • offline/online
  • offline:线下退票;online:线上退票
  • └ agent_return_ticket_code
  • Number
  • 必须
  • 1904
  • 退票结果编码,(退票失败时必填,参考标准错误码)
  • └ agent_return_ticket_status
  • Number
  • 必须
  • 1
  • 商家退票状态;1-成功,2-失败
  • └ agent_return_ticket_type
  • Number
  • 必须
  • 0
  • 商家退票类型;0-按票退,1-按单退
  • └ agent_return_time
  • Date
  • 可选
  • 2019-12-20 09:39:00
  • 退票时间
  • └ agent_ticket_id
  • String
  • 可选
  • 392200
  • 按票的维度进行退票时,商家票号或者乘客Id必填一个,按单退填写订单号
  • └ alitrip_order_id
  • Number
  • 必须
  • 293930303
  • 飞猪订单号
  • └ passenger_id
  • String
  • 可选
  • 2224443930303
  • 乘客Id

响应参数

名称 类型 示例值 描述
ret_code String 1092 错误码
ret_msg String 成功 错误描述
ret_success Boolean true 结果

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripShipReturnNotifyRequest req = new AlitripShipReturnNotifyRequest();
AlitripShipReturnNotifyRequest.ShipAgentConfirmRefundRq obj1 = new AlitripShipReturnNotifyRequest.ShipAgentConfirmRefundRq();
obj1.setAgentExtAttr("{\"id\":1}");
obj1.setAgentOrderId("3929290");
obj1.setAgentRefundAmount(3000L);
obj1.setAgentRefundTransId("x123");
obj1.setAgentReturnMode("offline/online");
obj1.setAgentReturnTicketCode(1904L);
obj1.setAgentReturnTicketStatus(1L);
obj1.setAgentReturnTicketType(0L);
obj1.setAgentReturnTime(StringUtils.parseDateTime("2019-12-20 09:39:00"));
obj1.setAgentTicketId("392200");
obj1.setAlitripOrderId(293930303L);
obj1.setPassengerId("2224443930303");
req.setConfirmRefundRQ(obj1);
AlitripShipReturnNotifyResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alitrip_ship_return_notify_response>
    <ret_code>1092</ret_code>
    <ret_msg>成功</ret_msg>
    <ret_success>true</ret_success>
</alitrip_ship_return_notify_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部