文档中心 > API类目 > 汽车票B2B

taobao.bus.agent.refund.confirm (汽车票退票和退款二合一接口)

1.商家退票成功后，回调飞猪平台汽车票退票接口，平台进行退票和退款操作。

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
param_agent_confirm_return_and_refund_r_q	AgentConfirmReturnAndRefundRq	可选			入参
└ agent_order_id String 必须 332030233666 商家订单号 └ agent_refund_amount String 可选 10.5 退款金额,单位元;退票成功时必填 └ agent_refund_trans_id String 可选 x123 退款资金号唯一ID └ agent_return_ticket_status Number 必须 1 商家退票状态;1-成功,2-失败 └ agent_return_ticket_type Number 必须 1 商家退票类型;0-按票退,1-按单退 └ agent_return_time Date 可选 2018-07-01 07:07:07 退票时间点 └ agent_ticket_id String 可选 23023423255 按票的维度进行退票时，商家票号 └ depart_date Date 可选 2018-07-01 07:07:07 发车时间 └ main_biz_order_id Number 可选 123456789 平台单号 └ passenger_id_num String 可选 12345678998765432X 退票乘客证件号(按票退时必填) └ passenger_name String 可选张三退票乘客姓名 └ passenger_phone String 可选 18909080908 退款乘客手机号 └ agent_return_ticket_code Number 可选 1905 退票结果编码,(退票失败时必填,参考标准错误码) └ agent_ext_attr String 可选 {"id":1} 扩展属性json └ agent_return_mode String 可选 offline/online offline:线下退票;online:线上退票 └ refund_scene String 可选 common 退票场景，common:普通退款场景 force: 不可抗力 └ refund_scene_official_reason_code String 可选 0:班次停运1:天气原因2:疫情原因通知用户退票原因

响应参数

名称	类型	示例值	描述
result_code	String	PARAM_CHECK_INVALID_ORDER_ID	错误码
result_msg	String	无效平台/商家订单	错误描述
is_success	Boolean	false	退票回调是否收到

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
BusAgentRefundConfirmRequest req = new BusAgentRefundConfirmRequest();
BusAgentRefundConfirmRequest.AgentConfirmReturnAndRefundRq obj1 = new BusAgentRefundConfirmRequest.AgentConfirmReturnAndRefundRq();
obj1.setAgentOrderId("332030233666");
obj1.setAgentRefundAmount("10.5");
obj1.setAgentRefundTransId("x123");
obj1.setAgentReturnTicketStatus(1L);
obj1.setAgentReturnTicketType(1L);
obj1.setAgentReturnTime(StringUtils.parseDateTime("2018-07-01 07:07:07"));
obj1.setAgentTicketId("23023423255");
obj1.setDepartDate(StringUtils.parseDateTime("2018-07-01 07:07:07"));
obj1.setMainBizOrderId(123456789L);
obj1.setPassengerIdNum("12345678998765432X");
obj1.setPassengerName("张三");
obj1.setPassengerPhone("18909080908");
obj1.setAgentReturnTicketCode(1905L);
obj1.setAgentExtAttr("{\"id\":1}");
obj1.setAgentReturnMode("offline/online");
obj1.setRefundScene("common");
obj1.setRefundSceneOfficialReasonCode("0:班次停运1:天气原因2:疫情原因");
req.setParamAgentConfirmReturnAndRefundRQ(obj1);
BusAgentRefundConfirmResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<bus_agent_refund_confirm_response>
    <result_code>PARAM_CHECK_INVALID_ORDER_ID</result_code>
    <result_msg>无效平台/商家订单</result_msg>
    <is_success>false</is_success>
</bus_agent_refund_confirm_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测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

汽车票B2B

taobao.bus.agent.refund.confirm (汽车票退票和退款二合一接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