接口说明
该接口是 签名数据准备接口,用于生成可信签名字符串(orderstr)。可信签名串中包含业务参数及商户身份信息,可防止数据被篡改,一般用于打开支付宝客户端。请在服务端执行支付宝sdk中sdkexecute方法,读取响应中的body()结果。具体使用方法请参考 接入指南
app支付
外部商户app唤起快捷sdk创建订单并支付
公共请求参数
业务请求参数
out_trade_no必选string(64)
【描述】商户网站唯一订单号。
由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。
由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复。
【示例值】70501111111s001111119
total_amount必选string(9)
【描述】订单总金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000],金额不能为0
【示例值】9.00
subject必选string(256)
【描述】订单标题。
注意:不可使用特殊字符,如 /,=,& 等。
注意:不可使用特殊字符,如 /,=,& 等。
【示例值】大乐透
product_code可选string(64)
【描述】销售产品码,商家和支付宝签约的产品码
【示例值】quick_msecurity_pay
goods_detail可选goodsdetail[]
【描述】订单包含的商品列表信息,json格式,其它说明详见商品明细说明
goods_id必选string(64)
【描述】商品的编号
【示例值】apple-01
goods_name必选string(256)
【描述】商品名称
【示例值】ipad
quantity必选number(32)
【描述】商品数量
【示例值】1
price必选price(9)
【描述】商品单价,单位为元
【示例值】2000
alipay_goods_id可选string(32)
【描述】支付宝定义的统一商品编号
【示例值】20010001
goods_category可选string(24)
【描述】商品类目
【示例值】34543238
categories_tree可选string(128)
【描述】商品类目树,从商品类目根节点到叶子节点的类目id组成,类目id值使用|分割
【示例值】124868003|126232002|126252004
show_url可选string(400)
【描述】商品的展示地址
【示例值】http://www.alipay.com/xxx.jpg
time_expire可选string(32)
【描述】绝对超时时间,格式为yyyy-mm-dd hh:mm:ss
【示例值】2016-12-31 10:05:00
extend_params可选extendparams
【描述】业务扩展参数
sys_service_provider_id可选string(64)
【描述】系统商编号
该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的pid
该参数作为系统商返佣数据提取的依据,请填写系统商签约协议的pid
【示例值】2088511833207846
hb_fq_num可选string(5)
【描述】使用花呗分期要进行的分期数
【示例值】3
hb_fq_seller_percent可选string(3)
【描述】使用花呗分期需要卖家承担的手续费比例的百分值,传入100代表100%
【示例值】100
industry_reflux_info可选string(512)
【描述】行业数据回流信息, 详见:地铁支付接口参数补充说明
【示例值】{\"scene_code\":\"metro_tradeorder\",\"channel\":\"xxxx\",\"scene_data\":{\"asset_name\":\"alipay\"}}
specified_seller_name可选string(32)
【描述】特殊场景下,允许商户指定交易展示的卖家名称
【示例值】xxx的跨境小铺
card_type可选string(64)
【描述】卡类型
【枚举值】
s0jp0000: s0jp0000
【示例值】s0jp0000
royalty_freeze可选string(16)
【描述】是否进行资金冻结,用于后续分账,true表示资金冻结,false或不传表示资金不冻结
【示例值】true
passback_params可选string(512)
【描述】公用回传参数,如果请求时传递了该参数,则返回给商户时会回传该参数。支付宝只会在同步返回(包括跳转回商户网站)和异步通知时将该参数原样返回。本参数必须进行urlencode之后才可以发送给支付宝。
【示例值】merchantbiztype=3c&merchantbizno=2016010101111
merchant_order_no可选string(32)
【描述】商户原始订单号,最大长度限制32位
【示例值】20161008001
ext_user_info可选extuserinfo
【描述】外部指定买家
cert_no可选string(64)
【描述】买家证件号。
注:need_check_info=t时该参数才有效,支付宝会比较买家在支付宝留存的证件号码与该参数传入的值是否匹配。
注:need_check_info=t时该参数才有效,支付宝会比较买家在支付宝留存的证件号码与该参数传入的值是否匹配。
【示例值】362334768769238881
min_age可选string(3)
【描述】允许的最小买家年龄。
买家年龄必须大于等于所传数值
注:
1. need_check_info=t时该参数才有效
2. min_age为整数,必须大于等于0
买家年龄必须大于等于所传数值
注:
1. need_check_info=t时该参数才有效
2. min_age为整数,必须大于等于0
【示例值】18
name可选string(16)
【描述】指定买家姓名。
注: need_check_info=t时该参数才有效
注: need_check_info=t时该参数才有效
【示例值】李明
mobile可选string(20)
【描述】指定买家手机号。
注:该参数暂不校验
注:该参数暂不校验
【示例值】16587658765
cert_type可选string(128)
【描述】指定买家证件类型。
枚举值:
identity_card:身份证;
passport:护照;
officer_card:军官证;
soldier_card:士兵证;
hokou:户口本; permanent_residence_foreigner:外国人永久居留身份证。 如有其它类型需要支持,请与支付宝工作人员联系。
注: need_check_info=t时该参数才有效,支付宝会比较买家在支付宝留存的证件类型与该参数传入的值是否匹配。
枚举值:
identity_card:身份证;
passport:护照;
officer_card:军官证;
soldier_card:士兵证;
hokou:户口本; permanent_residence_foreigner:外国人永久居留身份证。 如有其它类型需要支持,请与支付宝工作人员联系。
注: need_check_info=t时该参数才有效,支付宝会比较买家在支付宝留存的证件类型与该参数传入的值是否匹配。
【枚举值】
identity_card: identity_card
passport: passport
officer_card: officer_card
【示例值】identity_card
need_check_info可选string(1)
【描述】是否强制校验买家信息;
需要强制校验传:t;
不需要强制校验传:f或者不传;
当传t时,支付宝会校验支付买家的信息与接口上传递的cert_type、cert_no、name或age是否匹配,只有接口传递了信息才会进行对应项的校验;只要有任何一项信息校验不匹配交易都会失败。如果传递了need_check_info,但是没有传任何校验项,则不进行任何校验。
默认为不校验。
需要强制校验传:t;
不需要强制校验传:f或者不传;
当传t时,支付宝会校验支付买家的信息与接口上传递的cert_type、cert_no、name或age是否匹配,只有接口传递了信息才会进行对应项的校验;只要有任何一项信息校验不匹配交易都会失败。如果传递了need_check_info,但是没有传任何校验项,则不进行任何校验。
默认为不校验。
【示例值】f
identity_hash可选string(128)
【描述】买家加密身份信息。当指定了此参数且指定need_check_info=t时,支付宝会对买家身份进行校验,校验逻辑为买家姓名、买家证件号拼接后的字符串,以sha256算法utf-8编码计算hash,若与传入的值不匹配则会拦截本次支付。注意:如果同时指定了用户明文身份信息(name,cert_type,cert_no中任意一个),则忽略identity_hash以明文参数校验。
【示例值】27bfcd1dee4f22c8fe8a2374af9b660419d1361b1c207e9b41a754a113f38fcc
query_options可选string[](256)
【描述】返回参数选项。 商户通过传递该参数来定制同步需要额外返回的信息字段,数组格式。包括但不限于:["hyb_amount","enterprise_pay_info"]
【枚举值】
惠营宝回票金额: hyb_amount
因公付支付信息: enterprise_pay_info
医保信息: medical_insurance_info
【示例值】["hyb_amount","enterprise_pay_info"]
常见请求示例
默认示例
package com.java.sdk.demo;
import com.alipay.api.alipayapiexception;
import com.alipay.api.alipayclient;
import com.alipay.api.defaultalipayclient;
import com.alipay.api.alipayconfig;
import com.alipay.api.request.alipaytradeapppayrequest;
import com.alipay.api.domain.extuserinfo;
import com.alipay.api.domain.alipaytradeapppaymodel;
import com.alipay.api.response.alipaytradeapppayresponse;
import com.alipay.api.domain.extendparams;
import com.alipay.api.domain.goodsdetail;
import com.alipay.api.fileitem;
import java.util.base64;
import java.util.arraylist;
import java.util.list;
public class alipaytradeapppay {
public static void main(string[] args) throws alipayapiexception {
// 初始化sdk
alipayclient alipayclient = new defaultalipayclient(getalipayconfig());
// 构造请求参数以调用接口
alipaytradeapppayrequest request = new alipaytradeapppayrequest();
alipaytradeapppaymodel model = new alipaytradeapppaymodel();
// 设置商户订单号
model.setouttradeno("70501111111s001111119");
// 设置订单总金额
model.settotalamount("9.00");
// 设置订单标题
model.setsubject("大乐透");
// 设置产品码
model.setproductcode("quick_msecurity_pay");
// 设置订单包含的商品列表信息
list<goodsdetail> goodsdetail = new arraylist<goodsdetail>();
goodsdetail goodsdetail0 = new goodsdetail();
goodsdetail0.setgoodsname("ipad");
goodsdetail0.setalipaygoodsid("20010001");
goodsdetail0.setquantity(1l);
goodsdetail0.setprice("2000");
goodsdetail0.setgoodsid("apple-01");
goodsdetail0.setgoodscategory("34543238");
goodsdetail0.setcategoriestree("124868003|126232002|126252004");
goodsdetail0.setshowurl("http://www.alipay.com/xxx.jpg");
goodsdetail.add(goodsdetail0);
model.setgoodsdetail(goodsdetail);
// 设置订单绝对超时时间
model.settimeexpire("2016-12-31 10:05:00");
// 设置业务扩展参数
extendparams extendparams = new extendparams();
extendparams.setsysserviceproviderid("2088511833207846");
extendparams.sethbfqsellerpercent("100");
extendparams.sethbfqnum("3");
extendparams.setindustryrefluxinfo("{\"scene_code\":\"metro_tradeorder\",\"channel\":\"xxxx\",\"scene_data\":{\"asset_name\":\"alipay\"}}");
extendparams.setspecifiedsellername("xxx的跨境小铺");
extendparams.setroyaltyfreeze("true");
extendparams.setcardtype("s0jp0000");
model.setextendparams(extendparams);
// 设置公用回传参数
model.setpassbackparams("merchantbiztype=3c&merchantbizno=2016010101111");
// 设置商户的原始订单号
model.setmerchantorderno("20161008001");
// 设置外部指定买家
extuserinfo extuserinfo = new extuserinfo();
extuserinfo.setcerttype("identity_card");
extuserinfo.setcertno("362334768769238881");
extuserinfo.setname("李明");
extuserinfo.setmobile("16587658765");
extuserinfo.setminage("18");
extuserinfo.setneedcheckinfo("f");
extuserinfo.setidentityhash("27bfcd1dee4f22c8fe8a2374af9b660419d1361b1c207e9b41a754a113f38fcc");
model.setextuserinfo(extuserinfo);
// 设置通知参数选项
list<string> queryoptions = new arraylist<string>();
queryoptions.add("hyb_amount");
queryoptions.add("enterprise_pay_info");
model.setqueryoptions(queryoptions);
request.setbizmodel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putothertextparam("app_auth_token", "<-- 请填写应用授权令牌 -->");
alipaytradeapppayresponse response = alipayclient.sdkexecute(request);
string orderstr = response.getbody();
system.out.println(orderstr);
if (response.issuccess()) {
system.out.println("调用成功");
} else {
system.out.println("调用失败");
// sdk版本是"4.38.0.all"及以上,可以参考下面的示例获取诊断链接
// string diagnosisurl = diagnosisutils.getdiagnosis;
// system.out.println(diagnosisurl);
}
}
private static alipayconfig getalipayconfig() {
string privatekey = "<-- 请填写您的应用私钥,例如:miievqibadanb ... ... -->";
string alipaypublickey = "<-- 请填写您的支付宝公钥,例如:miibijanbg... -->";
alipayconfig alipayconfig = new alipayconfig();
alipayconfig.setserverurl("https://openapi.alipay.com/gateway.do");
alipayconfig.setappid("<-- 请填写您的appid,例如:2019091767145019 -->");
alipayconfig.setprivatekey(privatekey);
alipayconfig.setformat("json");
alipayconfig.setalipaypublickey(alipaypublickey);
alipayconfig.setcharset("utf-8");
alipayconfig.setsigntype("rsa2");
return alipayconfig;
}
}
说明:本示例仅供参考。
公共响应参数
无公共响应参数
业务响应参数
orderstr|签名字符串必选string(16384)
【描述】获取签名后的业务数据具体使用方法请参考 接入指南
【示例值】请参考响应示例
响应示例
正常示例
app_id=2017060101317939&biz_content={"time_expire%22:%222016-12-31 10:05:00%22,"extend_params%22:%22%22,"query_options%22:%22[\"hyb_amount\%22,\"enterprise_pay_info\%22]%22,"subject%22:%22大�%90�%80�%22,"product_code%22:"quick_msecurity_pay%22,"body%22:"iphone6 16g%22,"passback_params%22:"merchantbiztype%3d3c%26merchantbizno%3d2016010101111%22,"specified_channel%22:"pcredit%22,"goods_detail%22:%22%22,"merchant_order_no%22:%2220161008001%22,"enable_pay_channels%22:"pcredit,moneyfund,debitcardexpress%22,"out_trade_no%22:"70501111111s001111119%22,"ext_user_info%22:%22%22,"total_amount%22:%229.00%22,"timeout_express%22:"90m%22,"disable_pay_channels%22:"pcredit,moneyfund,debitcardexpress%22,"agreement_sign_params%22:%22%22}&charset=utf-8&format=json&method=alipay.trade.app.pay&sign=eritjkeijkjhkkkkkkkhjereeeeeeeeeee&sign_type=rsa2×tamp=2014-07-24 03:07:50&version=1.0
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
acq.access_forbidden | 无权限使用接口 | 联系支付宝小二签约 |
acq.buyer_enable_status_forbid | 买家状态非法 | 用户联系支付宝小二,确认买家状态为什么非法 |
acq.buyer_seller_equal | 买卖家不能相同 | 更换买家重新付款 |
acq.context_inconsistent | 交易信息被篡改 | 确认该笔交易信息是否为当前买家的已存订单,如果是则认为本次请求参数与已存交易不一致,如果不是则更换商家订单号后,重新发起请求 |
acq.exist_forbidden_word | 订单信息中包含违禁词 | 修改订单信息后,重新发起请求 |
acq.invalid_parameter | 参数无效 | 若存在参数无效具体错误信息描述,请参考描述检查请求参数后,重新发起 |
acq.partner_error | 应用app_id填写错误 | 联系支付宝小二,确认app_id的状态 |
acq.risk_merchant_ip_not_exist | 当前交易未传入ip信息,创单失败,请传入ip后再发起支付 | 检查请求参数是否已经传入用户ip信息 |
acq.seller_been_blocked | 商家账号被冻结 | 联系支付宝小二,解冻账号 |
acq.system_error | 接口返回错误 | 请立即调用查询订单api,查询当前订单的状态,并根据订单状态决定下一步的操作 |
acq.total_fee_exceed | 订单总金额不在允许范围内 | 修改订单金额再发起请求 |
acq.trade_buyer_not_match | 交易买家不匹配 | 该笔交易已经在支付宝端创建,但请求买家与已存交易中的买家不一致。请商户确认本次请求是否与已存交易有关,若为同一笔交易,则只能用原始买家付款,若无关更换商家订单号后,重新发起请求 |
acq.trade_has_close | 交易已经关闭 | 确认该笔交易信息是否为当前买家的已存订单,如果是则认为交易已经关闭,如果不是则更换商家订单号后,重新发起请求 |
acq.trade_has_success | 交易已被支付 | 确认该笔交易信息是否为当前买家的,如果是则认为交易付款成功,如果不是则更换商家订单号后,重新发起请求 |
触发通知类型
通知类型 | 描述 | 默认开启 |
---|---|---|
tradestatus.trade_closed | 交易关闭 | 1 |
tradestatus.trade_finished | 交易完结 | 1 |
tradestatus.trade_success | 支付成功 | 1 |
tradestatus.wait_buyer_pay | 交易创建 | 0 |
触发通知示例
https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync¬ify_id=91722adff935e8cfa58b3aabf4dead6ibe¬ify_time=2017-02-16 21:46:15&sign_type=rsa2&sign=wco t3d8kg71dtlkwn7r9pzuoxeabjwp8/fousxcuskxsovyxbpsaidpryscjhcjmaglncjokjqlj28/asl93jotw39fx6i07lxhnbpknezalwmvpdnqui01hzszf9v1i6ggzjbiad5lg8bzttxzoj87ub2i9guj3nr/nuc9vey=&out_channel_type=null&merchant_app_id=2088102146225135&buyer_open_id=074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5&trade_no=null&app_id=null&out_trade_no=null&seller_id=null&trade_status=null&total_amount=null&refund_fee=null&subject=null&body=null&gmt_create=null&gmt_payment=null&gmt_refund=null&gmt_close=null&buyer_id=null&fund_bill_list=[{"amount":"50.00","fundchannel":"alipayaccount"}]&receipt_amount=null&invoice_amount=null&buyer_pay_amount=null&point_amount=null&voucher_detail_list=null&buyer_logon_id=null&seller_email=null&out_biz_no=null&passback_params=null¬ify_action_type=paybyaccountaction/closetradeaction/reverseaction/finishfpaction/confirmdisburseaction/financingreceiptaction¤t_seller_received_amount=88.88&seller_received_total_amount=88.88&total_from_seller_fee=88.88&ff_current_period=1&discount_amount=88.88&charge_amount=8.88&charge_flags=bluesea_1&settlement_id=2018101610032004620239146945&industry_sepc_detail={"registration_order_pay":{"brlx":"1","cblx":"1"}}&industry_sepc_detail_acc={"registration_order_pay":{"brlx":"1","cblx":"1"}}&industry_sepc_detail_gov={"registration_order_pay":{"brlx":"1","cblx":"1"}}&discount_goods_detail="[{\"goodsid\":\"standard1026181538\",\"goodsname\":\"雪碧\",\"discountamount\":\"10.00\"}]"&mdiscount_amount=88.88&hb_fq_pay_info={"user_install_num":"3"}&receipt_currency_type=dc&enterprise_pay_info={"invoice_amount":"28.00","is_use_enterprise_pay":"true"}&hyb_amount=10.24&charge_info_list=[{"charge_fee":"0.01","original_charge_fee":"0.02","switch_fee_rate":"0.03","is_rating_on_trade_receiver":"y","is_rating_on_switch":"y"}]&medical_insurance_info={"medicarecardtype":"1","medicarecardholderhiddenname":"**专"}&credit_pay_mode=creditadvancev2&buyer_charge_amt=1.00&fulfillment_amount=10.24&cashier_type=app