koubei.trade.ticket.ticketcode.cancel(口碑凭证码撤销核销)

根据核销请求号撤销核销凭证

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.trade.ticket.ticketcode.cancel
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
notify_url String 256 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必选 32 核销的外部请求号,指定撤销某一次的核销动作 2016102903214476899999999
request_biz_no String 必选 64 业务请求号,一般为正向核销时使用的外部请求号 2016102903214476899999999
ticket_code String 必选 32 request_id对应核销的券码 016569843362
quantity String 可选 4 冲正份数,目前仅次卡业务使用,用于校验正反向份数相同 2
order_no String 可选 32 口碑订单号,使用外部券码取消时必填 20180404111040030100130500594477
code_type String 可选 16 INTERNAL_CODE(券码),EXTERNAL_CODE(外部券码),默认INTERNAL_CODE INTERNAL_CODE

响应参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必填 64 外部请求号,支持英文字母和数字,由开发者自行定义(不允许重复) 2016102903214476899999999
biz_code String 选填 32 该字段用于描述本次返回中的业务属性,现有:BIZ_ALREADY_SUCCESS(幂等业务码)。 BIZ_ALREADY_SUCCESS

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiTradeTicketTicketcodeCancelRequest request = new KoubeiTradeTicketTicketcodeCancelRequest();
request.setBizContent("{" +
"\"request_id\":\"2016102903214476899999999\"," +
"\"request_biz_no\":\"2016102903214476899999999\"," +
"\"ticket_code\":\"016569843362\"," +
"\"quantity\":\"2\"," +
"\"order_no\":\"20180404111040030100130500594477\"," +
"\"code_type\":\"INTERNAL_CODE\"" +
"  }");
KoubeiTradeTicketTicketcodeCancelResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_trade_ticket_ticketcode_cancel_response": {
        "code": "10000",
        "msg": "Success",
        "request_id": "2016102903214476899999999",
        "biz_code": "BIZ_ALREADY_SUCCESS"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 重试
INVALID_PARAMETER 参数有误 对照接口文档以及请求参数用例,修改请求参数
USE_BIZ_ORDER_CLOSE 正向核销流水已关闭 说明正向核销失败,无需冲正,可以重新发起核销请求
USE_CHANNEL_NOT_EQUAL 撤销的凭证不是通过开放平台核销 不要尝试撤销非开放平台核销的凭证
TICKET_STATUS_ILLEGAL 凭证状态不是已核销 检查凭证状态
USE_BIZ_ORDER_NOT_EXIST 券正向核销操作单不存在 检查当前外部请求号是否调用过核销接口
NOT_SAME_MERCHANT_PID 非当前商家的凭证码,无法操作 只能查询当前商家的凭证码,确认该凭证码是否属于本商家
REQUEST_ID_REPEAT 流水号重复,但参数不一致 流水号生成存在重复,检查流水号生成规则
REPEAT_CANCEL 对同一正向流水重复冲正(请求ID不同) 对同一正向流水只能用相同请求ID尝试冲正

触发通知类型

通知类型描述默认开启
koubei_ticket_openapi_use_notify 业务通知类型 口碑开放平台券撤销核销通知 1

触发通知示例

https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync&notify_id=91722adff935e8cfa58b3aabf4dead6ibe&notify_time=2017-02-16 21:46:15&sign_type=RSA2&sign=WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93joTW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY=&request_id=2016102903214476899999999&notify_id=e03bb2453c905fbe37570ddfc9ed313j8q&notify_type=koubei_ticket_openapi_use_notify&biz_type=TICKET_CANCEL
onlineServer