商户通过该接口获取营销等信息

接口说明

公共请求参数

变量 参数名 类型[长度限制] 必填 描述
method 方法名 string[1,32] 是 CREDIT_PAY_FRONT
version 版本 string[1,16] 是 接口版本：1.0
format 请求格式 string[1,16] 是 业务请求参数格式，支持：JSON
merchantNo 商户号 string[1,16] 是 商户在慧收钱的商户号，由慧收钱生成并下发
signType 加密类型 string[1,16] 是 RSA2:签名机制查看说明
signContent 业务数据 string 是 业务请求参数
sign 签名数据 string[1,128] 否 签名数据

业务请求参数

变量 参数名 类型[长度限制] 必填 描述
orderAmt 订单总金额 string[1,11] 条件必填 查询用户营销信息（如 operationTip）时必填，单位：分。存在订单金额且参与计算的优惠金额大于0时，返回满足条件的营销信息
示例值：2000
undiscountableAmount 不参与优惠计算订单金额 string[1,11] 否 不参与优惠计算的订单金额，单位：分，不得大于 totalAmount
示例值：100
transNo 商户订单号 string[1,64] 否 商户系统内部订单号。同一商户号下唯一，只能包含数字、大小写字母及 _、-、*
serviceId 服务ID string[1,32] 是 业务接入时分配的服务标识
payType 交易类型 string[1,32] 是 固定值DOUYIN_CREDIT
memo 扩展信息 string 条件必填 JSON格式，将Memo参数域转JSON字符串

Memo参数域

变量 参数名 类型[长度限制] 必填 描述
appid 商户应用ID string[1,32] 条件必填 商户业务应用ID，接入子商户应用场景时传入
示例值：awofz9bncda6w2w4
goodsDetail 商品列表信息 array[object] 否 订单包含的商品列表。商品数量与商品单价乘积之和不得超过订单总金额，即 sum(quantity * unitPrice) <= totalAmount
deviceId 设备号 string[1,64] 条件必填 与 deviceType 成组使用。当无法取得用户OpenID时，建议同时传入 deviceId 和 blindMobileList；仅在用户OpenID、手机号和设备号均无法获取时可全部留空
示例值：14b07957e368d91
deviceType 设备号类型 string[1,16] 条件必填 传入 deviceId 时必填。支持 OAID、IDFA、CAID；存在多个CAID时取最新值
示例值：OAID
blindMobileList 手机号列表 array[string] 条件必填 最多同时传入两个手机号。当无法取得用户OpenID时，建议与设备号一起传入；仅在用户OpenID、手机号和设备号均无法获取时可全部留空
attach 订单附加数据 string[1,1024] 条件必填 订单附加数据，建议与后续下单接口保持一致
示例值：自定义数据
goodsTag 营销优惠标记 string[1,512] 否 用于营销差异化展示的标记信息，内容为键值对形式的JSON，传输时序列化为字符串；协商后传入
Memo.goodsTag参数域
变量 参数名 类型[长度限制] 必填 描述
bizScene 业务场景 string[1,32] 否 协商后传入，主要用于区分商户的不同业务场景；单次请求只能传入一个场景值
示例值：pre_consult
productTag 个性化策略 string[1,32] 否 协商后传入，用于指定对应的个性化策略
示例值：default
Memo.goodsDetail参数域
变量 参数名 类型[长度限制] 必填 描述
merchantGoodsId 商户侧商品编码 string[1,32] 是 商户侧商品唯一编码
示例值：GOODS_001
douyinpayGoodsId 抖音支付商品编码 string[1,32] 否 抖音支付侧商品编码
示例值：DOUYIN_GOODS_001
goodsName 商品名称 string[1,256] 否 商品名称
示例值：测试商品
quantity 商品数量 integer 是 商品数量，必须大于0
示例值：2
unitPrice 商品单价 integer 是 商品单价，单位：分，必须大于0
示例值：500

公共请求示例

