券码核销通知

更新时间 2024-07-24 02:58:49
收藏
我的收藏

使用限制

接口说明

  • 由于网络波动等原因,可能会产生重复的通知消息,接入方需要做好幂等,正确处理。
  • 回调可能存在延时,开发者可以通过主动请求查询券信息,确认券核销结果。
  • 在开发者服务端收到回调且处理成功后,需要按正常返回示例返回并且 HTTP 响应状态码设为 200,否则会认为通知失败进行重试。

基本信息

基本信息

HTTP URL

请参考行业模版使用指南配置消息

HTTP Method

POST

请求头

参见通用参数

请求参数

参数名称

类型

是否必填

描述

示例值

msg

string

订单相关信息的 json 字符串

见请求示例

type

string

固定值:verify

verify

version

string

固定值:"2.0"。

回调版本,用于开发者识别回调参数的变更

2.0

msg 字段

字段名

类型

是否必填

描述

示例值

app_id

string

小程序 app_id

tt7cd50a68e3b208fc01

order_info

object

小程序交易系统订单信息


poi_id

string

核销门店poi_id

6601149910161033224

verify_results

array(object)

券核销信息


verify_mode


string

核销方式,该字段为空说明是接口核销

laike : 来客核销

laike

cp_extra

string

预下单时开发者传入的透传字段(如果开发者未传,此字段为空)


order_info 字段

字段名

类型

是否必填

描述

示例值

order_id

string

交易系统订单号

1000000096288643630

verify_results 字段

字段名

类型

是否必填

描述

示例值

result_code

int

核销结果,0为成功,非0失败

0

result_msg

string

核销结果说明

验券成功

item_order_id


string

交易系统商品单号

800000000135213440013213630

verify_time

int64

核销时间,验券成功才会有。

1679897654

time_card

object

次卡次数


code

string

用户券码

100000045385072

time_card 字段

字段名

类型

是否必填

描述

示例值

times_available

int64

剩余可用次数

1

times_used

int64

已使用次数

1

请求示例

curl --location --request POST 'https://xxxxxxx.net/api/v2/result_callback' \
--header 'Content-Type: application/json' \
--data-raw='{
    "version": "2.0",
    "msg":"{\"app_id\":\"tt7cd50a68e3b208fc01\",\"poi_id\":\"6601149910161033224\",\"order_info\":{\"order_id\":\"1000000096288643630\"},\"verify_results\":[{\"result_code\":0,\"result_msg\":\"\",\"item_order_id\":\"800000000135213440013213630\",\"verify_time\":1679897654,\"time_card\":{\"times_available\":1,\"times_used\":1},\"code\":\"100000045385072\"}],\"verify_mode\":\"laike\",\"cp_extra\":\"{\\\"use_trade_delivery\\\":1}\"}",
    "type": "verify"
}'

msg 字段内容示例

{
  "app_id": "tt7cd50a68e3b208fc01",
  "poi_id": "6601149910161033224",
  "order_info": {
    "order_id": "1000000096288643630"
  },
  "verify_results": [
    {
      "result_code": 0,
      "result_msg": "",
      "item_order_id": "800000000135213440013213630",
      "verify_time": 1679897654,
      "time_card": {
        "times_available": 1,
        "times_used": 1
      },
      "code": "100000045385072"
    }
  ],
  "verify_mode": "laike",
  "cp_extra": "{\"use_trade_delivery\":1}"
}

响应参数

参数名称

类型

描述

示例值

err_no

int64

错误码

0

err_tips

string

错误提示

success

响应示例

正常示例

{
  "err_no": 0,
  "err_tips": "success"
}

异常示例


//异常响应或http状态码为非200,
//字节服务端会不断重试
{
  "err_no": 1,
  "err_tips": "fail"
}