淘宝开放平台

登录
文档中心 > API类目 > 会员API

alipay.user.charity.recordexist.query (查询是否在支付宝公益捐赠的接口)

外部商户通过此接口查询指定支付宝用户在公益是否有过捐赠记录

公共参数

请求地址：
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数：
参数 类型 是否必填 最大长度 描述 示例值
app_id String 是 32 支付宝分配给开发者的应用ID 2014072300007148
method String 是 128 接口名称 alipay.user.charity.recordexist.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 是 - 请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
partner_id String 必须 20 商户和支付宝交互时，用于代表支付宝分配给商户ID 2088111122223333
user_id String 必须 32 蚂蚁统一会员ID 2088111122223333
biz_type Number 可选 2 公益的业务类型(缺省是所有类型) 10
start_time Date 可选 20 捐赠记录的开始时间（默认是查询当前自然年一年的记录） 2017-01-01 00:00:00
end_time Date 可选 20 捐赠记录的结束时间（默认是查询当前自然年一年的记录） 2017-12-31 23:59:59

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
donation_tag Boolean 必填 2 是否有过捐赠记录(有:true,否:false) true

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayUserCharityRecordexistQueryRequest request = new AlipayUserCharityRecordexistQueryRequest();
request.setBizContent("{" +
"\"partner_id\":\"2088111122223333\"," +
"\"user_id\":\"2088111122223333\"," +
"\"biz_type\":10," +
"\"start_time\":\"2017-01-01 00:00:00\"," +
"\"end_time\":\"2017-12-31 23:59:59\"" +
"  }");
AlipayUserCharityRecordexistQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_user_charity_recordexist_query_response":{
        "msg":"Success",
        "code":"10000",
        "donation_tag":true
    }
}

异常示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_user_charity_recordexist_query_response":{
        "msg":"Service Currently Unavailable",
        "code":"20000",
        "sub_msg":"系统繁忙",
        "sub_code":"isp.unknow-error"
    }
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARTNER_ID 合作方id非法 未输入约定的partner_id,请修正此参数
INVALID_USERID userid非法 入参的 userid 格式错误，请注意: userid 必须是以2088开头的16位数字字符串 请修正此参数
INVALID_USER_STATUS 此用户未开通支付宝公益业务 此用户未开通支付宝公益业务
INVALID_BIZ_TYPE 业务类型非法 请按照接口描述详细填写业务类型(缺省是所有业务类型)
INVALID_TIME 开始时间或结束时间非法 请注意以下几点: 1) start_time 和 end_time 格式要正确 2) end_time不能比start_time晚
BIZ_ERROR 业务异常 尝试重新获取数据，或联系技术支持帮忙解决
SYSTEM_ERROR 系统繁忙 尝试重新获取数据，或联系技术支持帮忙解决

公共错误码

公共错误码
有用(0)
我要提问
返回
顶部