{method=CREDIT_PAY_FRONT, format=json, signType=RSA2, ,signContent=【参考业务请求示例】,sign=7ecbad9cb113bd54e6ee45f7fe76883a40428d548b7294ce8f7ba30f211881073820d3ec7a54d3406dcf7a4d3f87f0994c24db54bab430777425147378dbf01afe0491a1c287e5ce380454b0e228a5a20d541874c14addd4100199660e6c4a857fa080ceb4601a0ee21e3fab9d87016198f151a3b16f60a254c1e8b4cd42cdf7, version=1.0, merchantNo=8000000026}

业务请求示例

{
  "serviceId": "100001",
  "totalAmount": "2000",
  "undiscountableAmount": "100",
  "memo": "{\"appid\":\"awofz9bncda6w2w4\",\"outTradeNo\":\"ORDER202608010001\",\"goodsDetail\":[{\"merchantGoodsId\":\"GOODS_001\",\"douyinpayGoodsId\":\"DOUYIN_GOODS_001\",\"goodsName\":\"测试商品\",\"quantity\":2,\"unitPrice\":500}],\"deviceId\":\"14b07957e368d91\",\"deviceType\":\"OAID\",\"blindMobileList\":[\"66d0fba82f83396b8c37c47e151f8076a479064eccd78517b604646040e8fcfd\"],\"attach\":\"自定义数据\",\"goodsTag\":\"{\\\"bizScene\\\":\\\"pre_consult\\\",\\\"productTag\\\":\\\"default\\\"}\"}"
}

公共响应参数

变量 参数名 类型[长度限制] 必填 描述
success 响应状态 string[1,32] 是 服务端响应状态，如果为true，则可以调用result；如果为false，则调用errorCode来获取出错信息
errorCode 错误码 string[1,32] 否 响应码
errorMsg 错误描述 string[1,128] 否 响应描述
result 响应内容 string 否 业务响应参数
sign 签名数据 string[1,128] 否 响应验签数据

业务响应参数

变量 参数名 类型[长度限制] 必填 描述
channelInfoList 渠道信息列表 array[object] 是 支付渠道信息，包含渠道可用状态、产品及优惠信息。只有查询用户成功时，才返回对应的查询内容

ChannelInfo参数域

变量 参数名 类型[长度限制] 必填 描述
blindMobile 加密手机号 string 否 请求中匹配到的加密手机号
channelIndex 渠道唯一索引 string 是 本次咨询结果中的渠道唯一索引
示例值：100001
channelName 渠道名称 string 是 支付渠道名称
示例值：抖音支付
channelEnable 渠道可用标识 boolean 是 支付渠道是否可用：true表示可用，false表示不可用
operationInfo 营销模型 object 否 本次咨询匹配到的营销内容，可用于商户侧展示。获取该字段前需由抖音支付配置对应的前置咨询策略及营销活动
assignDiscounts 指定优惠信息 string 是 本次咨询返回的优惠唯一标识。后续下单时放入 goodsTag.assignDiscounts 中传入，商户无需解析其内容
memo 扩展信息 string 否 JSON字符串，包含用户标签等扩展信息；标签编码含义按协商内容解释
ChannelInfo.operationInfo参数域
变量 参数名 类型[长度限制] 必填 描述
viewData 运营展示数据 object 否 可用于展示营销内容的文案及优惠信息组合
ChannelInfo.operationInfo.viewData参数域
变量 参数名 类型[长度限制] 必填 描述
operationTip 运营文案描述 string 否 可用于展示营销内容的具体文案
示例值：抖音支付立减6元
operationAmount 固定立减金额 string 否 查询用户可用的固定立减金额，单位：元。只有立减金额最小值与最大值相等时返回，否则为空
operationMinAmount 立减金额最小值 string 否 立减金额的最小值，单位：元；无论固定立减还是随机立减均返回
operationMaxAmount 立减金额最大值 string 否 立减金额的最大值，单位：元；无论固定立减还是随机立减均返回
operationUnit 立减金额单位 string 否 立减金额单位，默认返回“元”

公共响应示例

