支付宝即时到账交易接口

请求参数说明

含义

请求参数是商户在与支付宝进行数据交互时,提供给支付宝的请求数据,以便支付宝根据这些数据进一步处理。

基本参数

service

接口名称 String 接口名称。 不可空 create_direct_pay_by_user

partner

合作者身份ID String(16) 签约的支付宝账号对应的支付宝唯一用户号。 以2088开头的16位纯数字组成。 不可空 2088101011913539

_input_charset

参数编码字符集 String 商户网站使用的编码格式,如utf-8、gbk、gb2312等。 不可空 gbk

sign_type

签名方式 String DSA、RSA、MD5三个值可选,必须大写。 不可空 MD5

sign

签名 String 请参见“9 签名机制”。 不可空 7d314d22efba4f336fb187697793b9d2

notify_url

服务器异步通知页面路径 String(190) 支付宝服务器主动通知商户网站里指定的页面http路径。 可空 http://api.test.alipay.net/atinterface/receive_return.htm

return_url

页面跳转同步通知页面路径 String(200) 支付宝处理完请求后,当前页面自动跳转到商户网站里指定页面的http路径。 可空 http://api.test.alipay.net/atinterface/receive_return.htm

error_notify_url

请求出错时的通知页面路径 String(200) 当商户通过该接口发起请求时,如果出现提示报错,支付宝会根据“11.7 item_orders_info出错时的通知错误码”和“11.8 请求出错时的通知错误码”通过异步的方式发送通知给商户。 该功能需要联系支付宝开通。 可空 http://api.test.alipay.net/atinterface/receive_return.htm

业务参数

out_trade_no

商户网站唯一订单号 String(64) 支付宝合作商户网站唯一订单号。 不可空 6843192280647118

subject

商品名称 String(256) 商品的标题/交易标题/订单标题/订单关键字等。 该参数最长为128个汉字。 不可空 贝尔金护腕式

payment_type

支付类型 String(4) 取值范围请参见附录“11.6 收款类型”。 默认值为:1(商品购买)。 注意: 支付类型为“47”时,公共业务扩展参数(extend_param)中必须包含凭证号(evoucheprod_evouche_id)参数名和参数值。 不可空 1

total_fee

交易金额 Number 该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 不可空 100

seller_id

卖家支付宝用户号 String(16) 卖家支付宝账号对应的支付宝唯一用户号。 以2088开头的纯16位数字。 不可空 2088002007018966

buyer_id

买家支付宝用户号 String(16) 买家支付宝账号对应的支付宝唯一用户号。 以2088开头的纯16位数字。 可空 2088002007018955

seller_email

卖家支付宝账号 String(100) 卖家支付宝账号,格式为邮箱或手机号。 可空 [email protected]

buyer_email

买家支付宝账号 String(100) 买家支付宝账号,格式为邮箱或手机号。 可空 [email protected]

seller_account_name

卖家别名支付宝账号 String(100) 卖家别名支付宝账号。 卖家信息优先级:seller_id>seller_account_name>seller_email。 可空 [email protected]

buyer_account_name

买家别名支付宝账号 String(100) 买家别名支付宝账号。 买家信息优先级:buyer_id>buyer_account_name>buyer_email。 可空 [email protected]

price

商品单价 Number 单位为:RMB Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。此参数为单价 规则:price、quantity能代替total_fee。即存在total_fee,就不能存在price和quantity;存在price、quantity,就不能存在total_fee。 可空 10.00

quantity

购买数量 Number price、quantity能代替total_fee。即存在total_fee,就不能存在price和quantity;存在price、quantity,就不能存在total_fee。 可空 1

body

商品描述 String(1000) 对一笔交易的具体描述信息。如果是多种商品,请将商品描述字符串累加传给body。 可空 美国专业护腕鼠标垫,舒缓式凝胶软垫模拟手腕的自然曲线和运动,创造和缓的GelFlex舒适地带!

show_url

商品展示网址 String(400) 收银台页面上,商品展示的超链接。 可空 http://www.360buy.com/product/113714.html

