机票项目接口文档

机票项目接口文档 机票行业解决 方案 气瓶 现场处置方案 .pdf气瓶 现场处置方案 .doc见习基地管理方案.doc关于群访事件的化解方案建筑工地扬尘治理专项方案下载 接口文档 版本 0.1 修订历史 版本号 作者 修订章节 修订原因 修订日期 0.1 杨彬 2008-03-10 业务场景 接口定义 1. 标准即时到账接口 接口类型 页面跳转 输入参数 接口名称 service String create_direct_pay_by_user 合作伙伴ID partner String(16) 合作伙伴在支付宝的用户ID 通知URL notify_url URL 针对该交易的交易状态同步通 知接收URL。 返回URL return_url URL 结果返回URL,仅适用于立即 返回处理结果的接口。支付宝 处理完请求后,立即将处理结 果返回给这个URL。 代理商ID agent String(16) 如果一些交易网站的交易,有 一定的“代理”所属关系,代 理商可以在交易中传递该参 数,来表明代理的身份。这里 传送的值,请使用代理商所属 支付宝账户的PartnerID。 签名 sign String 见签名机制 签名方式 sign_type String 见签名方式 商品名称 subject String(256) 商品描述 body String(400) 外部交易号 out_trade_no String(64) 合作伙伴交易号，确保在合作 伙伴系统中唯一， 交易金额 total_fee Number(8,2单位为RMB Yuan 0.01～ ) 1000000.00,上限取决于买卖 双方的即时交易金额限制 商品单价 price Number(13,单位为RMB Yuan 2) 0.01～100000000.00 购买数量 quantity Number(6,0>0 ) 支付类型 payment_type String 见支付类型表 默认支付方paymethod String bankPay(网银);cartoon(卡式 通); directPay(余额) 默认网银 defaultbank String 见银行表 卖家Email seller_email String(100) 卖家在支付宝的注册Email或 注册ID,两者任何一个。 卖家ID seller_id String(30) 买家Email buyer_email String(100) 买家在支付宝的注册Email或 注册ID,如果买家还没有确定买家ID buyer_id String(30) 可以为空。 买家留言 buyer_msg String(200) 提成类型 royalty_type String(2) 目前只支持一种类型:卖家给 第三方提成，10， 提成信息集 royalty_parameString(500) 帐号1^提成金额1^说明1|帐 ters 号2^提成金额2^说明2|帐号 3^提成金额3^说明3 做多传入5个 说明不能超过30个字符,不能 有^和|符号 输出参数 notify_url,return_url返回 通知类型 notify_type String trade_status_sync N 通知ID notify_id String 支付宝通知流水号,合N 作伙伴可以用这个流 水号询问支付宝该条 通知的合法性 通知时间 notify_time Timestamp 通知时间，支付宝时N 间，,格式: YYYY-MM-DD hh:mm:ss 签名 sign String 见HTTP参数签名机N 制 签名方式 sign_type String 见签名方式 N 支付宝交trade_no String(64) 该交易在支付宝系统N 易号 中的交易流水号 外部交易out_trade_no String(64) 该交易在合作伙伴系N 号 统的流水号 支付类型 payment_type String 见支付类型枚举表 N 商品名称 subject String(256) N 商品描述 body String(400) Y 商品单价 price Number(13,2) 单位为RMB Yuan N 0.01～100000000.00 购买数量 quantity Number(6,0) >0 N 交易金额 total_fee Number(13,2) 单位为RMB Yuan N 0.01～1000000.00 交易状态 trade_status String 见交易状态枚举表 N 物流类型 logistics_type String 见物流类型枚举表 Y 物流费用 logistics_fee Number(8,2) 0.00～10000000.00 Y 物流支付logistics_payment String 见物流支付类型枚举Y 类型 表 收货人姓receive_name String(128) Y 名 收货人地receive _address String(256) Y 址 收货人邮receive _zip String(6) Y 编 收货人电receive _phone String(30) Y 话 收货人手receive _mobile String(11) Y 机 卖家Email seller_email String(100) N 卖家ID seller_id String(30) N 买家ID buyer_id String(30) N 买家Email buyer_email String(100) N 使用说明 何时使用: 交易未创建时及已创建未支付时 注意事项: royalty_parameters分润参数,分润参数顺序问题: 分润顺序按参数传入顺序执行,所有分润必须满足”入大于出,先入后出”原则 2. 冻结订单接口 接口类型 页面跳转 输入参数 协议参数 字段名称 变量名 类型 说明 可为空 接口名称 service string bank2freeze N 合作伙伴ID partner string 合作伙伴在支付宝的用户ID N 通知URL notify_url string 通知返回URL,仅适用于异步返回处理结果的Y 接口。 返回URL return_url string 结果返回URL,仅适用于立即返回处理结果的Y 接口。 签名 sign string N 签名类型 sign_type string N 编码字符集 _input_charsString 默认GBK Y et 业务参数 外部订单号 out_order_no string(64) 外部系统为业务生成的订单号 N 外部订单时间 out_order_dt timestam外部系统订单生成时间 N p 订单来源 order_from string(6) 订单的来源地(电子客票使用,淘宝=100001) Y 商品名称 subject string(256订单的商品标题 N ) 商品URL goods_url string(256订单商品的URL Y ) 详细信息 memo string 外部系统业务的订单详细信息 N 卖家用户ID seller_id string(16) 卖家支付宝用户ID Y 卖家email seller_email string 卖家email Y 买家用户ID buyer_id string(16) 买家支付宝用户ID Y 买家email buyer_email string 买家email Y 订单金额 amount String 0.01--1亿 。 金额类型 N 见业务类型表 操作类型 String(6) op_type N 输出参数 协议参数 字段名称 变量名 类型 说明 可为空 通知类型 notify_type String bank2freeze N 通知ID notify_id String 支付宝通知流水号,合作伙伴可以用这个流水N 号询问支付宝该条通知的合法性 通知时间 notify_time Timestam通知时间，支付宝时间，,格式: N p YYYY-MM-DD hh:mm:ss 签名 sign String 见HTTP参数签名机制 N 签名方式 sign_type String 见签名方式 N 业务参数 外部订单号 outOrderNo string(64) 外部系统为业务生成的订单号 N 订单号 orderNo String(64) 支付宝系统生成的订单号 N 订单状态 status String(2) N 使用说明 3. 冻结资金转交易接口 接口类型 系统调用 输入参数 协议参数 字段名称 变量名 类型 说明 可为空 接口名称 service string unfreeze2fastPay N 合作伙伴ID partner string 合作伙伴在支付宝的用户ID N 通知URL notify_url string 通知返回URL,仅适用于异步返回处理结果的Y 接口。 签名 sign string N 签名类型 sign_type string N 编码字符集 _input_charsString 默认GBK Y et 业务参数 外部订单号 out_order_no string(64) 外部系统为业务生成的订单号(最好有业务、N 企业前缀来标识订单) 外部交易号 out_trade_no string(64) 外部系统生成的交易唯一编号 N 外部订单时间 out_order_dt timestam外部系统订单生成时间 N p 买家昵称 buyer_nick string(100买家昵称 N ) 卖家昵称 seller_nick string(100卖家昵称 N ) 订单来源 order_from string(6) 订单的来源地(电子客票使用,淘宝=100001) Y 原外部订单号 old_out_ordestring(64) 外部系统的冻结资金时的订单号 N r_no 商品描述 goods_detail string(400购买商品详情(不同于商品名称) Y ) 交易总金额 totle_fee string 交易总金额 (0.01-100000000.00元) N 商品价格 price string 商品价格(0.01-100000000.00元) N 优惠折扣之类 other_fee string 其他费用(0.00-100000000.00元) N 佣金金额 commision string 收取佣金金额(0.00-100000000.00元) N 外部佣金订单out_order_nostring(64) 收取佣金金额对应的订单号 N 号 _commsion 见业务类型表 操作类型 String(50) op_type N 与收费相关的业务参数集合，形如收费参数集 String(200charge_proY agent_id=xxx;lottery_type=ssq ) ps 业务参数 Y 提成类型 royalty_typString(2) 目前只支持一种类型:卖家给第三方提 e 成，10， Y 提成信息集 royalty_parString(50分润收款账号1^提成金额1^说明1| ameters 0) 分润付款账号2^分润收款账号2^提成 金额2^说明2 单次条数不超过10条 说明不能超过30个字符,不能有^和| 符号 注意:当分润信息中没有显式指明分润 付款账号时,分润付款账户默认为卖家 账户 输出参数 response返回,notify_url返回: 协议参数 字段名称 变量名 类型 说明 可为空 外部订单号 out_order_no string(6外部系统为业务生成的订单号 N 4) 订单号 order_no string(6支付宝系统产生的订单号 N 4) 订单类型 order_type string N 金额 amount string N 买家ID buyer_user_id string N 卖家ID seller_user_id string N 转出帐户 trans_account_string N out 转入帐户 trans_account_istring N n 订单状态 order_status String(2查看文档附录 N ) 交易号 trade_no string(6对应这笔订单产生的交易ID Y 4) 使用说明 何时使用: 注意事项: royalty_parameters分润参数,分润参数顺序问题: 分润顺序按参数传入顺序执行,所有分润必须满足”入大于出,先入后出”原则 4. 分润接口 接口类型 系统调用 输入参数 接口名称 service String distribute_royalty N 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 通知URL notify_url URL 针对该交易的交易状态N 异步通知接收URL。 外部交易号 out_trade_no String(64) 合作伙伴交易号，确保Y 在合作伙伴系统中唯 一，,外部交易号,和外部 交易号不可同时为空 交易号 trade_no String(16) 支付宝交易号 Y 外部分润号 out_bill_no String(20) 外部单据号,一个合作N 伙伴中唯一 提成类型 royalty_type String(2) 目前只支持一种类型: Y 10 提成信息集 royalty_parameString(500) 分润收款账号1^提成Y ters 金额1^说明1|分润付 款账号2^分润收款账 号2^提成金额2^说明 2 单次条数不超过10条 说明不能超过30个字 符,不能有^和|符号 注意:当分润信息中没 有显式指明分润付款账 号时,分润付款账户默 认为卖家账户 输出参数 response返回: 是否成功 is_success String T,F Y 错误码 error String 错误原因,当Y is_success为F时不可 为空 使用说明 何时使用: 买家付完款后,交易未超时,且交易未关闭时可以调用 注意事项: royalty_parameters分润参数,分润参数顺序问题: 入大于出,先入后出”原则; 分润顺序按参数传入顺序执行,所有分润必须满足” 每次调用分润接口进行分润时必须传入out_bill_no用以标识, 当同一out_bill_no之前已分润成功,重复调用时返回成功(前后两次的分润参数必须完全相同). 5. 即时到账退款(无密)接口 接口类型 系统调用 输入参数 接口名称 service String refund_fastpay_by_plN atform_nopwd 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 通知URL notify_url URL 针对该交易的交易状态N 异步通知接收URL。 批次号 batch_no String(11) 退款日期+3位流水号,N 如:20060702001,注 意不可重复。 退款请求日refund_date String(19) yyyy-MM-dd N 期 hh:mm:ss如: 2007-10-01 13:13:13 hh为24小时制 总笔数 batch_num String “单笔数据集”里面的 交易总笔数 单笔数据集 detail_data String 最多支持1000条 N 返回类型 return_type String response返回的返回Y 类型:xml,html 默认xml 输出参数 response返回: 是否成功 is_success String T,F N 错误码 error String 错误原因,当Y is_success为F时不可 为空 notify_url返回: 接口名称 service String refund_fastpay_by_pN latform_nopwd 通知类型 notify_type String refund_fastpay_by_pN latform_notify 通知ID notify_id String 支付宝通知流水号,合N 作伙伴可以用这个流 水号询问支付宝该条 通知的合法性 签名 Sign String 见HTTP参数签名机N 制 签名方式 sign_type String 见签名方式 N 成功标志 is_success String T/F,系统成功处理标N 志 通知时间 notify_time String 通知时间，支付宝时N 间，,格式: yyyy-MM-dd hh:mm:ss 批次号 batch_no String 原请求批次号 N 退款成功总success_num String 一笔交易,退交易款成N 数 功才是成功。0<= success_num<= batch_num 结果处理详result_details String 处理结果描述 情 使用说明 何时使用: 买家付完款后,交易未超时,且交易未关闭时可以调用. 此接口可多次调用,直至全部款项都退完,交易关闭. 注意事项: 调用此接口同步的response返回成功只代表批量退款申请被接受. 系统异步执行批量退款,退款结果参见notify_url的返回. 6. 即时到账退款(有密)接口 接口类型 页面跳转 输入参数 接口名称 service String refund_fastpay_by_plN atform_pwd 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 通知URL return_url URL 针对该交易的交易状态N 页面跳转返回的URL。 通知URL notify_url URL 针对该交易的交易状态N 异步通知接收URL。 批次号 batch_no String(11) 退款日期+3位流水号,N 如:20060702001,注 意不可重复。 退款请求日refund_date String(19) yyyy-MM-dd N 期 hh:mm:ss如: 2007-10-01 13:13:13 hh为24小时制 总笔数 batch_num String “单笔数据集”里面的 交易总笔数 单笔数据集 detail_data String 最多支持1000条 N 返回类型 return_type String response返回的返回Y 类型:xml,html 默认xml 输出参数 return_url返回 是否成功 is_success String T,F N 错误码 error String 错误原因,当Y is_success为F时不可 为空 notify_url返回 接口名称 service String refund_fastpay_by_plN atform_pwd 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 通知URL notify_url URL 针对该交易的交易状态N 异步通知接收URL。 批次号 batch_no String(11) 退款日期+3位流水号,N 如:20060702001,注 意不可重复。 退款请求日refund_date String(19) yyyy-MM-dd N 期 hh:mm:ss如: 2007-10-01 13:13:13 hh为24小时制 总笔数 batch_num String “单笔数据集”里面的 交易总笔数 单笔数据集 detail_data String 最多支持1000条 N 使用说明 何时使用: 买家付完款后,交易未超时,且交易未关闭时可以调用. 此接口可多次调用,直至全部款项都退完,交易关闭. 注意事项: 此接口不同于无密接口,是给交易的卖家批量退款用的,因此detail_data中的交易必须都是以操作用户为卖家的. 当一批退款中存在不是以当前用户为卖家的交易,这些交易不会被受理,并会在请求时每笔不成功交易的申请失败原因. 调用此接口return_url返回成功只代表批量退款申请被接受. 系统异步执行批量退款,退款结果参见notify_url的返回. 7. 用户自助签约接口 接口类型 页面重定向 输入参数 接口名称 service String sign_protocol_with_pN artner 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 签署者email email String 签署电子协议者的Y email地址。如果为空, 则需要在支付宝网站输 入该email。 输出参数 无 使用说明 8. 用户解约接口 接口类型 系统调用 输入参数 接口名称 service String customer_unsign N 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N String(20) 用户的账号 N 用户账号 trans_account_ out 业务代码 biz_type String 机票对应的biz_typeN 为1004 输出参数 response返回: 签名 sign String 见HTTP参数签名机制 N 签名方式 sign_type String 见签名方式 N 是否成功 is_success String T代表成功,F代表失败 N 使用说明 9. 商户签约查询接口 接口类型 系统调用 输入参数 接口名称 service String query_partner_protoN col 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N 业务代码 biz_type String 机票对应的biz_typeN 为1004 输出参数 response返回 签名 sign String 见HTTP参数签名机制 N 签名方式 sign_type String 见签名方式 N 是否成功 is_protocol String T已签约,F未签约或已N 解约 使用说明 10. 用户签约查询接口 接口类型 系统调用 输入参数 接口名称 service String query_customer_proN tocol 合作伙伴ID partner String(16) 合作伙伴在支付宝的用N 户ID 签名 sign String 见签名机制 N 签名方式 sign_type String 见签名方式 N String(20) 用户账号 trans_account_用户的账号 N out 业务代码 biz_type String 机票对应的biz_typeN 为1004 输出参数 response返回 签名 sign String 见HTTP参数签名机制 N 签名方式 sign_type String 见签名方式 N 是否成功 is_protocol String T已签约,F未签约或已N 解约 使用说明