{
"success":true,
"result":"【业务响应示例】",
"errorCode":null,
"errorMsg":null,
"sign":"88faca1f2511cc194367ffd96aa78a4cdf25a8284b0cd74b75e331b37c642b26aaeb46f2e4be38080eeb2b78575abd715d58fd30bbf59e167d64d0b714487f9462381e499a48524b1704694f256fa8f6e917d33cd413e365872ef2c7eede37ab4b23f67dcf6f34ec0daf65a34502123f792a646bea6447c126a612087825b17b91e585f74e56220328b198982e62a734387cd8556927e6881878b821969b6e784a20771cf55fad70a4368b8650c0ece0a7903678e1ad6134f6c711329a3e3e456c28ffbfc607fa6bf1f969a4d38b35ca3bf9ad81f71b2d2ad816502d579c0c4fc1f1fccec74a861c4679c5217be0176bf1eebcb57aea381f922fcf920aa471198be972f0c4f9fab10f7885b9c09eda977351b40e9058247ec30da55dd4c0be4a9de7d996e186e9f9ff2693f564f0eaddca9d7ff9f3b813d0c70bdba75b2a1bf9bd4ddf28ff66c45d6ce31e188d8606c82078d842008a9a1b4c1b64b7b2d3632087e46bbc4322181a9832cecd852682fdb72d336b32512bde94e81ba322fe9d2d"
}

业务响应示例

{
  "channelInfoList": [
    {
      "blindMobile": "66d0fba82f83396b8c37c47e151f8076a479064eccd78517b604646040e8fcfd",
      "channelIndex": "100001",
      "channelName": "抖音支付",
      "channelEnable": true,
      "operationInfo": {
        "productCode": "PayAndSign",
        "viewData": {
          "operationTip": "抖音支付立减6元",
          "operationAmount": "6",
          "operationMinAmount": "6",
          "operationMaxAmount": "6",
          "operationUnit": "元"
        }
      },
      "assignDiscounts": "5c38c871fa71383aac7da37a8b1df480",
      "extInfo": "{\"bizTagList\":[{\"tagCode\":\"A0000001\",\"tagName\":\"最高立减15元\"},{\"tagCode\":\"B0000002\",\"tagName\":\"高购买力人群\"}]}"
    }
  ]
}

交易状态码

状态码 描述
INIT 初始化
PROCESSING 处理中
SUCCESS 成功
FAIL 失败

交易响应码

响应码 描述 解决方案
100004 不支持该支付通道的交易
100019 无可用渠道
100200 订单已支付成功，请勿重复支付
100203 交易失败
100204 订单已过期，请使用新的订单号发起交易
100205 订单已存在
100206 订单不存在
100207 交易已取消
100208 订单已失败
100209 交易失败，黑名单用户
100210 交易失败，非白名单用户
100211 交易记录不存在
100212 交易失败，风险受限
100500 余额不足
100501 交易金额超限
100502 交易金额低于限额
100503 交易金额不正确
100505 单日交易金额超限
100506 单笔交易金额超限
100507 单月交易金额超限
100600 短信验证码错误
100601 短信验证码失效
100602 请确认是否发送短信,当前交易必须通过短信验证
200002 非法的交易
200003 订单号已存在，请勿重复提交
200004 订单不存在
200005 原订单金额校验不通过
200010 批次号已存在
200011 订单数量超过单批次处理量
200012 请求太过频繁,请稍后再试
200015 不支持此支付类型
200017 订单关闭成功
200018 订单关闭失败,请重试！
200107 分账参数校验异常
200108 交易主体从属关系异常
200109 业务订单不存在
200110 业务订单状态异常
200111 支付金额超限
200112 业务订单已失效
200113 该业务订单不支持部分支付
200114 业务订单已关闭
200115 非法交易
200116 存在成功/处理中订单,请勿重复提交
200117 订单已经分账不能发起退款/撤销
200118 订单金额不等于交易金额+营销金额
200119 订单金额+交易金额不能都为0
200120 营销账户信息不能为空
200201 商户状态异常，无法进行交易
200203 商户与子商户关系不对应，无法进行交易
200204 门店信息不存在，无法进行交易
200205 终端商户信息不存在，无法进行交易
200206 请求ip白名单未配置
200207 账户状态异常
200209 门店信息不存在
200210 设备信息不存在
200302 产品渠道不能为空
300401 交易非法，订单已完成
300701 商户限额校验不通过