paymethod

默认支付方式 String 取值范围: 􀁺 creditPay(信用支付) 􀁺 directPay(余额支付) 如果不设置,默认识别为余额支付。 􀀉说明: 必须注意区分大小写。 可空 directPay

enable_paymethod

支付渠道 String 用于控制收银台支付渠道显示,该值的取值范围请参见“11.3 支付渠道”。 可支持多种支付渠道显示,以“^”分隔。 可空 directPay^bankPay^cartoon^cash

need_ctu_check

网银支付时是否做CTU校验 String 商户在配置了支持CTU(支付宝风险稽查系统)校验权限的前提下,可以选择本次交易是否需要经过CTU校验。 􀁺 Y: 做CTU校验; 􀁺 N: 不做CTU校验。 可空 Y

royalty_type

提成类型 String(2) 目前只支持一种类型:10(卖家给第三方提成)。 当传递了参数royalty_parameters时,提成类型参数不能为空。 可空 10

royalty_parameters

分润账号集 String(1000) 参见“4.4 royalty_parameters参数说明”。 可空 参见“4.4 royalty_parameters参数说明”

anti_phishing_key

防钓鱼时间戳 String 通过时间戳查询接口获取的加密支付宝系统时间戳。 如果已申请开通防钓鱼时间戳验证,则此字段必填。 可空 587FE3D2858E6B01E30104656E7805E2

exter_invoke_ip

客户端IP String(15) 用户在创建交易时,该用户当前所使用机器的IP。 如果商户申请后台开通防钓鱼IP地址检查选项,此字段必填,校验用。 可空 128.214.222.111

extra_common_param

公用回传参数 String(100) 如果用户请求时传递了该参数,则返回给商户时会回传该参数。 可空 你好,这是测试商户的广告。

extend_param

公用业务扩展参数 String 用于商户的特定业务信息的传递,只有商户与支付宝约定了传递此参数且约定了参数含义,此参数才有效。 参数格式:参数名1^参数值1|参数名2^参数值2|…… 多条数据用“|”间隔。 支付类型(payment_type)为47(电子卡券)时,需要包含凭证号(evoucheprod_evouche_id)参数名和参数值。 可空 pnr^MFGXDW|start_ticket_no^123|end_ticket_no^234|b2b_login_name^abc

it_b_pay

超时时间 String 设置未付款交易的超时时间,一旦超时,该笔交易就会自动被关闭。 取值范围:1m~15d。 m-分钟,h-小时,d-天,1c-当天(无论交易何时创建,都在0点关闭)。 该参数数值不接受小数点,如1.5h,可转换为90m。 该功能需要联系支付宝配置关闭时间。 可空 1h

default_login

自动登录标识 String 用于标识商户是否使用自动登录的流程。如果和参数buyer_email一起使用时,就不会再让用户登录支付宝,即在收银台中不会出现登录页面。 取值有以下情况: 􀁺 Y代表使 用 􀁺 N代表不 使用 该功能需要联系支付宝配置。 可空 Y

product_type

商户申请的产品类型 String(50) 用于针对不同的产品,采取不同的计费策略。 如果开通了航旅垂直搜索平台产品,请填写CHANNEL_FAST_PAY;如果没有,则为空。 可空 CHANNEL_FAST_PAY

token

快捷登录授权令牌 String(40) 如果开通了快捷登录产品,则需要填写;如果没有开通,则为空。 可空 201103290c9f9f2c03db4267a4c8e1bfe3adfd52

item_orders_info

商户回传业务参数 String(40000) 买家通过etao购买的商品的详细清单。如果是etao商户则填写;如果不是,则为空。 详细规则请参见“4.3.1 item_orders_info参数说明”。 可空 参见“4.3.2 item_orders_info参数样例”

sign_id_ext

商户买家签约号 String(50) 用于唯一标识商户买家。 如果本参数不为空,则sign_name_ext不能为空。 可空 ZHANGSAN

