alipay.user.twostage.common.use(通用当面付二阶段接口) 在线调试(沙箱环境)

商家通过小程序/卡券开放权益(优惠券),用户在小程序/卡券授权后,打开付款码时通过该接口获取用户信息。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
dynamic_id String 必选 32 商户扫描用户的付款码值。 286861260475412123
sence_no String 必选 128 外部业务号,用于标识这笔解码请求,对同一个码的重复解码请求,sence_no必须与上一次保持一致,每次请求的sence_no必须不一样,如alipay.user.twostage.common.use接口配合alipay.trade.pay(统一收单交易支付接口)一并使用时,alipay.trade.pay接口的extend_params属性中必须设置DYNAMIC_TOKEN_OUT_BIZ_NO,且值必须与sence_no保持一致。 20170718xxxxxxxx
pay_pid String 必选 32 商家进行二阶段支付的PID信息。 2088702093900999

响应参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 选填 32 支付宝用户userId信息,因为用户已经在客户端给商户的小程序授权了,并且商户要通过userId信息挂接优惠券信息,所以可以无需脱敏返回给商户。 2088123412341234
user_identity_info UserIdentityInfo 选填 从码值解析出来的用户身份信息
h_school_info HSchoolInfo 可选 校园码身份信息
school_std_code String 必填 64 学校外标 4136013432
campus_no String 必填 64 学号 2019021208

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayUserTwostageCommonUseRequest request = new AlipayUserTwostageCommonUseRequest();
request.setBizContent("{" +
"\"dynamic_id\":\"286861260475412123\"," +
"\"sence_no\":\"20170718xxxxxxxx\"," +
"\"pay_pid\":\"2088702093900999\"" +
"  }");
AlipayUserTwostageCommonUseResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_user_twostage_common_use_response": {
        "code": "10000",
        "msg": "Success",
        "user_id": "2088123412341234",
        "user_identity_info": {
            "h_school_info": {
                "school_std_code": "4136013432",
                "campus_no": "2019021208"
            }
        }
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INPUT_ILLEGAL 含有非法参数 检查是否有必传参数未传。
DECODE_FAILED 业务异常解码失败 未知异常,请联系技术同学。
INDEX_NOT_EXIST 无法获取用户信息 请消费者重新刷新付款码/会员码,如刷新码值后仍无法获取到用户信息,请联系技术同学。
SYSTEM_ERROR 系统繁忙 如大量出现此错误,请尽快联系技术同学排查。
ILLEGAL_CODE 非法码值 请消费者更换成支付宝付款码或淘宝会员码。
CODE_EXPIRED 码已过期 请消费者刷新付款码/会员码。
USER_UN_AUTH 用户未对该商户授权 请消费者确认对该商户的小程序授权获取用户信息。
SENCENO_UN_MATCH 重复解码请求,与第一次解码传递的sence_no不匹配 请确认消费者没有被误扫,同时请消费者重新刷新付款码/会员码页面。
onlineServer