alipay.pcredit.huabei.auth.settle.apply(花芝轻会员结算申请) 在线调试(沙箱环境)

用户已经开通花芝轻会员协议后,商户通过此接口解冻转支付用户冻结金额。传入金额必须小于等于冻结金额

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
agreement_no String 必选 50 支付宝系统中用以唯一标识用户签约记录的编号。 20170502000610755993
seller_id String 可选 64 商户的支付宝用户id。如果该值为空,则默认为商户签约账号对应的支付宝用户ID。 2088102146225135
pay_amount Price 必选 11 需要支付的金额,单位为:元(人民币),精确到小数点后两位 3.00
out_request_no String 必选 64 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 8077735255938032
alipay_user_id String 必选 28 买家在支付宝的用户id 2088101117955611
need_terminated String 可选 8 该参数控制结算完成之后的操作,true或者不填代表解约,false代表不解约 true
extend_params ExtraParams 可选 业务扩展参数
period String 可选 64 轻会员场景下协议结算周期,由协议生效日期到失效日期拼接(yyyyMMddHHmmss-yyyyMMddHHmmss),精确到秒。 20181223235059-20181230235010
period_summary_info String 可选 256 轻会员费用结算原始信息。详细字段说明:total_real_pay_amount轻会员周期内累计支付宝支付金额, total_pay_count轻会员周期内累计支付宝支付次数,total_discount_amount轻会员周期内累计享受的轻会员优惠。(上面金额字段单位为元,精确小数点后两位) {"total_real_pay_amount":"100.00","total_pay_count":"4","total_discount_amount":"2.31"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
out_request_no String 必填 64 商户本次操作的请求流水号,用于标示请求流水的唯一性,不能包含除中文、英文、数字以外的字符,需要保证在商户端不重复。 8077735255938032
fail_reason String 选填 256 根据商户传入的轻会员协议结算周期内累计消费数据与支付宝端轻会员协议结算周期内消费数据比对之后,若数据不一致,则会返回对应的异常数据比对结果。 累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayPcreditHuabeiAuthSettleApplyRequest request = new AlipayPcreditHuabeiAuthSettleApplyRequest();
request.setBizContent("{" +
"\"agreement_no\":\"20170502000610755993\"," +
"\"seller_id\":\"2088102146225135\"," +
"\"pay_amount\":3.00," +
"\"out_request_no\":\"8077735255938032\"," +
"\"alipay_user_id\":\"2088101117955611\"," +
"\"need_terminated\":\"true\"," +
"\"extend_params\":{" +
"\"period\":\"20181223235059-20181230235010\"," +
"\"period_summary_info\":\"{\\\"total_real_pay_amount\\\":\\\"100.00\\\",\\\"total_pay_count\\\":\\\"4\\\",\\\"total_discount_amount\\\":\\\"2.31\\\"}\"" +
"    }" +
"  }");
AlipayPcreditHuabeiAuthSettleApplyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_pcredit_huabei_auth_settle_apply_response": {
        "code": "10000",
        "msg": "Success",
        "out_request_no": "8077735255938032",
        "fail_reason": "累计支付宝支付金额不一致,支付宝:100.00元,商户:150.00元"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,需排查具体原因
INVALID_PARAMETER 参数有误参数有误 参数错误,请确认传参是否正确
AGREEMENT_NOT_EXIST 用户协议不存在 确认商户传入的协议号正确,并且对应的协议没有解约。
AGREEMENT_EXPIRED 用户协议失效 失效的协议无法再发起支付。
PAY_AMOUNT_CHECK_ERROR 商家支付金额大于冻结金额 检查支付金额,确保传入金额小于或等于用户冻结金额。
AUTH_SCENE_NOT_SUPPORTED_ERROR 无效的签约场景 商户确认签约场景是否正确。
ORDER_IDEMPOTENT_ERROR 订单请求幂等失败 检查传入的参数。
ORDER_ALREADY_DEAL 订单超时,系统已自动处理完成 订单超时,系统已自动处理完成。无法再发起支付。
ORDER_NOT_EXIST 花呗解冻转支付操作单不存在 请检查传入的参数是否正确。
PAY_AMOUNT_IDEMPOTENT_ERROR 支付金额与上次支付金额不一致 请检查传入金额是否与上次传入金额一致。
BEYOND_PAY_RESTRICTION 商户收款额度超限 联系支付宝小二提高限额(联系电话:0571-88158090)
ACCESS_FORBIDDEN 无权限使用接口 未签约条码支付或者合同已到期
BUYER_ENABLE_STATUS_FORBID 买家状态非法 用户联系支付宝小二(联系支付宝文档右边的客服头像或到支持中心咨询),确认买家状态为什么非法
TOTAL_FEE_EXCEED 订单总金额超过限额 修改订单金额再发起请求
INVALID_RECEIVE_ACCOUNT 无效的收款账户 请检查收款账户是否签约。
BUYER_PAYMENT_AMOUNT_DAY_LIMIT 买家付款日限额超限 更换买家进行支付
CONTEXT_INCONSISTENT 交易信息被篡改 多次请求信息不一致,请保证请求数据一致。
BUYER_PAYMENT_AMOUNT_MONTH_LIMIT 买家付款月额度超限 让买家更换账号后,重新付款或者更换其它付款方式
PAYMENT_REQUEST_HAS_RISK 支付有风险 支付有风险,请联系客服。
AGREEMENT_INVALID 用户协议失效 代扣业务传入的协议号对应的用户协议已经失效,需要用户重新签约
AGREEMENT_ERROR 协议信息异常 协议信息异常,请稍后再试。
BUSINESS_ERROR 业务失败 业务失败,请稍后再试。
PRODUCT_AMOUNT_LIMIT_ERROR 产品额度超限 产品额度超限,调整额度请联系客服。
CALL_LIMITED 调用被限流 方法调用被限流,联系支付宝小二确认具体原因
CONCURRENT_OPERATION_ERROR 协议正在结算时,并发操作发生错误 协议正在结算,请稍后再试
INVALID_SETTLEMENT_INFO 无效的结算累计数据 请检查传入轻会员费用结算原始信息。
onlineServer