alipay.marketing.data.equity.sync (惠支付对集团的权益同步接口)

惠支付对集团的权益同步接口,如异业券等

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必须 32 支付宝userid 2088102140505093
original_biz_no String 必须 64 original_biz_no original_biz_no
original_biz_type String 必须 64 original_biz_type original_biz_type
out_biz_no String 必须 64 out_biz_no out_biz_no
equity_code String 可选 64 equity_code equity_code
equity_id String 可选 256 equity_id equity_id
equity_from String 可选 64 equity_from yyq
equity_info EquityInfo 必须 - equity_info {\"description\":\"description\",\"logo\":\"logo\",\"name\":\"name\",\"status\":\"status\",\"url\":\"url\",\"value\":\"value\"}
  • └ name
  • String
  • 必填
  • 64
  • 天猫优惠券
  • 天猫优惠券
  • └ description
  • String
  • 必填
  • 64
  • ‘杰克琼斯’
  • ‘杰克琼斯’
  • └ value
  • String
  • 必填
  • 64
  • 优惠价值
  • 10元/ 9折
  • └ url
  • String
  • 必填
  • 256
  • url
  • url
  • └ logo
  • String
  • 必填
  • 128
  • logo
  • logo
  • └ status
  • String
  • 必填
  • 64
  • APPLIED:已申领;UNAPPLIED:未申领;DELETED:已过期
  • UNAPPLIED
  • └ ext_info
  • String
  • 必填
  • 512
  • ext_info
  • ext_info
biz_time Date 必须 64 biz_time 2010-11-11 11:11:11

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
success Boolean 必填 10 true/false true

请求示例

  • 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");
AlipayMarketingDataEquitySyncRequest request = new AlipayMarketingDataEquitySyncRequest();
request.setBizContent("{" +
"\"user_id\":\"2088102140505093\"," +
"\"original_biz_no\":\"original_biz_no\"," +
"\"original_biz_type\":\"original_biz_type\"," +
"\"out_biz_no\":\"out_biz_no\"," +
"\"equity_code\":\"equity_code\"," +
"\"equity_id\":\"equity_id\"," +
"\"equity_from\":\"yyq\"," +
"\"equity_info\":{" +
"\"name\":\"天猫优惠券\"," +
"\"description\":\"‘杰克琼斯’\"," +
"\"value\":\"10元/ 9折\"," +
"\"url\":\"url\"," +
"\"logo\":\"logo\"," +
"\"status\":\"UNAPPLIED\"," +
"\"ext_info\":\"ext_info\"" +
"    }," +
"\"biz_time\":\"2010-11-11 11:11:11\"" +
"  }");
AlipayMarketingDataEquitySyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_data_equity_sync_response":{
		"msg":"Success",
		"code":"10000",
		"success":true
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
BIZ_ERROR 业务异常 业务出错
INVALID_PARAMETER 参数有误 参数出错

公共错误码

返回
顶部