感谢您的反馈!
对特定的外部机构提供通知用户的能力,主要是card形式,机构准入、发送内容、形式等均在支付宝内部控制,机构根据给定的类型调用该接口进行发送。
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.ebpp.common.notify.send |
| format | String | 否 | 40 | 仅支持JSON | JSON |
| charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
| sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
| sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
| 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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| biz_type | String | 必须 | 10 | 业务类型的缩写:
JF-缴费 |
JF |
| sub_biz_type | String | 必须 | 10 | 子业务类型英文名称:
ELECTRIC-电力 GAS-燃气 WATER-水 |
WATER |
| charge_inst | String | 必须 | 50 | 出账机构的缩写 | CQKAIYUANGAS |
| user_id | String | 可选 | 20 | 支付宝用户id,可空,用于特定场景下向指定用户发送通知 | 2088002332279563 |
| bill_key | String | 必须 | 20 | 水电燃等机构为用户分配的户号 | 12345678 |
| notify_type | String | 必须 | 30 | 机构为用户发送通知的类型,需要与支付宝协商确定 | BILLKEY_OCR_WINDOW_OPEN |
| extend_data | String | 可选 | 200 | 特定通知类型可能需要提供扩展信息,用JSON字符串描述 | {"effect_date":"201710010000", "expiry_date":"201710020000"} |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | - | 网关返回码,详见文档 | 40004 |
| msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
| sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| status | String | 必填 | 20 | 通知的执行结果 | SUCCESS |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEbppCommonNotifySendRequest request = new AlipayEbppCommonNotifySendRequest();
request.setBizContent("{" +
"\"biz_type\":\"JF\"," +
"\"sub_biz_type\":\"WATER\"," +
"\"charge_inst\":\"CQKAIYUANGAS\"," +
"\"user_id\":\"2088002332279563\"," +
"\"bill_key\":\"12345678\"," +
"\"notify_type\":\"BILLKEY_OCR_WINDOW_OPEN\"," +
"\"extend_data\":\"{\\\"effect_date\\\":\\\"201710010000\\\",\\\"expiry_date\\\":\\\"201710020000\\\"}\"" +
"}");
AlipayEbppCommonNotifySendResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
{
"alipay_ebpp_common_notify_send_response":{
"msg":"Success",
"code":"10000",
"status":"SUCCESS"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_ebpp_common_notify_send_response":{
"msg":"Service Currently Unavailable",
"code":"20000",
"sub_msg":"系统繁忙",
"sub_code":"isp.unknow-error"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| SYSTEM_ERROR | 系统繁忙 | 调用系统之间通信中断或数据库异常导致 |
| INVALID_PARAMETER | 参数有误 | 请求参数不合法,要求调用方重新审核参数信息 |
| CHARGEINST_NOT_AUTHORIZED | 机构未授权此类通知类型 | 需要被调用方对notify_type进行授权 |
| NOTIFY_TYPE_NOT_SUPPORTED | 不支持的通知类型 | 要求调用方重新检查notify_type参数,必要时与被调用方进行确认 |
| NO_MATCHED_USER | 匹配不到用户 | 无法根据传入的条件匹配到需通知的用户,需要调用方知晓该结果,无需再次发送 |
| NOTIFY_NUM_EXCEED | 通知扩散量过大 | 调用方的一次请求对应了大量的用户通知,被调用方拦截该行为。建议调用方不要再次发起相同的请求 |