koubei.trade.ticket.ticketcode.sync(口碑凭证码同步) 在线调试(沙箱环境)

根据凭证码同步凭证使用状态

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必选 32 外部请求号,支持英文字母和数字,由开发者自行定义(不允许重复) 2016102903214470000000000
ticket_code String 必选 32 凭证码,包括内部凭证码和外部凭证码,内部凭证码为12位,纯数字,且唯一不重复 16569843362
quantity String 必选 4 券码剩余可核销份数(非次卡场景1可核销,0不可核销) 5
order_no String 必选 32 口碑订单号 20180404111040030100130500594477
code_type String 特殊可选 16 凭证码类型,INTERNAL_CODE(内部凭证码),EXTERNAL_CODE(外部凭证码),默认INTERNAL_CODE,外部券场景必填 EXTERNAL_CODE
gmt_biz Date 可选 32 业务发生时间,如为空默认为接口调用时间 2017-09-09 12:12:12
sync_shop_id String 可选 32 凭证状态变更操作发生的门店id store-001

响应参数

参数 类型 是否必填 最大长度 描述 示例值
request_id String 必填 32 外部请求号,支持英文字母和数字,由开发者自行定义(不允许重复) 2016102903214476899999999
order_no String 必填 32 凭证码所属的订单id 20170301011040030100490000189223
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");
KoubeiTradeTicketTicketcodeSyncRequest request = new KoubeiTradeTicketTicketcodeSyncRequest();
request.setBizContent("{" +
"\"request_id\":\"2016102903214470000000000\"," +
"\"ticket_code\":\"16569843362\"," +
"\"quantity\":\"5\"," +
"\"order_no\":\"20180404111040030100130500594477\"," +
"\"code_type\":\"EXTERNAL_CODE\"," +
"\"gmt_biz\":\"2017-09-09 12:12:12\"," +
"\"sync_shop_id\":\"store-001\"" +
"  }");
KoubeiTradeTicketTicketcodeSyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_trade_ticket_ticketcode_sync_response": {
        "code": "10000",
        "msg": "Success",
        "request_id": [
            "2016102903214476899999999"
        ],
        "order_no": "20170301011040030100490000189223",
        "biz_code": "BIZ_ALREADY_SUCCESS"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 重试
INVALID_PARAMETER 参数有误 对照接口文档以及请求参数用例,修改请求参数
TICKET_CODE_NOT_EXIST 凭证码不存在 凭证码不存在,需要核实
NOT_SAME_MERCHANT_PID 非当前商家的凭证码,无法同步 只能同步当前商家的凭证码,确认该凭证码是否属于本商家
TICKET_STATUS_ILLEGAL 券已退款,无法同步 请确认券状态
TICKET_PROCESSING 券已经在处理中 券已经在处理中,稍后重试
onlineServer