Skip to main content

现金卡预核销

基本信息

接口名称:券核心批量预核销券状  态:已完成
接口路径:POST /paas/micro/whale/whaleBatchCodeCheck更新时间:2024-08-28 00:31:21
Mock地址:https://apimock.e-buychina.com/mock/195/paas/micro/whale/whaleBatchCodeCheck

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring是请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring是请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring是交易类型最大长度:50
最小长度:1
Mock:whaleBatchCodeCheck
timestampnumber是请求时间戳Mock:@timestamp
signTypestring是签名类型最大长度:20
最小长度:1
Mock:sha256
signstring是签名值最大长度:500
最小长度:1
Mock:@natural
langstring是语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject是请求报文
  whaleConfigIdstring否配置ID(为空则按appid查找whale配置)最大长度:32
最小长度:1
Mock:@word
  verifyScenestring是核销场景最大长度:20
最小长度:1
Mock:@word
  isProductCheckstring是是否校验订单产品规则,是Y,否N最大长度:20
最小长度:1
Mock:@string
  codesarray是券号列表
  codeListarray是
    codestring是券号最大长度:64
最小长度:1
Mock:@string
    voucherTypestring是券类型(卡则传:Cashcard)最大长度:20
最小长度:1
Mock:@string
    isUsedstring是是否已经核销使用过,Y 已核销,N未核销 每次券列表中只能有一张未核销的券最大长度:1
最小长度:1
Mock:@string
  cashierTransNostring否收银机号最大长度:100
Mock:@string
  cashTotalAmountnumber否收银机金额(单位:分)Mock:@natural
  shopNostring否店号最大长度:20
Mock:@string
  goodsDetailarray是商品列表
    skustring是商品SKU最大长度:64
最小长度:1
Mock:@string
    qtynumber是数量Mock:@natural
    pricenumber是单价(单位:分)Mock:@natural
    typestring否商品品类最大长度:20
最小长度:1
Mock:@string
    specstring否商品规格最大长度:20
最小长度:1
Mock:@string
    tagstring否商品核销标记最大长度:20
最小长度:1
Mock:@string
  requestIdstring是请求id最大长度:30

返回数据

参数名称类型必填默认值备注其他信息
uuidstring是请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
successboolean是交易成功与否Mock:@boolean
actionstring是交易类型最大长度:50
最小长度:1
Mock:whaleBatchCodeCheck
timestampnumber是返回时间戳Mock:@timestamp
errorCodestring是错误码最大长度:50
Mock:@word
errorMessagestring是错误描述最大长度:50
Mock:@csentence
signTypestring否签名类型最大长度:20
Mock:sha256
signstring否签名值最大长度:500
Mock:@natural
contentobject是返回报文
  checkResultarray是校验结果
    statusstring是结果,00成功,其他失败最大长度:50
最小长度:1
Mock:@string
    statusDescstring否状态描述最大长度:100
    discountAmountnumber否折抵金额(单位:分)Mock:@natural
    saleChannelCodestring否取码方编号最大长度:50
    saleChannelNamestring否取码方名称最大长度:100
    codestring是券号最大长度:64
最小长度:1
Mock:@string
    goodsDetailarray是返回折抵商品信息
      skustring是商品SKU最大长度:64
最小长度:1
Mock:@string
      qtynumber是数量Mock:@natural
      pricenumber是单价(单位:分)Mock:@natural
      typestring否商品品类最大长度:20
最小长度:1
Mock:@string
      specstring否商品规格最大长度:20
最小长度:1
Mock:@string
    requestGoodsDetailarray是返回上送产品打标记情况明细
      skustring是商品SKU最大长度:64
最小长度:1
Mock:@string
      qtynumber是数量Mock:@natural
      pricenumber是单价(单位:分)Mock:@natural
      typestring否商品品类最大长度:20
最小长度:1
Mock:@string
      specstring否商品规格最大长度:20
最小长度:1
Mock:@string
      tagstring否商品核销标记最大长度:20
最小长度:1
Mock:@string
  returnCodestring是返回码最大长度:100
  returnMsgstring是返回信息最大长度:100

备注

注意:为保证签名的一致性,返回报文中的content字段将以string形式的进行返回,例如:

{
	"content": {
		"userId": 1,
		"userName": "Trump"
	}
}

将返回为:

{
	"content": "{\"userId\":1,\"userName\":\"Trump\"}"
}

1. 接口返回码
* succese为false时才需要处理errorCode

errorCode errorMessage 备注
MICRO_WHALE_REQUEST_LENGTH_ILLEGAL 参数长度不正确
MICRO_WHALE_REQUEST_IS_NULL 参数不能为空
MICRO_WHALE_PROCESS_ERROR 处理异常 请联系易百
MICRO_WHALE_GET_CONFIG_ERROR 获取配置记录失败 请联系易百
MICRO_WHALE_GET_CONFIG_ERROR 获取配置记录失败 请联系易百

2. checkResult内的status:
* 为00时表示可用,其他返回值皆为不可用。

status 描述 备注
00 可用
01 已使用
03 未激活 未激活的码需调用激活接口才能
04 已冻结
05 已作废
06 已过期
07 未生效 当制码时选择次日生效,核销时会返回该状态
09 码不存在
35 劵数据异常 联系易百确认
39 核销失败
91 核销异常

变更历史

变更日期变更内容
2024-08-27
2022-04-21
2022-04-13
2022-04-13
2022-04-12
2022-04-12
2022-04-01
2022-04-01
2022-03-10
2022-03-10
2022-03-10
2022-03-10
2022-03-10
2022-03-08
2021-06-22
2021-06-22
2021-06-07
2021-06-04
2020-04-24
2020-04-24
2020-04-24
2020-04-24
api-id=14869