接口名称 |
页面名称 |
隶属版本 |
功能说明 |
获取产品(门票)列表 |
GetProducts.aspx |
V1.0。 |
从接口中获取可以预定(预购)的产品(门票)列表。 |
获取产品(门票)库存 |
GetProductsInventory.aspx。 |
V3.0。 |
从接口获取一种或多种产品的库存量(仅限景区版本,演艺版本GetProducts2.aspx自带余量,不能调用此函数)。 |
发起预定 |
OrderProducts.aspx。 |
V1.0。 |
发起预定。 |
获取支付渠道 |
GetPayChannel.aspx。 |
V1.0。 |
从官方获取支付渠道。 |
查询定单状态 |
QueryOrder.aspx。 |
V1.0。 |
查询单个定单的状态。V1.0、V2.0均有此函数,V3.0对入口参数和返回值做了修改。此API可以用于获取某一个订单较为详细的信息。 |
查询订单列表 |
QueryOrdersList.aspx。 |
V1.0。 |
查询定单列表。V1.0、V2.0均有此函数,V3.0对入口参数和返回值作了修改。 |
查询订单列表页数 |
QueryOrderPageListCount.aspx。 |
V1.0。 |
查询系统内某个代理商的订单列表页数。V1.0、V2.0均有此函数,V3.0对入口参数和返回值作了修改。 |
发起预订金支付授权(手机验证码) |
ReadyToPay.aspx。 |
V1.0。 |
准备进行预订金支付授权。调用此API将给代理商在供应商处登记的手机上发送一个用于某个订单进行预订金支付授权的验证码,验证码的有效期是6分钟,重新下发支付的间隔是一分钟。在供应商处没有“预订金支付许可”的代理商调用这个接口时将返回错误。您的账户在供应商处是否有“预订金支付许可”,请调用GetAgentParameters.aspx获取。 |
完成预订金支付授权(手机验证码) |
UseAccountToPay.aspx。 |
V1.0。 |
完成预付款支付授权。调用此API成功后,对应的订单将转换为“预订金支付授权”状态。表示已经许可游客到供应商处取票或激活(取票或激活为交割过程)订单了,取票或激活时,将从您的预订金账户中扣除相应的金额。 |
取消预定 |
CancelOrder.aspx。 |
V1.0。 |
取消(关闭)预定单。可以取消在预定状态、预定金支付授权状态及返款余额支付授权状态的订单。调用此操作成功之后,订单进入终止状态:已关闭。调用这个过程可能产生成本。成本的产生可能是因为供应商设置了“互联网违约手续费”且被操作的订单触发了互联网违约的相关条件。对于预订中的订单执行此操作,任何情况下不会产生成本;对于预订金支付授权的订单执行此操作,产生的成本将直接从预订金账户中扣除;对于返款余额支付授权的订单此行此操作,产生的成本将直接从返款余额账户中扣除。供应商是否设置了违约手续费请通过接口GetAgentParameters.aspx获取。对于已经激活的,直接退票处理。 |
下发修改支付密码的短信验证码 |
GetVerificationCode.aspx。 |
V2.3。 |
支付密码是由代理商掌控的,自动交易时使用的口令。可以由代理商自行修改。系统通过下发一个手机短信验证码来确认启动修改过程。 |
修改支付密码 |
ChangePayPwd.aspx。 |
V2.3。 |
修改用于自动化交易的支付密码。支付密码可以用于发起预定金支付授权和返款余额支付授权。调用此接口前请调用4.2.23获取一个用于修改支付密码的验证码。 |
完成预订金支付授权(支付密码) |
UseAccountToPayByPwd.aspx。 |
V2.3。 |
使用支付密码将某个订单执行预定金支付授权。 |
查询预订金账户余额 |
QueryYFKRec.aspx。 |
V1.0。 |
查询系统代理商的账户余额。 |
下达预订单并以预订金支付授权的形式支付预定单 |
OrderAndPayWithYDJ.aspx。 |
V1.0。 |
在一个流程内,完成下预订单并使用支付密码执行预订金支付授权,依据接口方的业务ID防止订单重复提交。 |
获取供应商电子门票交易接口设置 |
GetProviderConfig.aspx。 |
V3.0。 |
获取供应商电子门票交易接口参数设置。 |
获取景区线路(服务项目)列表 |
GetServiceItem.aspx。 |
V3.0。 |
获取供应商线路列表。仅在供应商启用时段设置时,此函数才可以被调用。 |
获取时段列表 |
GetTimeSegment.aspx。 |
V3.0。 |
获取供应商电子门票时段分配表。仅在供应商启用时段设置时,此函数才可以被调用。 |
远程激活 |
ActivateTicket.aspx。 |
V3.0。 |
远程激活订单(相当于取票)。 |
获取激活(取票)信息 |
GetTicketList.aspx。 |
V3.0。 |
获取订单激活(取票)的详细信息。 |
设置代理商回调地址等参数 |
SetAgentParameters.aspx。 |
V3.0。 |
设置接口方回调地址。 |
回调页面接口-订单状态变化回调 |
Notify_OrderChanged.aspx。 |
V3.0。 |
订单状态发生变化时,电子门票系统向第三方接口的回调。以下状态将产生回调:预订中(订单创建)、已支付(预订金授权)、已支付(返款余额支付授权)、已支付(即时支付)、已交割(前台现付)、已交割(预订金支付、即时支付)、已关闭、已交割(返款余额支付授权)。 |
回调页面接口-退票事件回调 |
Notify_Refund.aspx。 |
V3.0。 |
前台现付、预订金支付、即时支付所购得的门票,在退票后执行的回调。对于预订金支付、即时支付(非官方网站、官微、官方APP)的第三方代理商客人退票,退款方式为“2原路退回”的,代理商需为游客办理退款。 |
回调页面接口-返款票票退票事件回调 |
Notify_Refund_FK.aspx。 |
V3.0。 |
返款预约支付所购得的门票,在退票后执行的回调。返款余额所购得的门票,仅会退还返款余额账户,不能前台退现,因此,第三方代理商应再行给游客办理退款。官方网站、官微、官方APP均是不可能发生返款余额支付购票的情形。 |
回调页面接口-过闸(消费)事件回调 |
Notify_Checked.aspx。 |
V3.0。 |
在客人持票首次经过闸机后进行回调(同一张门票的N次过闸只会回调一次)。 |
获取门票的验证记录 |
QueryTicketCheckList.aspx。 |
V3.0。 |
获门某个门票全部的验票记录。 |
退票办理 |
RefundTicket.aspx。 |
V3.1。 |
2017-03-27添加,主要用于互联网激活后的退票办理。对于已激活,但没有列印门票、没有过闸的,可以直接在网上申请办理某一个门票的退款(退票),对于已经列印、过闸的,不能在网上办理退款。对于分时段模式售检票的,票对应的时段,在该时段截止时间前30分钟以上,可以在网上办理没有列印、没有过闸的门票的退款(退票),否则即不能在网上办理,也不能在窗口办理。 |