alipay.open.agent.signstatus.query(查询商户某个产品的签约状态) 在线调试(沙箱环境)

主要用在isv代理商户签约场景,用来查询商户签约某个产品的签约状态,可以配合"第三方接入核心API"功能包里的接口使用

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.agent.signstatus.query
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 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
pid String 必选 16 isv要查询签约状态的商户账号,是支付宝账号pid(2088开头) 2088123451234543
product_codes String[] 必选 256 isv要查询商户签约状态的产品码,产品码是支付宝内部对产品的唯一标识 FACE_TO_FACE_PAYMENT

响应参数

参数 类型 是否必填 最大长度 描述 示例值
sign_status_list ProductSignStatusInfo 必填 商户产品签约状态结果对象数组,返回本次查询的产品的签约状态
product_name String 必填 32 产品名称 当面付收单
product_code String 必填 32 产品编码 FACE_TO_FACE_PAYMENT
status String 必填 32 none:未签约,表示还没有签约该产品
valid:已生效,表示合约已经生效,不需要再签约了
restrictValid:受限生效,表示合约已经生效,但是资料不全,功能受限
audit:审核中,已经有合约在审核中,请等待审核完成
waitConfirm:待商户确认协议,合约已经审核通过,需要商户确认后合约才生效
auditReject:审核未通过
invalid:合约失效,曾经签过合约,但已经失效了,可以重新发起签约
restrictInvalid:受限失效,受限合约失效了
none|valid|restrictValid|audit|waitConfirm|auditReject|invalid|restrictInvalid

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenAgentSignstatusQueryRequest request = new AlipayOpenAgentSignstatusQueryRequest();
request.setBizContent("{" +
"\"pid\":\"2088123451234543\"," +
"      \"product_codes\":[" +
"        \"FACE_TO_FACE_PAYMENT\"" +
"      ]" +
"  }");
AlipayOpenAgentSignstatusQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_agent_signstatus_query_response": {
        "code": "10000",
        "msg": "Success",
        "sign_status_list": [
            {
                "product_name": "当面付收单",
                "product_code": "FACE_TO_FACE_PAYMENT",
                "status": "none|valid|restrictValid|audit|waitConfirm|auditReject|invalid|restrictInvalid"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 检查必填参数是否为空,或者长度是否超限
QUERY_SIGN_STATUS_AUTH_NOT_MATCH 应用授权信息和要查询的商户信息不匹配 请检查应用授权token和要查询签约状态的商户是否匹配
QUERY_SIGN_STATUS_NOT_AUTH 接口自调用时不允许查询其它商户的签约状态 接口自调用时只能查询自己的签约状态,要查询其他商户的签约状态,请先让商户进行应用授权,再使用代理方式调用
INVALID_PARAMETER 参数有误 请检查参数是否有误
onlineServer