开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
小程序开发管理
生物核身
交易组件
小程序商品
接入指南
api 列表
普通商品
本地生活商品
商品管理
凭证管理
酒店日历房
租房
支付宝文件
商品变更相关
商品营销相关
相关资料
支付有礼
商家粉丝群
营销产品
资金产品
会员产品
信用产品
广告产品
开发 > 服务端 > 私域产品 > 小程序产品 > 权限集列表 > 小程序商品 > api 列表 > 本地生活商品 > 凭证管理 > 撤销凭证核销状态接口
已更新
文档更新记录 >
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
商户调用该接口进行凭证冲正处理,接口同步返回结果。

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.marketing.certificate.certification.refund
formatstring可选40
仅支持json
json
charsetstring必选10
请求使用的编码格式,如utf-8,gbk,gb2312等
utf-8
sign_typestring必选10
商户生成签名字符串所使用的签名算法类型,目前支持rsa2和rsa,推荐使用rsa2
rsa2
signstring必选344
商户请求参数的签名串,详见签名
详见示例
timestampstring必选19
发送请求的时间,格式"yyyy-mm-dd hh:mm:ss"
2014-07-24 03:07:50
versionstring必选3
调用的接口版本,固定为:1.0
1.0
app_auth_tokenstring可选40
biz_contentstring必选
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

业务请求参数

out_biz_no|外部业务单号必选string[0,64]
【描述】业务请求单号,用作幂等控制。 超时重试等幂等请求场景保持该值不变,且确保其它所有请求参数不变,再次请求返回上次执行结果。其它场景请更换该值,确保每次不同的请求该值不相同。
【示例值】1002600620019090123143254436
use_order_no_list|核销操作单号必选array[1,999999]
【描述】已核销的凭证id.在核销接口返回不区分平台码与三方码
【示例值】["2023052100445005835800000045"]
以下参数 二选一 传入
user_id|凭证归属支付宝用户idstring[1,32]
【描述】凭证归属支付宝用户id
新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
【示例值】2088xxxxx
open_id|凭证归属支付宝用户openidstring[1,128]
【描述】凭证归属支付宝用户openid  详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
常见请求示例
package com.java.sdk.demo;
import com.alipay.api.alipayapiexception;
import com.alipay.api.alipayclient;
import com.alipay.api.defaultalipayclient;
import com.alipay.api.certalipayrequest;
import com.alipay.api.alipayconfig;
import com.alipay.api.domain.alipaymarketingcertificatecertificationrefundmodel;
import com.alipay.api.request.alipaymarketingcertificatecertificationrefundrequest;
import com.alipay.api.response.alipaymarketingcertificatecertificationrefundresponse;
import com.alipay.api.fileitem;
import java.util.base64;
import java.util.arraylist;
import java.util.list;
public class alipaymarketingcertificatecertificationrefund {
    public static void main(string[] args) throws alipayapiexception {
        string privatekey = "<-- 请填写您的应用私钥,例如:miievqibadanb ... ... -->";
        string alipaypublickey = "<-- 请填写您的支付宝公钥,例如:miibijanbg... -->";
        alipayconfig alipayconfig = new alipayconfig();
        alipayconfig.setserverurl("https://openapi.alipay.com/gateway.do");
        alipayconfig.setappid("<-- 请填写您的appid,例如:2019091767145019 -->");
        alipayconfig.setprivatekey(privatekey);
        alipayconfig.setformat("json");
        alipayconfig.setalipaypublickey(alipaypublickey);
        alipayconfig.setcharset("utf-8");
        alipayconfig.setsigntype("rsa2");
        alipayclient alipayclient = new defaultalipayclient(alipayconfig);
        alipaymarketingcertificatecertificationrefundrequest request = new alipaymarketingcertificatecertificationrefundrequest();
        alipaymarketingcertificatecertificationrefundmodel model = new alipaymarketingcertificatecertificationrefundmodel();
        model.setoutbizno("1002600620019090123143254436");
        model.setuserid("2088xxxxx");
        list<string> useordernolist = new arraylist<string>();
        useordernolist.add("2023052100445005835800000045");
        model.setuseordernolist(useordernolist);
        request.setbizmodel(model);
        alipaymarketingcertificatecertificationrefundresponse response = alipayclient.execute(request);
        system.out.println(response.getbody());
        if (response.issuccess()) {
            system.out.println("调用成功");
        } else {
            system.out.println("调用失败");
            // sdk版本是"4.38.0.all"及以上,可以参考下面的示例获取诊断链接
            // string diagnosisurl = diagnosisutils.getdiagnosis;
            // system.out.println(diagnosisurl);
        }
    }
}
说明:本示例仅供参考。

公共响应参数

参数类型是否必选最大长度描述示例值
codestring必选-
网关返回码,
40004
msgstring必选-
网关返回码描述,
business failed
sub_codestring可选-
业务返回码,参见具体的api接口文档
acq.trade_has_success
sub_msgstring可选-
业务返回码描述,参见具体的api接口文档
交易已被支付
signstring必选-
签名,
dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

certificate_reverse_result_list|撤销核销结果列表必选certificatereverseresult[]
【描述】撤销核销结果列表
certificate_id|凭证id必选string(32)
【描述】凭证id
【示例值】2021042322001426261436764012
use_order_no|核销操作单号必选string(32)
【描述】撤销接口传入的核销操作单号
【示例值】2023052100445005835800000045
result|撤销结果枚举必选string(32)
【描述】撤销结果枚举
【枚举值】
撤销成功: success
凭证已作废,不可撤销核销: certificate_is_invalid
凭证已过期,不可撤销核销: certificate_is_expired
【示例值】success
msg|结果说明必选string(1024)
【描述】结果说明
【示例值】撤销成功
响应示例
{
    "alipay_marketing_certificate_certification_refund_response": {
        "code": "10000",
        "msg": "success",
        "certificate_reverse_result_list": [
            {
                "certificate_id": "2021042322001426261436764012",
                "use_order_no": "2023052100445005835800000045",
                "result": "success",
                "msg": "撤销成功"
            }
        ]
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。

公共错误码

业务错误码

错误码错误描述凯发app官方网站的解决方案
system_error系统繁忙
可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
certificate_not_exist凭证不存在或未发放
对应的凭证不存在,修改入参后进行重试。
certificate_not_used凭证尚未被核销,不支持撤销核销
对应的凭证未被核销,不能撤销核销,修改入参或核销后进行重试。
time_out_exception调用超时
调用超时,请求可能成功也可能失败,请以相同的请求发起重试,重试请确保外部业务单号(out_biz_no)不变
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
为开发者能享受更简单的协议处理逻辑、更丰富的开源工具配套、更低的接口响应时延,支付宝开放平台推出符合oas3.0规范的,助力开发体验。新版本文档请点击“查看v3版本”进行访问。
网站地图