Skip to main content

核销通知

基本信息

核销通知,易百将核销通知分发给渠道或者品牌,对接方需提供接口接收通知。

请求参数

Headers

参数名称 参数值 是否必填
Content-Type application/json



Body

参数名称 类型 必填 默认值 备注 其他信息
channelInfoList array 通知渠道列表

    |__action string VerifyCodeNotify 通知action 最大长度:24
最小长度:1
    |__channelAppId string ebuy19915d0498cf 通知渠道appId 最大长度:24
最小长度:1
    |__channelId string ebuywha102410004 通知渠道id 最大长度:24
最小长度:1
    |__channelName string 易百演示 通知渠道名称 最大长度:16
最小长度:1
    |__channelType string saleChannel 通知渠道类型 最大长度:12
最小长度:1
    |__messageType string ebuy 通知消息格式 最大长度:12
最小长度:1
    |__notifyType string Verify 通知消息类型 最大长度:12
最小长度:1
    |__ticketIds array 券批次活动id

    |__transferUrl string 通知渠道三方地址
最大长度:255
最小长度:1
appId string
核销请求appid
uuid string 20220509-b485a27c80914357912b029a8a8f5f9b 核销请求uuid 最大长度:40
最小长度:1
verifyScene string online 核销场景 最大长度:8
items array


    |__brandId number 4339 品牌id
    |__brandTicketId string
品牌活动产品id
    |__cashierTransNo string
收银机流水号
    |__code string
核销券码
    |__outerOrderId string
外部制码订单号
    |__outerOrderItemId string
外部制码子订单号
    |__storeInfo object
核销上送门店信息
        |__cityId string
城市id
        |__cityName string
城市名称
        |__companyId string
公司id
        |__companyName string
工司名称
        |__shopName string
门店名称
        |__shopNo string
门店编号
        |__terminalId string
核销终端id
    |__ticketId string
券批次id
    |__ticketName string
券批次名称
    |__userInfo object
制码用户信息
        |__mobile string
制码上送用户手机号
        |__thirdUserId string
制码上送用户id
        |__thirdPlatformType string
上送平台类型
    |__uuid string


    |__verifyTime string
核销时间

请求示例

{
    "channelInfoList": [
        {
            "notifyType": "Verify",
            "whaleChannel": false,
            "messageType": "ebuy",
            "channelAppId": "402410046",
            "serviceProvider": "",
            "action": "VerifyCodeNotify",
            "channelName": "博时基金",
            "channelType": "saleChannel",
            "channelVersion": "paas",
            "channelId": "ebuywha402410046",
            "ticketIds": [
                1000030005007
            ]
        }
    ],
    "appId": "ebuy1d0c0a81a9a4",
    "verifyScene": "default",
    "items": [
        {
            "userInfo": {

            },
            "cashierTransNo": "ttCN051001320241103002000",
            "code": "10032880473026297020",
            "fineGrainedLimit": {
                "current": 1,
                "limitMaxValue": 1,
                "grainedKey": "total"
            },
            "brandTicketId": "",
            "remainUseTimes": 0,
            "returnCashParam": "{\"paymentParam\":\"{\\\"discountCode\\\":\\\"bankCoupon\\\"}\",\"identifierMap\":\"\"}",
            "printData": "00|兑换产品:CoCo都可20元代金券 X 1|",
            "redeemSerialNum": 1,
            "verifyTime": 1730600279144,
            "uuid": "20241103-b00b98fc29544bae8597098e25c70ff7",
            "outerOrderId": "2410071450574725193200",
            "verifyId": "d0085990ca8c4225a8189780d129d7b7",
            "outerOrderItemId": "2410071450574725193200",
            "brandId": "1458",
            "fundsChannel": {
                "merchantRealAmount": 1500,
                "benefitAmount": 0,
                "merchantCustomBenefit": -1,
                "totalAmount": 2800,
                "merchantCustomRealAmount": -1,
                "channelBenefit": 0,
                "merchantBenefit": 0,
                "discountAmount": 2000,
                "channelCustomBenefit": -1,
                "userRealAmount": 0
            },
            "totalUseTimes": 1,
            "storeInfo": {
                "companyId": "171882",
                "cityName": "连云港",
                "merchantId": "860051827866564",
                "companyName": "连云港创高餐饮管理有限公司巨龙南路店",
                "shopName": "CoCo都可连云港巨龙南路店",
                "cityId": "299",
                "terminalId": "27866564",
                "shopNo": "CN0510013",
                "swift": "0"
            },
            "requestGoods": [
                {
                    "rebateCode": "000",
                    "price": 1500,
                    "qty": 1,
                    "sku": "CNAFIBCAA",
                    "type": "A"
                },
                {
                    "rebateCode": "000",
                    "price": 1300,
                    "qty": 1,
                    "sku": "CNAABLCAA",
                    "type": "A"
                }
            ],
            "ticketId": "1000030005007",
            "ticketName": "易百CoCo20元代金券"
        }
    ],
    "uuid": "20241103-b00b98fc29544bae8597098e25c70ff7",
    "createDate": 1730600279174
}

响应

响应参数

参数名称 类型 必填 默认值 备注 其他信息
code string
响应码
message string
响应消息

响应示例

{"code":"EB_SUCCESS","message":"操作成功"}

注意:

响应码不为EB_SUCCESS 或 EB_FAIL 易百将会进行重试,请保证接口幂等性。

  • {"code":"EB_SUCCESS","message":"操作成功"}  // 业务处理成功,不重试
  • {"code":"EB_FAIL","message":"操作失败"}  // 业务处理失败,不重试
  • 其他未知失败   // 重试