alipay.fund.coupon.operation.query(红包明细查询接口) 在线调试(沙箱环境)

通过该接口可以查询单笔明细的详细信息

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
auth_no String 特殊可选 64 支付宝授权资金订单号,与商户的授权资金订单号不能同时为空,二者都存在时,以支付宝资金授权订单号为准,该参数与支付宝授权资金操作流水号配对使用。 2014021601002000640012345678
out_order_no String 特殊可选 64 商户的授权资金订单号,与支付宝的授权资金订单号不能同时为空,二者都存在时,以支付宝的授权资金订单号为准,该参数与商户的授权资金操作流水号配对使用。 8077735255938023
operation_id String 特殊可选 64 支付宝的授权资金操作流水号,与商户的授权资金操作流水号不能同时为空,二者都存在时,以支付宝的授权资金操作流水号为准,该参数与支付宝授权资金订单号配对使用。 20140216010020006400
out_request_no String 特殊可选 64 商户的授权资金操作流水号,与支付宝的授权资金操作流水号不能同时为空,二者都存在时,以支付宝的授权资金操作流水号为准,该参数与商户的授权资金订单号配对使用。 2014021600100146

响应参数

参数 类型 是否必填 最大长度 描述 示例值
auth_no String 必填 64 支付宝资金授权订单号 2014031600002001260000001000
out_order_no String 必填 64 商户的授权资金订单号 2014021600123458
operation_id String 必填 64 支付宝资金操作流水号 20140216355864862002
out_request_no String 必填 64 商户资金操作的请求流水号 2014021600100148
amount Price 必填 11 该支付宝操作流水操作金额,单位为:元(人民币) 100.00
order_title String 必填 100 业务订单的简单描述,如商品名称等 红包发放
operation_type String 必填 20 支付宝资金操作类型。
目前支持:
PAY:支付
REFUND:退款
PAY
status String 必填 20 资金操作流水的状态,
目前支持:
INIT:初始
SUCCESS:成功
CLOSED:关闭
SUCCESS
remark String 必填 100 商户对本次操作的附言描述,长度不超过100个字母或50个汉字 红包发放
payer_user_id String 选填 32 付款方支付宝账号对应的支付宝唯一用户号。
以2088开头的16位纯数字组成。
2088402019148643
payer_logon_id String 选填 100 付款方支付宝账号(Email或手机号)。仅作展示使用,默认会加“*”号处理 ali*@alipay.com
payee_user_id String 选填 32 收款方支付宝账号对应的支付宝唯一用户号。
以2088开头的16位纯数字组成。
2088102138117431
payee_logon_id String 选填 100 收款方支付宝账号(Email或手机号)。仅作展示使用,默认会加“*”号处理 zhan**@alitest.com
gmt_create Date 必填 20 资金授权单据操作流水创建时间,
格式:YYYY-MM-DD HH:MM:SS
2014-01-01 20:00:00
gmt_trans Date 必填 20 支付宝账务处理成功时间,
格式:YYYY-MM-DD HH:MM:SS
2014-01-01 20:01:00
extra_param String 选填 300 商户请求创建预授权订单时传入的扩展参数(merchantExt, orderExpiredTime) {"orderExpiredTime":"10m"}
total_pay_refund_amount Price 必填 11 红包总退回金额,单位为:元(人民币) 1.00

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundCouponOperationQueryRequest request = new AlipayFundCouponOperationQueryRequest();
request.setBizContent("{" +
"\"auth_no\":\"2014021601002000640012345678\"," +
"\"out_order_no\":\"8077735255938023\"," +
"\"operation_id\":\"20140216010020006400\"," +
"\"out_request_no\":\"2014021600100146\"" +
"  }");
AlipayFundCouponOperationQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_coupon_operation_query_response": {
        "code": "10000",
        "msg": "Success",
        "auth_no": "2014031600002001260000001000",
        "out_order_no": "2014021600123458",
        "operation_id": "20140216355864862002",
        "out_request_no": "2014021600100148",
        "amount": 100,
        "order_title": "红包发放",
        "operation_type": "PAY",
        "status": "SUCCESS",
        "remark": "红包发放",
        "payer_user_id": "2088402019148643",
        "payer_logon_id": "ali*@alipay.com",
        "payee_user_id": "2088102138117431",
        "payee_logon_id": "zhan**@alitest.com",
        "gmt_create": "2014-01-01 20:00:00",
        "gmt_trans": "2014-01-01 20:01:00",
        "extra_param": "{\"orderExpiredTime\":\"10m\"}",
        "total_pay_refund_amount": 1
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_ARGUMENT 参数有误 检查请求参数,修改后重新发起请求
AUTH_ORDER_NOT_EXIST 支付宝资金授权订单不存在 检查传入参数中的支付宝资金授权订单号或商户授权订单号,修改后重新发起请求
AUTH_OPERATION_NOT_EXIST 支付宝资金操作流水不存在 检查传入参数中的支付宝的授权资金操作流水号或商户的授权资金操作流水号,修改后重新发起请求
SYSTEM_ERROR 系统繁忙 发起重试,如果多次调用依然报此错误码,请联系支付宝客服
ACCESS_FORBIDDEN 商户无权查看该笔订单信息 请检查该商户是否创建了该笔授权订单
onlineServer