alipay.marketing.campaign.discount.budget.query (营销立减活动预算查询)

营销立减活动预算查询

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
budget_id String 必须 32 预算名称 2016050300073001031000003CC3

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
budget_id String 选填 32 预算ID 2016050300073001031000003CC3
total_amount String 选填 15 预算总金额(元) 10000.00
used_amount String 选填 15 交易已使用金额(元) 88.00
refund_amount String 选填 15 交易已退款金额(元) 10.00
recycle_amount String 选填 15 预算已回收退回保证金账户金额(元) 20.00
freeze_amount String 选填 15 预算剩余冻结金额(元) 9902.00

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCampaignDiscountBudgetQueryRequest request = new AlipayMarketingCampaignDiscountBudgetQueryRequest();
request.setBizContent("{" +
"\"budget_id\":\"2016050300073001031000003CC3\"" +
"  }");
AlipayMarketingCampaignDiscountBudgetQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_marketing_campaign_discount_budget_query_response":{
		"msg":"Success",
		"freeze_amount":"9902.00",
		"code":"10000",
		"recycle_amount":"20.00",
		"total_amount":"10000.00",
		"budget_id":"2016050300073001031000003CC3",
		"used_amount":"88.00",
		"refund_amount":"10.00"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
NO_SUPPORT_ERROR 通常是由于没有签约营销方案导致权限校验失败 联系产品和运营方进行方案签约
REQUEST_PARAM_ILLEGAL 输入参数错误 检查预算ID格式是否正确
TEMPLATE_NOT_EXIST 券模板(折扣券预算)信息不存在 检查输入的预算ID是否正确
UNKNOWN_EXCEPTION 通常是系统内部错误 可发起重试

公共错误码

返回
顶部