sign_name_ext

商户买家签约名 String(128) 商户买家唯一标识对应的名字。 可空 张三

qr_pay_mode

扫码支付方式 String(1) 扫码支付的方式,支持前置模式和跳转模式。 前置模式是将二维码前置到商户的订单确认页的模式。需要商户在自己的页面中以iframe方式请求支付宝页面。具体分为以下3种: 􀁺 0:订 单码-简约前置模式,对应iframe宽度不能小于600px,高度不能小于300px; 􀁺 1:订单码-前置模式,对应iframe宽度不能小于300px,高度不能小于600px; 􀁺 3:订单码-迷你前置模式,对应iframe宽度不能小于75px,高度不能小于75px。 跳转模式下,用户的扫码界面是由支付宝生成的,不在商户的域名下。 􀁺 2:订单码-跳转模式 可空 1 注意: 􀁺 此接口只支持https请求; 􀁺 参数body(商品描述)、subject(商品名称)、extra_common_param(公用回传参数)不能包含特殊字符(如:#、%、&、+)、敏感词汇,也不能使用外国文字(旺旺不支持的外文,如:韩文、泰语、藏文、蒙古文、阿拉伯语); 􀁺 请按照“9 签名机制”中的签名方法对输入参数进行签名,该接口请求才能够被支付宝系统接收; 􀁺 此接口支持重复调用,前提是交易基本信息(买家、卖家、交易金额、超时时间等)在多次调用中保持一致,且交易尚未完成支付; 􀁺 配置qr_pay_mode为0或1或3(扫码支付方式为订单码-简约前置模式或订单码-前置模式或订单码-迷你前置模式)的情况下,同步通知地址return_url需要传入商户中间跳转页面,即该页面需要实现让父页面自行跳转的功能,中间页面javascript代码:

商户回传业务参数

item_orders_info参数说明 ( 1) 业务参数间以“&+&”间隔。 ( 2) 每个参数连接时需加上参数名称,如:out_iids=1&+&nums=2…。 (3) 当参数出错时,通过请求参数中提交的error_notify_url,异步的返回错误信息给商户。 (4) 下表中的参数分为商品级参数和订单级参数。 ( 5) 如果商品级参数出错,则不将商品级参数信息和订单级参数信息回传给商户。 ( 6) 如果商品级参数都正确,订单级参数有遗漏不全,那么需将商品级参数信息回传给商户;订单级参数信息中出错的信息不回传给商户,未出错的订单级参数信息回传给商户。 ( 7) 整个参数的总长度不超过8W个字节。 表 4-2 商户回传业务参数说明

商品级参数

out_iids 商品站外ID列表 String 商品站外ID列表,以“&-&”分隔。 􀁺 最大支持30个; 􀁺 不能为空; 􀁺 不能部 分为空; 􀁺 每个ID不 能超过32个字节。 不可空 id1&-&id2&-&id3 nums 每件商品的购买数量列表 String 每件商品的购买数量列表,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能 为空; 􀁺 不能 部分为空; 􀁺 必须 为正整数; 􀁺 不能 超过2147483648。 不可空 1&-&2&-&3 prices 每个宝贝的价格列表 String 每个宝贝的价格列表,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能 为空; 􀁺 不能 部分为空; 􀁺 单位 :元,精确到分; 􀁺 必须为 正数; 􀁺 不能超9999999999999.99。 不可空 2.50&-&10.01&-&3.00 titles 每个商品的标题列表 String 每个商品的标题列表,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能为空; 􀁺 不能部分为空; 􀁺 每个title不能超过256个字节。 不可空 商品标题1&-&商品标题2&-&商品标题3 skus 每个宝贝的详细信息列表 String 每个宝贝的详细信息列表,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能为空; 􀁺 不能部分为空; 􀁺 如果都没有sku则可填写为空格,但不能为空串或空; 􀁺 每个sku不能超过1000个字节。 不可空 颜色:黑色;尺码:40θ&-&颜色:白色;尺码:40 detail_urls 每个商品的页面展示地址 String 每个商品的页面展示地址,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能为空; 􀁺 不能部分为空; 􀁺 必须为http://或https://开头的url地址; 􀁺 每个detail_url不能超过400个字节。 不可空 http://taobao.item.aa.html&-& http://taobao.item.bb.html &-& http://taobao.item.cc.html pic_urls 每个商品的图片绝对路径url列表 String 每个商品的图片绝对路径url列表,以“&-&”分隔,务必保持与out_iids列表的个数一致。 􀁺 不能为空; 􀁺 不能部分为空; 􀁺 每个url必须以http://或https://开头,以jpg、peg、gif或png结尾; 􀁺 每个pic_uirl不能超过400个字节。 不可空 http://www.taowaidian.com/img/bg-taxis-cur.png&-&http://www.taowaidian.com/img/list_menu_sch_btn.gif&-&http://www.taowaidian.com/img/logo.gif

订单级参数

logistics_type

物流方式 String 物流方式。 􀁺 不能为空; 􀁺 post(平邮),express(快递),其它报错。 不可空 post

post_fee

物流费用 String 物流费用。 􀁺 不能为空; 􀁺 必须为非负数; 􀁺 精确到分; 􀁺 不能超9999999999999.99。 不可空 10.00

promotion_desc

订单上的优惠描述信息 String(256) 订单上的优惠描述信息,如果无优惠或者不需要描述,则可不传。 可空 1.全场满500送50 2.满300减50

receiver_name

收货人姓名 String(256) 收货人姓名。 不可空 张三

receiver_address_prov

收货人省或直辖市名称 String(40) 新增收货地址时,填入省份或直辖市名称。 不可空 浙江省

receiver_address_city

收货人省会或地级市名称 String(80) 新增收货地址时,填入省会或地级市名称。 不可空 杭州市

receiver_address_area

收货人县或区名称 String(80) 新增收货地址时,填入县区名称。 不可空 西湖区

receiver_address

收货人街道详细地址 String 新增收货地址时,填入的街道地址。 􀁺 不能为空; 􀁺 长度在5-120个字节; 􀁺 不能全部字母或数字。 不可空 华星路99号创业大厦

receiver_mobile

收货人手机号码 String 收货人手机号码。 􀁺 可空; 􀁺 手机号码和固定电话号码必填其一; 􀁺 当非空时必须为11位数字; 􀁺 必须为正常的手机号规则。 可空 13812345678

receiver_phone

收货人固定电话号码 String 固定电话号码。 􀁺 可空; 􀁺 手机号码和固定电话号码必填其一; 􀁺 当非空时必须为正确的电话号码。格式:区号-号码; 􀁺 长度在6-20个字节。 可空 0571-88155188

item_orders_info参数样例

out_iids=id1&-&id2&+&nums=1&-&2&+&prices=2.50&-&10.01&+&skus=颜色:黑色;尺码:40θ&-&颜色:白色;尺码:40&+&titles=商品标题1&-&商品标题2&+&detail_urls=http://taobao.item.aa.html&-&http://taobao.item.bb.html&+&pic_urls=http://www.taowaidian.com/img/bg-taxis-cur.png&-&http://www.taowaidian.com/img/list_menu_sch_btn.gif&+&logistics_type=post&+&post_fee=10.00&+&promotion_desc=1.全场满500送50 2.满300减50&+&receiver_name=张三 即时到账交易接口 支付宝(中国)网络技术有限公司 版权所有| 版本:4.8 第 23 页 &+&receiver_address_prov=浙江省&+&receiver_address_city=杭州市&+&receiver_address_area=西湖区&+&receiver_address=华星路99号创业大厦&+&receiver_mobile=13812345678&+&receiver_phone=0571-88155188

item_orders_info出错通知

1 . item_orders_info出错通知含义 当item_orders_info参数校验出错时,需要异步发送错误通知给商户。 􀁺 商户通知地址为请求参数中提交的error_notify_url。 􀁺 商户通知参数信息参见:“2. item_orders_info出错通知参数列表”。 􀁺 商户收到通知后,需要返回“success”。如果没有返回,会在10分钟内发送7次,直至收到商户返回信息为止。 2 . item_orders_info出错通知参数列表 表 4-3 item_orders_info出错通知参数列表 基本参数

partner

合作者身份ID String(16) 签约的支付宝账号对应的支付宝唯一用户号。 以2088开头的16位纯数字组成。 不可空 2088101011913539 业务参数

out_trade_no

商户网站唯一订单号 String(64) 对应商户网站的订单系统中的唯一订单号,非支付宝交易号。 需保证在商户网站中的唯一性。是请求时对应的参数,原样返回。 不可空 6402757654153618

error_code

错误码 String(1024) item_orders_info参数校验出错的错误码。 当出现多个错误时,将错误码用“|”连接起来。 错误码详情参见:“11.7 item_orders_info出错时的通知错误码”。 不可空 ERROR_GOODS_OUT_IIDS_IS_NULL|ERROR_GOODS_SKUS_IS_NULL

buyer_email

买家支付宝账号 String(100) 买家支付宝账号。 buyer_email与buyer_id必填一个。 可空 [email protected]

buyer_id

买家支付宝账户号 String(16) 买家支付宝账号对应的支付宝唯一用户号。 以2088开头的纯16位数字。 buyer_email与buyer_id必填一个。 可空 2088002007018955

seller_email

卖家支付宝账号 String(100) 卖家支付宝账号。 seller_email与seller_id必填一个。 可空 [email protected]

seller_id

卖家支付宝账户号 String(16) 卖家支付宝账号对应的支付宝唯一用户号。 以2088开头的纯16位数字。 seller_email与seller_id必填一个。 可空 2088002007018966 3 . item_orders_info出错通知样例 http://api.test.alipay.net?partner=2088101011913539&[email protected]&buyer_id=2088002007018955&[email protected]&seller_id=2088002007018966&out_trade_no=6402757654153618&error_code=ERROR_GOODS_OUT_IIDS_IS_NULL|ERROR_GOODS_SKUS_IS_NULL

royalty_parameters参数说明

1 . 参数格式说明 royalty_parameters参数为分润账号集,支持以下格式(用户UID是一串以字母uid开头,后面跟着以2088开头的16位数字的字符串): ( 1) 平级分润 􀁺 收款方Email1^金额1^备注1|收款方Email2^金额2^备注2 􀁺 付款方Email^收款方Email1^金额1^备注1|付款方Email^收款方Email2^金额2^备注2 􀁺 收款方UID1^金额1^备注1|收款方UID2^金额2^备注2 􀁺 付款方U ID^收款方UID1^金额1^备注1|付款方UID^收款方UID2^金额2^备注2 (2) 多级分 润 􀁺 收款 方Email1^金额1^备注1|付款方Email1^收款方Email2^金额2^备注2|付款方Email2^收款方Email3^金额3^备注3 􀁺 收款方UID1^金额1^备注1|付款方UID1^收款方UID2^金额2^备注2|付款方UID2^收款方UID3^金额3^备注3 ( 3) 平级多级混合分润 􀁺 收款方Email1^金额1^备注1|付款方Email1^收款方Email2^金额2^备注2|收款方Email3^金额3^备注3 􀁺 收款 方UID1^金额1^备注1|付款方UID1^收款方UID2^金额2^备注2|收款方UID3^金额3^备注3 注意: 􀁺 参数r oyalty_parameters(分润账号集)如果有多条数据,用“|”隔开,最多不能超过10条; 􀁺 某条 分润数据没有付款方,则默认卖家是付款方; 􀁺 各分润 账号必须使用正确的支付宝账号,能正常收款和付款; 􀁺 对于 平级分润,付款方Email必须与卖家Email一致; 􀁺 同一 笔交易的分润处理,必须遵循原则:分润者要先收到钱才能再付给其他被分润者,收到的钱一定要大于等于付出的钱,即先入后出,入要大于等于出; 􀁺 在各条分润的“备注”中,不能出现“^”和“|”影响royalty_parameters格式的特殊字符;“备注”字段长度不能超过80个字节,即40个汉字;分润信息中,“备注”项可以不填,但“^”不可以省略,如:收款方支付宝账号1^金额1^。 2 . 参数样例 􀁺 [email protected]^1.00^分你的|[email protected]^2.00^你也有 􀁺 uid2088123456789012^1.00^分你的|uid2088123456789013^2.00^你也有

样例

https://mapi.alipay.com/gateway.do?body=%C3%C0%B9%FA%D7%A8%D2%B5%BB%A4%CD%F3%CA%F3%B1%EA%B5%E6%2C%CA%E6%BB%BA%CA%BD%C4%FD%BD%BA%C8%ED%B5%E6%C4%A3%C4%E2%CA%D6%CD%F3%B5%C4%D7%D4%C8%BB%C7%FA%CF%DF%BA%CD%D4%CB%B6%AF%A3%AC%B4%B4%D4%EC%BA%CD%BB%BA%B5%C4GelFlex%CA%E6%CA%CA%B5%D8%B4%F8%21&extend_param=%70%6E%72%5E%4D%46%47%58%44%57%7C%73%74%61%72%74%5F%74%69%63%6B%65%74%5F%6E%6F%5E%31%32%33%7C%65%6E%64%5F%74%69%63%6B%65%74%5F%6E%6F%5E%32%33%34%7C%62%32%62%5F%6C%6F%67%69%6E%5F%6E%61%6D%65%5E%61%62%63&subject=%B1%B4%B6%FB%BD%F0%BB%A4%CD%F3%CA%BD&sign_type=MD5&notify_url=http%3A%2F%2Fapi.test.alipay.net&out_trade_no=6741334835157966&return_url=http%3A%2F%2Fapi.test.alipay.net%2Fatinterface%2Freceive_return.htm&sign=dc3d42f405d7e738ab35344449e2d9f7&buyer_id=2088002007018955&total_fee=100&error_notify_url=http%3A%2F%2Fapi.test.alipay.net%2Fatinterface%2Freceive_error_notify.htm&service=create_direct_pay_by_user&partner=2088101568338364&seller_id=2088002007018966&payment_type=1&qr_pay_mode=1 􀀉 说明: 本样例仅供参考,支付宝网关为https://mapi.alipay.com/gateway.do。

item_orders_info参数说明

item_orders_info参数样例

out_iids=id1&-&id2&+&nums=1&-&2&+&prices=2.50&-&10.01&+&skus=颜色:黑色;尺
码:40θ&-&颜色:白色;尺码:40&+&titles=商品标题 1&-&商品标题
2&+&detail_urls=http://taobao.item.aa.html&-&http://taobao.item.bb.html&+
&pic_urls=http://www.taowaidian.com/img/bg-taxis-cur.png&-&http://www.tao
waidian.com/img/list_menu_sch_btn.gif&+&logistics_type=post&+&post_fee=10
.00&+&promotion_desc=1.全场满 500 送 50 2.满 300 减 50&+&receiver_name=张三
&+&receiver_address_prov=浙江省&+&receiver_address_city=杭州市
&+&receiver_address_area=西湖区&+&receiver_address=华星路 99 号创业大厦
&+&receiver_mobile=13812345678&+&receiver_phone=0571-88155188

item_orders_info出错通知

item_orders_info出错通知含义

item_orders_info出错通知参数列表

item_orders_info出错通知样例

http://api.test.alipay.net?partner=2088101011913539&buyer_email=tstable01@
alipay.com&buyer_id=2088002007018955&[email protected]
om&seller_id=2088002007018966&out_trade_no=6402757654153618&error_c
ode=ERROR_GOODS_OUT_IIDS_IS_NULL|ERROR_GOODS_SKUS_IS_NUL
L

royalty_parameters参数说明

样例