alipay.open.agent.offlinepayment.sign(代签约当面付快捷版产品) 在线调试(沙箱环境)

三方应用代理签约线下收钱产品,需要配合开启事务接口使用

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.agent.offlinepayment.sign
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述

请求参数

参数 类型 是否必填 最大长度 描述 示例值
batch_no String 必选 25 代商户操作事务编号,通过alipay.open.agent.create接口进行创建。 2017110616474516400082883
mcc_code String 必选 16 所属MCCCode,可参考
商家经营类目 中的“经营类目编码”
A_A03_4582
special_license_pic Byte_array 特殊可选 5.24288e+06 企业特殊资质图片,可参考
商家经营类目 中的“需要的特殊资质证书”,最小5KB,图片格式必须为:png、bmp、gif、jpg、jpeg
-
rate String 必选 3 服务费率(%),0.38~3之间,精确到0.01 0.38
business_license_no String 可选 32 营业执照号码。若填写,请与以下营业执照图片、期限、一起提供。 1532501100006302
business_license_pic Byte_array 可选 5.24288e+06 营业执照图片。被代创建商户运营主体为个人账户必填,企业账户无需填写,最小5KB,图片格式必须为:png、bmp、gif、jpg、jpeg -
long_term Boolean 可选 1 营业期限是否长期有效 true
date_limitation String 可选 10 营业期限 2017-11-11
shop_sign_board_pic Byte_array 必选 5.24288e+06 店铺门头照图片,需要包括招牌信息。最小5KB,图片格式必须为:png、bmp、gif、jpg、jpeg -

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenAgentOfflinepaymentSignRequest request = new AlipayOpenAgentOfflinepaymentSignRequest();
request.setBatchNo("2017110616474516400082883");
request.setMccCode("A_A03_4582");
FileItem SpecialLicensePic = new FileItem("C:/Downloads/ooopic_963991_7eea1f5426105f9e6069/16365_1271139700.jpg");
request.setSpecialLicensePic(SpecialLicensePic);
request.setRate("0.38");
request.setBusinessLicenseNo("1532501100006302");
FileItem BusinessLicensePic = new FileItem("C:/Downloads/ooopic_963991_7eea1f5426105f9e6069/16365_1271139700.jpg");
request.setBusinessLicensePic(BusinessLicensePic);
request.setLongTerm(true);
request.setDateLimitation("2017-11-11");
FileItem ShopSignBoardPic = new FileItem("C:/Downloads/ooopic_963991_7eea1f5426105f9e6069/16365_1271139700.jpg");
request.setShopSignBoardPic(ShopSignBoardPic);
AlipayOpenAgentOfflinepaymentSignResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_agent_offlinepayment_sign_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_open_agent_offlinepayment_sign_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 检查必填参数是否为空,或者长度是否超限
INVALID_BATCH_NO 事务编号 batch_no 不能为空 事务编号参数 batch_no 不能为空
BATCH_IS_NOT_EXIST 代商户操作事务编号不存在 请检查事务编号是否有效
BATCH_STATUS_IS_FINAL 事务已经达到终态 请确认事务状态是否是 init 状态,submit|cancel|timeout 状态的都是终态,不允许继续进行接口调用。
SYSTEM_ERROR 系统繁忙 系统内部错误,请稍后重试
ISV_APP_ORDER_PACKAGE_EMPTY 第三方应用没有任何需要签约开通的功能包 请挂载收钱码功能包
ISV_APP_NO_ORDER_PACKAGE 第三方应用没有挂载该功能包 请挂载收钱码功能包
MERCHANT_SIGN_PRODUCT_IN_AUDIT 签约审核中 该商户签约审核中,暂时不能操作,请等签约审核结束后再试!
MERCHANT_SIGN_PRODUCT_IN_FORBIDD 无法进行签约,或存在产品签约冲突 该商户无法签约当前产品,存在产品签约冲突,不允许执行签约
NO_APP_PERMISSION APPID 不匹配 APPID 不匹配,请检查当前调用的 appId 和创建事务的 appId 是否匹配
FILE_SIZE_OUT_LIMIT 文件大小超出范围 请检查文件类型的参数大小
FILE_SIZE_MIN_LIMIT 文件大小低于范围 请检查文件类型的参数大小
FILE_FORMAT_IS_INVALID 文件格式错误 请检查文件类型的参数格式
PRE_AUTH_INVALID_AUTH_TICKET 无效的订单授权凭证,状态失效或已过期 订单授权凭证无法使用,请商户重新订购生成新的订单授权凭证使用
PRE_AUTH_INVALID_AUTH_TOKEN 订单授权凭证换取的令牌已失效 商户取消了授权或者令牌被刷新,订单授权凭证无法使用
PRE_AUTH_INVOKE_API_NOT_PERMITTE 该订单授权凭证无权限调用该接口 无接口调用权限
PRE_AUTH_INVALID_PACKAGE 订单授权凭证中缺少必要的功能包 请在三方应用中添加"当面付"功能包,重新发布服务并让商户重新订购,取新的订单授权凭证使用
PRE_AUTH_INVALID_AUTH_APP_ID 订单授权凭证对应被授权应用与接口调用应用不一致 请将调用接口的应用id更换成订单授权凭证对应的应用id
MERCHANT_NEED_FACE_CERTIFY 需要商户完成身份证或人脸认证后,才能代商户签约 请联系代签约的商户先完成身份证或人脸认证后后,再代商户签约
MERCHANT_STATE_NOT_SATISFY 商户被清退或禁止续签,不允许签约 请检查商户状态,再重新签约
UN_SUPPORT_ACCOUNT_CERTIFY_LEVEL 账户未达到认证要求 请先联系商家完成账号认证,认证通过后重新签约
UN_SUPPORT_ACCOUNT_TYPE 不支持的签约账号类型 请检查代签约的商家账号类型
ANT_PRODUCT_CONFLICT 您已签约此产品,或者同类产品 确保批量签约的产品没有冲突
USER_CARD_BALANCE_PAY_CLOSED 账户余额支付功能已关闭,不能签约该产品 商家账户余额功能已关闭,请联系商家开启后重新签约
CHECK_AGDS_SELLER_ACCESS_FAILED 蚂蚁花呗专享认证不通过,不满足花呗准入规则 请检查蚂蚁花呗专享是否认证通过
ANT_PRODUCT_DEPENDENCY_REQUIRED 产品之间存在依赖 你还未签约支付宝支付产品(如电脑网站支付、手机网站支付、APP支付、当面付等),请签约后再开通本产品
ISV_NO_PERMISSION isv不在业务开放范围 isv不在业务开放范围
AGENT_SIGN_IN_AUDIT_BY_SAME_ISV 审核中,请等待 相同isv代理签约审核中,请等待
AGENT_SIGN_IN_AUDIT_BY_DIFF_ISV 商家正在被其它ISV代理签约中,请等待审核完成再进行 商家正在被其它ISV代理签约中,请等待审核完成再进行
AGENT_SIGN_CONFIRM_BY_SAME_ISV 待商户确认状态,请联系商户尽快确认 待商户确认状态,请联系商户尽快确认
AGENT_SIGN_CONFIRM_BY_DIFF_ISV 待商户确认状态,请等待商户确认 待商户确认状态,请等待商户确认
AGENT_SIGN_VALID_BY_SAME_ISV 该商户已被代理签约 该商户已被代理签约
SHOP_SIGN_BOARD_PIC_RISK 店铺门头照不合法 店铺门头照不合法
BUSINESS_LICENSE_PIC_RISK 营业执照不合法,签约身份信息或填写信息必须与图片一致 营业执照不合法,个人账号必须与法人姓名一致。
AGENT_SIGN_PRODUCT_IN_FORBIDDEN 该商户无法签约当前产品,存在产品签约冲突 该商户无法签约当前产品,存在产品签约冲突,不允许执行签约
onlineServer