通用场景
三方应用代理签约产品,需要配合开启事务接口使用
公共请求参数
业务请求参数
batch_no必选string(25)
【描述】代商户操作事务编号,通过alipay.open.agent.create接口进行创建。
【示例值】2020062409585609100024230
mcc_code必选string(16)
【描述】商家经营类目2.0 中的“经营类目编码”
【示例值】a0001_b0001
product_code必选string(64)
【描述】isv要代商户签约产品码,产品码是支付宝内部对产品的唯一标识
【示例值】face_to_face_payment
mini_app_id|小程序id条件必选string(100)
【描述】请输入被签约商家下任意小程序appid id编号
【必选条件】当交易场景为tiny_app(小程序)时,必传
【示例值】2021003187665167
mini_app_name|小程序名称条件必选string(100)
【描述】小程序名称
【必选条件】当交易场景为tiny_app(小程序)时,可选传
【示例值】xxx小程序
mini_app_screenshot|小程序截图条件必选byte[](5242880)
【描述】请上传商家小程序截图信息,最小5kb ,最大5m(暂不限制图片宽高),图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】当交易场景为tiny_app(小程序)时,可选传
【示例值】-
h_5_status|h5网站状态条件必选string(50)
【描述】h5网站状态
【枚举值】
已上线: online
未上线: offline
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5时,必传。
【示例值】online
h_5_memo|网站扩展信息文本条件必选string(512)
【描述】网站扩展信息文本
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5时,可选传。
【示例值】相关备注信息
h_5_extra_pic|网站备注图片条件必选byte[](5242880)
【描述】网站备注图片
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5时,可选传。
【示例值】-
h_5_sites|h5网站地址条件必选string(100)
【描述】h5网站地址
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5时,必传。
【示例值】www.h5.com
h_5_home_screenshot|h5网站凯发k8官方网娱乐官方首页截图条件必选byte[](5242880)
【描述】h5网站凯发k8官方网娱乐官方首页截图
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5且h_5_status为offline时,必传
【示例值】-
h_5_item_screenshot|h5网站商品截图条件必选byte[](5242880)
【描述】h5网站商品截图
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5且h_5_status为offline时,必传
【示例值】-
h_5_pay_screenshot|h5网站支付页截图条件必选byte[](5242880)
【描述】h5网站支付页截图
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5且h_5_status为offline时,必传
【示例值】-
h_5_sites_loa|h5网站授权函条件必选byte[](5242880)
【描述】h5网站授权函
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为h5时,可选传
【示例值】-
app_name|应用名称条件必选string(32)
【描述】商户的app应用名称(1 app_name、app_demo;2 web_sites;3 alipay_life_name;4 wechat_official_account_name。1、2、3、4至少选择一个填写)
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,必传。
【示例值】应用名称
app_demo条件必选byte[](5242880)
【描述】app demo,格式为.apk;或者应用说明文档, 格式为.doc .docx .pdf格式(1 app_name、app_demo;2 web_sites;3 alipay_life_name;4 wechat_official_account_name。1、2、3、4至少选择一个填写)
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,选传
【示例值】-
app_status|应用状态条件必选string(20)
【描述】应用状态
【枚举值】
已上线: online
未上线: offline
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,必传。
【示例值】online
app_market|投放应用市场条件必选string(100)
【描述】投放应用市场
【枚举值】
苹果: 苹果
应用宝: 应用宝
华为: 华为
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,必传。
【示例值】豌豆荚
app_auth_pic|app授权函图片条件必选byte[](5242880)
【描述】app授权函图片,最小5kb,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,可选传。
【示例值】-
app_test_account|可以登录该应用的测试账户条件必选string(100)
【描述】可以登录该应用的测试账户
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,可选传。
【示例值】testaccount
app_test_account_password|可以登录此应用的账户的密码条件必选string(100)
【描述】可以登录此应用的账户的密码。对app_test_account的登录密码。
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,可选传。
【示例值】testpassword
download_link|应用下载链接条件必选string(500)
【描述】应用下载链接
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时,可选传
【示例值】http://demo.com/demo.apk
app_home_screenshot|应用凯发k8官方网娱乐官方首页截图条件必选byte[](5242880)
【描述】应用凯发k8官方网娱乐官方首页截图,最小5kb,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时且app_status为offline,必传。
【示例值】-
app_pay_screenshot|应用内支付页截图条件必选byte[](5242880)
【描述】应用内支付页截图,最小5kb,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时且app_status为offline,必传。
【示例值】-
app_item_screenshot|商品或服务页截图条件必选byte[](5242880)
【描述】商品或服务页截图,最小5kb,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】当交易场景为mobile(移动设备)且移动设备类型为app时且app_status为offline,必传。
【示例值】-
shop_scene_pic|店铺内景图片条件必选byte[](5242880)
【描述】店铺内景图片,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg。
【必选条件】当交易场景为offline_store(线下场所),必传。
【示例值】-
shop_sign_board_pic|店铺门头照图片条件必选byte[](5242880)
【描述】店铺门头照图片,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg。
【必选条件】当交易场景为offline_store(线下场所),必传。
【示例值】-
shop_province_code|门店所在省份条件必选string(32)
【描述】门店所在省份
【必选条件】当交易场景为offline_store(线下场所),必传。
【示例值】370000
shop_city_code|门店所在城市条件必选string(32)
【描述】门店所在城市
【必选条件】当交易场景为offline_store(线下场所),必传。
【示例值】370900
shop_district_code|门店所在区或县条件必选string(32)
【描述】门店所在区/县
【必选条件】当交易场景为offline_store(线下场所),必传
【示例值】370902
shop_detail_address|门店详细地址条件必选string(128)
【描述】门店详细地址
【必选条件】当交易场景为offline_store(线下场所),必传
【示例值】人民路10号
shop_name|门店名称条件必选string(200)
【描述】门店名称
【必选条件】当交易场景为offline_store(线下场所),必传
【示例值】xxx门店
web_sites|接入网址信息条件必选string[](256)
【描述】接入网址信息(1 app_name、app_demo;2 web_sites;3 alipay_life_name;4 wechat_official_account_name。1、2、3、4至少选择一个填写)
【必选条件】交易场景为pc(pc网站),必传。
【示例值】www.web.com
web_sites_loa|接入网址的授权涵条件必选byte[](5242880)
【描述】接入网址的授权涵,格式为.doc .docx .pdf格式
【必选条件】交易场景为pc(pc网站),可选传
【示例值】-
web_test_account|可以登录此网站的测试账户条件必选string(128)
【描述】可以登录此网站的测试账户。
【必选条件】交易场景为pc(pc网站),可选传。
【示例值】testaccount
web_test_account_password|可以登录此网站的账户的密码条件必选string(128)
【描述】可以登录此网站的账户的密码。对应web_test_account的登录密码
【必选条件】交易场景为pc(pc网站),可选传。
【示例值】testpassword
web_home_screenshot|网站凯发k8官方网娱乐官方首页截图条件必选byte[](5242880)
【描述】网站凯发k8官方网娱乐官方首页截图,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】交易场景为pc(pc网站),且web_status为offline时,必传。
【示例值】-
web_item_screenshot|网站商品页截图条件必选byte[](5242880)
【描述】网站商品页截图,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】交易场景为pc(pc网站),且web_status为offline时,必传。
【示例值】-
web_pay_screenshot|网站支付页截图条件必选byte[](5242880)
【描述】网站支付页截图,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg
【必选条件】交易场景为pc(pc网站),且web_status为offline时,必传。
【示例值】-
web_status|网站状态条件必选string(128)
【描述】网站状态,枚举值为:online,offline
【枚举值】
已上线: online
未上线: offline
【必选条件】交易场景为pc(pc网站),必传。
【示例值】online
trade_scene|交易场景条件必选string(20)
【描述】交易场景,当开通产品为电脑网站支付时,传pc;当开通产品为手机网站支付时,传mobile;当开通产品为jsapi时,传tiny_app;当开通产品为预授权支付时,下面括号中三个至少传一个(tiny_app,mobile,offline_store),可多选,字符串用英文逗号分隔
【枚举值】
小程序: tiny_app
移动设备: mobile
线下场所: offline_store
【必选条件】当开通产品为电脑网站支付、手机网站支付、jsapi、预授权支付时,必传。
【示例值】tiny_app,mobile
mobile_type|移动设备类型条件必选string(10)
【描述】移动设备类型,当开通电脑网站支付产品时不需赋值;当开通手机网站支付时,传h5;当开通jsapi时,传app;当开通预授权支付产品,且交易场景选择“mobile”(移动设备)时,需要从app,h5中至少选择一个,可多选,字符串英文逗号分隔。
【枚举值】
app: app
h5: h5
【必选条件】当开通电脑网站支付产品、手机网站支付、预授权支付时,必传。
【示例值】app,h5
business_license_no可选string(32)
【描述】营业执照号码
【示例值】1532501100006302
business_license_pic可选byte[](5242880)
【描述】营业执照图片。被代创建商户运营主体为个人账户必填,企业账户无需填写。图片最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg。
【示例值】-
business_license_auth_pic可选byte[](5242880)
【描述】营业执照授权函图片,个体工商户如果使用总公司或其他公司的营业执照认证需上传该授权函图片,最小5kb,最大5m,图片格式必须为:png、bmp、gif、jpg、jpeg
【示例值】-
long_term可选boolean(10)
【描述】营业期限是否长期有效
【示例值】true
date_limitation可选string(10)
【描述】营业期限
【示例值】2017-11-11
alipay_life_name|支付宝生活号(原服务窗)名称可选string(128)
【描述】支付宝生活号(原服务窗)名称(1 app_name、app_demo;2 web_sites;3 alipay_life_name。1、2、3少选择一个填写)
【示例值】杭州xx报社
wechat_official_account_name可选string(128)
该参数已废弃
该字段已经不在使用,废弃,不用填写
【描述】1 app_name、app_demo;2 web_sites;3 alipay_life_name;4 wechat_official_account_name。1、2、3、4至少选择一个填写
【示例值】杭州xx报社
special_license_type|特殊资质类型可选string(100)
【描述】合约特殊资质的类型,不传默认99
【枚举值】
其他附件: 99
【示例值】99
rate|费率可选string(100)
【描述】服务费率(%),例如:请输入0.38~0.6 之间(小数点后两位,可取0.38%及0.6%),直播买卖通涉及jsapi支付产品,交易手续费为 0.38%-0.6%,后续费率变化可参考支付宝标准服务费。
当签约且授权标识 sign_and_auth=true 时,该费率信息必填。
【示例值】0.38
life_app_id|生活号id可选string(100)
【描述】请输入被签约商户的支付宝生活号id编号
【示例值】2030020837517348
常见请求示例
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.agent.common.sign&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'batch_no=2020062409585609100024230' \
-f 'mcc_code=a0001_b0001' \
-f 'special_license_pic=@/home/admin/test.jpg' \
-f 'business_license_no=1532501100006302' \
-f 'business_license_pic=@/home/admin/test.jpg' \
-f 'business_license_auth_pic=@/home/admin/test.jpg' \
-f 'long_term=true' \
-f 'date_limitation=2017-11-11' \
-f 'product_code=face_to_face_payment' \
-f 'alipay_life_name=杭州xx报社' \
-f 'special_license_type=99' \
-f 'rate=0.38' \
-f 'life_app_id=2030020837517348' \
-f 'mini_app_id=2021003187665167' \
-f 'mini_app_name=xxx小程序' \
-f 'mini_app_screenshot=@/home/admin/test.jpg' \
-f 'h_5_status=online' \
-f 'h_5_memo=相关备注信息' \
-f 'h_5_extra_pic=@/home/admin/test.jpg' \
-f 'h_5_sites=www.h5.com' \
-f 'h_5_home_screenshot=@/home/admin/test.jpg' \
-f 'h_5_item_screenshot=@/home/admin/test.jpg' \
-f 'h_5_pay_screenshot=@/home/admin/test.jpg' \
-f 'h_5_sites_loa=@/home/admin/test.jpg' \
-f 'app_name=应用名称' \
-f 'app_demo=@/home/admin/test.jpg' \
-f 'app_status=online' \
-f 'app_market=豌豆荚' \
-f 'app_auth_pic=@/home/admin/test.jpg' \
-f 'app_test_account=testaccount' \
-f 'app_test_account_password=testpassword' \
-f 'download_link=http://demo.com/demo.apk' \
-f 'app_home_screenshot=@/home/admin/test.jpg' \
-f 'app_pay_screenshot=@/home/admin/test.jpg' \
-f 'app_item_screenshot=@/home/admin/test.jpg' \
-f 'shop_scene_pic=@/home/admin/test.jpg' \
-f 'shop_sign_board_pic=@/home/admin/test.jpg' \
-f 'shop_province_code=370000' \
-f 'shop_city_code=370900' \
-f 'shop_district_code=370902' \
-f 'shop_detail_address=人民路10号' \
-f 'shop_name=xxx门店' \
-f 'web_sites=["www.web.com"]' \
-f 'web_sites_loa=@/home/admin/test.jpg' \
-f 'web_test_account=testaccount' \
-f 'web_test_account_password=testpassword' \
-f 'web_home_screenshot=@/home/admin/test.jpg' \
-f 'web_item_screenshot=@/home/admin/test.jpg' \
-f 'web_pay_screenshot=@/home/admin/test.jpg' \
-f 'web_status=online' \
-f 'trade_scene=tiny_app,mobile' \
-f 'mobile_type=app,h5'
说明:本示例仅供参考。
公共响应参数
业务响应参数
无业务响应参数
响应示例
正常示例
异常示例
{
"alipay_open_agent_common_sign_response": {
"code": "10000",
"msg": "success"
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
invalid_parameter | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
admit_order_no_pass | 代商户签约预校验不通过 | 商户签约预校验不通过,该商户没有资质或存在签约中订单或该渠道没有面向该商家开放 |
admit_order_no_pass | 业务异常,代商户签约预校验不通过 | 代商户签约预校验不通过,具体原因请参考接口返回信息 |
ant_product_conflict | 您已签约此产品,或者同类产品 | 确保批量签约的产品没有冲突 |
ant_product_dependency_required | 产品之间存在依赖 | 你还未签约支付宝支付产品(如电脑网站支付、手机网站支付、app支付、当面付等),请签约后再开通本产品 |
batch_is_not_exist | 代商户操作事务编号不存在 | 请检查事务编号是否有效 |
batch_status_is_final | 事务已经达到终态 | 请确认事务状态是否是 init 状态,submit|cancel|timeout 状态的都是终态,不允许继续进行接口调用。 |
biz_error | 业务异常业务异常 | 具体失败原因,请参考接口返回的错误信息 |
business_license_pic_risk | 营业执照不合法 | 请检查参数business_license_pic是否是营业执照;营业执照法人姓名是否一致;营业执照法人身份信息是否一致;营业执照是否已过期 |
check_agds_seller_access_failed | 蚂蚁花呗专享认证不通过,不满足花呗准入规则 | 请检查蚂蚁花呗专享是否认证通过 |
check_merchant_access_cert_punished | 商户存在风险,禁止签约 | 商户存在风险,禁止签约,请更换账号签约 |
file_format_is_invalid | 文件格式错误 | 请检查文件类型的参数格式 |
file_size_min_limit | 文件大小低于范围 | 请检查文件类型的参数大小 |
file_size_min_limit | 文件大小低于限定范围 | 请检查文件类型的参数大小 |
file_size_out_limit | 文件大小超出范围 | 请检查文件类型的参数大小 |
invalid_batch_no | 事务编号 batch_no 不能为空 | 事务编号 batch_no 不能为空 |
isv_app_no_order_package | 第三方应用没有挂载该功能包 | 请挂载对应功能包 |
isv_app_order_package_empty | 第三方应用没有任何需要签约开通的功能包 | 请挂载对应功能包 |
isv_identity_not_satisfy | 当前账户已入驻为服务商,不能签约收钱产品,请更换账号签约 | 请更换账号签约 |
merchant_need_face_certify | 需要商户完成身份证或人脸认证后,才能代商户签约 | 请联系代签约的商户先完成身份证或人脸认证后后,再代商户签约 |
merchant_sign_product_in_audit | 签约审核中 | 该商户签约审核中,暂时不能操作,请等签约审核结束后再试! |
merchant_sign_product_in_forbidd | 无法进行签 | 该商户无法签约当前产品,存在产品签约冲突,不允许执行签约 |
merchant_state_not_satisfy | 商户被清退或禁止续签,不允许签约 | 请检查商户状态,再重新签约 |
not_matched_ssu_or_ps | 产品不支持当前类目 | 请检查商户的mcc类目以及填写的经营类目是否准确,请参考商家经营类目 中的“经营类目编码” |
no_app_permission | appid 不匹配 | appid 不匹配,请检查当前调用的 appid 和创建事务的 appid 是否匹配 |
open_api_sign_isv_not_in_whitelist | isv不在白名单中 | 抱歉,该接口暂未开放 |
open_api_sign_product_not_support | 产品码不在白名单中 | 抱歉,暂不支持该产品码 |
product_no_openable_permission_set | 当前签约产品不存在可开通的权限集 | 抱歉,当前产品暂未开放任何可签约的权限集 |
risk_advice_error | 商户风险咨询校验失败 | 具体失败原因及凯发app官方网站的解决方案,请参考接口返回的描述文案 |
shop_sign_board_pic_risk | 门头照不合法 | 请检查参数shop_sign_board_pic是否是门头照 |
unknown_exception | 系统内部错误,需要技术人员排查 | 请联系客服咨询具体原因 |
un_support_account_certify_level | 账户未达到认证要求 | 请先联系商家完成账号认证,认证通过后重新签约 |
un_support_account_type | 不支持的签约账号类型 | 请检查代签约的商家账号类型 |
user_account_is_block | 商户账号被冻结 | 请检查商户账号是否可用 |
user_card_balance_pay_closed | 账户余额支付功能已关闭,不能签约该产品 | 商家账户余额功能已关闭,请联系商家开启后重新签约 |