纯网关接口文档
副标题:网银直连
修订历史
版本号 | 作者 | 修订章节 | 修订原因 | 修订日期 |
V1.0 | 技术支持团队 | 全版修改 | 加强文档结构的合理性 | 2008-11-17 |
V1.1 | 甘宁 | 订正部分接口参数和描述信息,例如:即时支付支持错误通知地址(error_notify_url) 更新签约接口容 | 接口升级、增加查询签约接口 | 2009-8-2 |
V1.2 | 甘宁 | 重新整理流程以及文档说明 | 使文档阅读性更强 | 2009-12-8 |
V1.3 | 甘宁 | 增加“公用回传参数” | 满足用户自定义参数的要求 | 2010-3-18 |
V1.4 | 甘宁 | 通知中增加网银流水 | 满足商户网银支付需求 | 2010-3-29 |
V1.5 | 甘宁 | 请求参数列表 | 支持自定义超时可以使用时间区间 | 2010-9-13 |
V1.5.1 | 甘宁 | 增加4.3.2的信用卡简码 | 信用卡大额支付也支持纯网关 | 2010-10-26 |
说明:
本接口将支付宝即时到帐接口用作纯网关的功能做详细介绍。
在集成时处理机制和原有支付宝即时到帐一样,请求时必须增加默认支付方式(paymethod)和默认网银(defaultbank)2个参数
1前言
1.1概述
本接口主要用在外部集成网银直连(纯网关)功能
1.2术语
名称 | 说明 |
外部商户、合作伙伴、商户 | 和支付宝进行业务合作的商户 |
通知页 | 参数名称Notify_url,所指定的互联网HTTP地址,当代扣完成之后,支付宝发送信息到该页面去,即调用该页面,该页面中的程序自动运行,并判断请求与处理获取到的信息 |
合作伙伴ID | 签约后,为商家自动分配的唯一编号。 |
分润 | 分润指将某一部分费用分给其它的 |
页面跳转 | 执行操作后跳转到其它页面 |
2接口功能及参数介绍
2.1标准即时到账接口(适用于纯网银)
2.1.1功能描述
调用此接口,根据用户传过来的参数创建交易,买家再付款。目前该接口的交易全部为即时到帐纯网银支付接口,即只要买家一付款,钱就会从买家银行卡转到卖家的支付宝账号。同时该接口还支持分润,商家传过来分润的账号和金额,系统会自动打款到该账号上。
2.1.2交互流程
2.1.3交互模式
请求/响应交互模式,页面跳转
2.1.4接口详细说明
2.1.4.1请求参数列表
特别注意:
a.)此接口只支持https请求,支付宝是以https进行验证
b.)按照支付宝外部请求接口概述中要求的签名方式,对输入参数进行签名,该接口请求才能够被支付宝系统接收。
c.)本接口支持重复调用,但是提交数据必须一样才可以。
d.)在请求时必须增加默认支付方式和默认网银2个参数
协议参数 | ||||
接口名称 | service | String | create_direct_pay_by_user | N |
合作伙伴ID | partner | String(16) | 合作伙伴在支付宝的用户ID与支付宝签约后自动生成 | N |
通知URL | notify_url | URL(String(190)) | 针对该交易的交易状态同步通知接收URL。 | N |
返回URL | return_url | URL | 结果返回URL,仅适用于立即返回处理结果的接口。支付宝处理完请求后,立即将处理结果返回给这个URL。 | N |
错误通知地址 (需要支付宝功能人员开通) | error_notify_url | URL(String(190)) | 如果在交易过程中出错(如签名错误等),则通过此URL将错误码返回给合作伙伴系统 | Y |
签名 | qq名片背景sign | String | 见签名机制,MD5加密算法后得出的结果 | N |
签名方式 | sign_type | String | 见签名方式,现今默认是MD5加密,无需更改该参数的值 | N |
参数编码字符集 | _input_charset | String(默认为GBK) | 合作伙伴系统与支付宝系统之间交互信息时使用的编码字符集。合作伙伴可以通过该参数指定使用何种字符集对传递参数进行编码。同时,支付宝系统也会使用该字符集对返回参数或通知参数进行编码。 注:该参数必须在queryString中传递,不论使用的是POST还是GET方式发送请求。如:.alipay./cooperate/gateway.do?_input_charset=utf-8 | N |
业务参数 | ||||
商品展示网址 | show_url | String(400) | 点击商品后跳转的页面 | Y |
商品名称 | subject | String(256) | 商品的标题 | N |
商品描述 | body | String(1000) | 商品的具体描述,如果是多种商品,请将商品描述字符串累加传给body | Y |
外部交易号 | out_trade_no | String(64) | 合作伙伴交易号(确保在合作伙伴系统中唯一) | N |
商品单价 | price | Number(13,2) | price:单位为RMB Yuan 0.01~100000000.00 total_fee:单位为RMB Yuan 0.01~100000000.00 quantity:0<quantity < 1000000 规则: 1.如果是多个商品可以汇总后传入,这个时候商品数量默认为1 2.总价和单价不可以同时出现 3.如果使用总价total_fee,则数量为quantity =1. 3.如果使用单价price,则商品数量quantity传递实际商品数量 | N |
交易金额 | total_fee | Number(13,2) | ||
购买数量 | quantity | Number(6,0) | ||
支付类型 | payment_type | String(4) | 默认为:1(商品购买); | N |
默认支付方式 | paymethod | String | bankPay(网银) | N |
默认网银 | defaultbank | String | 见常见银行列表 | N |
卖家Email | seller_email | String(100) | 卖家在支付宝的注册Email或注册ID,两者任何一个。 | N |
卖家ID | seller_id | String(16) | ||
提成类型 | royalty_type | String(2) | 目前只支持一种类型:卖家给第三方提成(目前参数=10) | Y |
提成信息集 | royalty_parameters | String(500) | 信息格式下面两种都可: 1、收款方Email_1^金额^备注|付款方Email^收款方Email_2^金额^备注 2、收款方Email_1^金额^备注|收款方Email_2^金额^备注 3.(属于多级分润)收款方Email_1^金额^备注|收款方Email_1^收款方Email_2^金额^备注 如有多条则用“|”隔开,最多不能超过10条,备注最多1000个字符,即500个汉字,详见“接口注意事项” 糖水杨梅 | Y |
超时时间 | it_b_pay | String(3) | 商户开通自定义超时功能才有用(支付宝控制权限),定义该交易的超时时间,m表示分钟,h表示小时,d表示天,c表示当天。 商户如果需要改功能,需要告知配置的时间点或者区间,有支付宝技术支持配置。 例如:1m~15d表示在1分钟和15天之任何一个时间都可以。 备注:默认15d关闭交易。当天理论上是当天的0点后关闭,但是由于是定时任务可能有所延迟。 | Y |
公用回传参数 | extra_common_param | String(200) | 用于商户回传参数,该值不能包含赛尔号战斗系精灵=&等 特殊字符。如果用户请求时传递了该参 数,则返回给商户时会回传该参数. | Y |
一个完整的支付接入请例:
.alipay./cooperate/gateway.do?body=支付宝支付 &defaultbank=CMB¬ify_url=wangjinmin.vip1.es163/ganning/asp_bank_before/Alipay_Notify.asp&out_trade_no=22&partner=4***5&payment_type=1&paymethod=bankPay&return_url=wangjinmin.vip1.es163/ganning/asp_bank_before/return_Alipay_Notify.asp&seller_email=gwl25126.&service=create_direct_pay_by_user&subject=测试商品&total_fee=100&sign=f67dd8e2c2bc26e4bb137be0e32f0cbc&sign_type=MD5 |
2.1.4.2返回参数列表
此接口有两种返回方式:
注意:选择具体网银支付方法,进入网银支付页面后才能创建交易,支付完成才返回通知。需要强调的是部分网银可能不支持支付完成及时跳转,所以商户最好在异步通知中做数据处理或者2个返回处理都集成,增加订单重复接受即可
A.(同步通知):系统根据执行的结果将相关订单信息返回(只做返回不需要商户和支付宝系统交互)
输出参数列表
基本信息 | ||||
是否成功 | is_success | String(1) | 表示该次操作是否成功 | N |
签名 | sign | String(32) | 见HTTP参数签名机制, 该参数需要获取做签名校验。 | N |
签名类型 | sign_type | String | 见签名方式 | N |
业务参数 微博语录 心情签名 | ||||
接口名称 | exterface | String | 使用支付宝的服务接口名称,用此参数可以确定是支付宝的服务 | Y |
通知时间 | notify_time | Timestamp | 通知时间(支付宝时间),格式: YYYY-MM-DD hh:mm:ss | Y |
通知ID | notify_id | String | 支付宝通知流水号,合作伙伴可以用这个流水号询问支付宝该条通知的合法性 | Y |
通知类型 | notify_type | String | trade_status_sync | Y |
支付宝交易号 | trade_no | String(16) | 该交易在支付宝系统中的交易流水号 | Y |
支付类型 | payment_type | String(4) | 值为1:商品购买 | Y |
外部交易号 | out_trade_no | String(64) | 该交易商户提交给支付宝的的交易流水号 | Y |
商品描述 | body | String(400) | 商品描述 | Y |
商品名称 | subject | String(256) | 商品名称 | Y |
总价 | total_fee | 送花留言 Number(13,2) | 总价 | Y |
买家Email | buyer_email | String(100) | 买家Email | Y |
买家ID | buyer_id | String(30) | 买家ID | Y |
卖家Email | seller_email | String(100) | 卖家Email | Y |
卖家ID | seller_id | String(30) | 卖家ID | Y |
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论