Skip to main content

统一下单

基本信息

接口名称:统一下单状  态:已完成
接口路径:POST /paas/micro/cashier/createTrade更新时间:2024-06-22 00:44:27
Mock地址:https://apimock.e-buychina.com/mock/587/paas/micro/cashier/createTrade

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring请求action最大长度:50
最小长度:1
Mock:createTrade
timestampnumber请求时间戳Mock:@timestamp
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
signTypestring签名算法,固定sha256最大长度:10
最小长度:1
Mock:sha256
signstring签名最大长度:500
最小长度:1
Mock:@string
contentobject请求报文
  useScenestring终端使用场,易百分配最大长度:32
最小长度:1
Mock:@string(1, 32)
  outTradeNostring请求交易流水号,每个对接账号唯一。日期(格式YYYYMMDD)开头强制校验。建议:YYYYMMDD+商户号+店号+随机最大长度:32
最小长度:1
Mock:@natural(1, 32)
  storeInfoobject门店信息
    deviceNostring设备号最大长度:32
最小长度:5
Mock:@natural(5, 32)
    shopNostring门店号最大长度:32
最小长度:5
Mock:@natural(5, 32)
    areaCodestring门店行政区划码最大长度:6
最小长度:6
Mock:@string(6,6)
    namestring门店名称最大长度:20
最小长度:4
Mock:@word(4, 20)
  orderIdstring业务订单号,每个对接账号唯一。建议:YYYYMMDD+商户号+店号+随机最大长度:64
最小长度:1
Mock:@natural(1, 32)
  orderTitlestring订单标题,可以用于渠道对账标示最大长度:20
最小长度:5
Mock:@title(5, 20)
  orderDescstring订单描述,可以用作区分订单来源、订单类别最大长度:2000
Mock:@csentence
  goodsDetailarray商品信息
    goodsIdstring商品ID,外部编号最大长度:32
最小长度:32
Mock:@natural
    goodsCodestring商品编码,特殊场景使用,一般不传。内部编号最大长度:32
Mock:@natural
    goodsNamestring商品名称最大长度:50
最小长度:5
Mock:@word(5, 50)
    goodsNumnumber数量Mock:@integer(1, 100)
    priceSalenumber售价,单位元Mock:@float(0, 10000, 0, 2)
    specstring产品规格最大长度:5
最小长度:1
Mock:@word(1, 5)
    categorystring产品品类最大长度:10
最小长度:1
Mock:@word(1, 10)
    unitsstring单位最大长度:2
最小长度:1
Mock:@word(1,2)
    incentiveFlagstring优惠标识 (枚举)最大长度:10
Mock:@word
  extendInfoobject附加信息
    originalDatastring异步通知时原样返回最大长度:200
Mock:@string
    verifyScenestring核销场景Mock:@string
    diningScenestring就餐场景Mock:@string
    tradeComponentOrderIdstring交易组件订单号
  totalAmountnumber单位元,去除其他支付后金额剩余待支付金额,电子钱包和卡支付会用到Mock:100
  oriOrderAmountnumber单位元,订单原始总金额Mock:110
  incentiveAmountnumber单位元,可参与优惠的金额Mock:10
  notifyUrlstring交易结果通知地址(带有异步的结果参数)最大长度:500
最小长度:64
Mock:@url(64,500)
  afterPayUrlstring支付完成后跳转地址(带有同步的结果参数)最大长度:500
最小长度:64
Mock:@url(64,500)
  cancelPayUrlstring中断支付或支付失败跳转地址最大长度:500
最小长度:64
Mock:@url(64,500)
  currencystring币种最大长度:5
最小长度:3
Mock:CNY
  spbillCreateIpstring设备终端IP最大长度:15
最小长度:8
Mock:@ip
  timeStartstring订单请求时间yyyyMMddHHmmss最大长度:14
Mock:20191112134949
  timeExpirestring交易过期时间yyyyMMddHHmmss,默认5分钟有效时间最大长度:14
Mock:20191112134949
  qrCodestring付款码最大长度:64
  payMethodarray支付方式
    assetTypestring资产类型,枚举。preAuth预授权,cash电子钱包,points积分必填。coupon优惠券,cashcard现金卡。储值卡、优惠券非必填最大长度:20
最小长度:1
Mock:@string
    pointsnumberassetType是points,此必填。使用积分数Mock:@string
    cardCouponsstringassetType是coupon、cashcard,此必填。卡或者券码列表,格式:"cardCoupon01|secret01" '|'分隔。secret01 是卡密或码密。最大长度:255
Mock:@string
    payWaystringassetType是cash,此必填。电子钱包支付必填,枚举渠道标识,枚举值。格式为:支付渠道,例如:WECHAT、ALIPAY、FOMOPAY 等最大长度:10
Mock:@string
    amountnumber消费金额。支付
积分
卡 消费金额必填
Mock:@integer
    goodsIdstring资产指定适用产品id最大长度:50
Mock:@string
    thirdUserIdstring所属资产的用户id最大长度:32
Mock:@string
    useLimitstring资产使用限制规则码,如需咨询ebuy对接人员,卡券父类型最大长度:50
Mock:@string
  subsidyarray补贴描述
    accountstring主体编号最大长度:32
最小长度:32
Mock:@natural
    amountnumber补贴金额Mock:@float(0, 10000)

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
successboolean交易成功与否Mock:@boolean
actionstring交易类型最大长度:50
最小长度:1
Mock:createTrade
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject返回报文
  prepayIdstring预支付 ID或者预授权code最大长度:128
最小长度:1
Mock:@natural
  paymentChannelTypestring支付渠道类型最大长度:10
最小长度:1
Mock:@string
  outTradeNostring外部订单号最大长度:128
最小长度:32
Mock:@natural(32, 128)
  paidAmountstring支付成功总金额。totalAmount - paidAmount > 0 表示用户需要另外支付金额最大长度:10
最小长度:1
Mock:@string
  userPaidstring用户实付总金额最大长度:10
最小长度:1
Mock:@string
  merchantAmountstring商户实收金额最大长度:10
最小长度:1
Mock:@string
  cardPaidobjectcashcard 支付结果
    paidAmountstring此资产支付成功金额最大长度:10
最小长度:1
Mock:@string
    merchantAmountstring商户实收金额最大长度:10
最小长度:1
    userAmountstring用户实付金额最大长度:10
最小长度:1
    useListarray卡使用结果
      tenderCodestring商户收入映射码Mock:@string
      discountCodestring商户优惠映射码Mock:@string
      errorCodestring具体使用结果状态码Mock:@string
      paidAmountnumber券折抵金额Mock:@float
      merchantAmountnumber商户实收金额Mock:@float
      userAmountnumber用户实付金额Mock:@float
  couponPaidobjectcoupon支付结果
    paidAmountstring此资产支付成功金额最大长度:10
最小长度:1
Mock:@string
    merchantAmountstring商户实收金额最大长度:10
最小长度:1
Mock:@string
    userAmountstring用户实付金额最大长度:10
最小长度:1
Mock:@string
    paymentStatusstring交易结果Success成功,其他失败Mock:@string
    useListarray每张券使用结果
      tenderCodestring商户收入映射码Mock:@string
      discountCodestring商户优惠映射码Mock:@string
      errorCodestring具体使用结果状态码 00成功Mock:@string
      paidAmountnumber券折抵金额Mock:@float
      merchantAmountnumber商户实收金额Mock:@float
      userAmountnumber用户实付金额Mock:@float
      marketCodestring产品编码Mock:@string
      payChannelDiscountnumber平台补贴金额Mock:@integer
      payMerchantDiscountnumber商家补贴金额Mock:@integer
      codestring券码Mock:@string
      channelBenefitstring平台优惠Mock:@string
      merchantBenefitstring商户优惠Mock:@string
  pointsPaidobject积分支付结果
    paidAmountstring此资产支付成功金额最大长度:10
最小长度:1
Mock:@string
    pointsCountstring使用积分数最大长度:10
最小长度:1
Mock:@string
    tenderCodestring商户收入映射码最大长度:20
Mock:@string
    discountCodestring商户优惠映射码最大长度:20
Mock:@string
    merchantAmountstring商户实收金额最大长度:10
最小长度:1
Mock:@string
  cashPaidobject电子钱包用户支付结果
    paidAmountstring此资产支付成功金额Mock:@string
    userAmountstring用户实付金额Mock:@string
    merchantAmountstring商户实收金额Mock:@string
    tenderCodestring商户收入映射码
    discountCodestring商户优惠映射码
  qrCodeUrlstring二维码最大长度:2000
最小长度:1
Mock:@imageData
  channelAppIdstring支付渠道的 APP ID最大长度:32
最小长度:1
Mock:@natural(1, 32)
  redirectUrlstring跳转地址最大长度:2000
最小长度:1
Mock:@string
  channelParamsobject唤起渠道收银台报文,定制需求,要提前和 ebuy 约定

备注

金额处理逻辑:
1、仅一种支付方式时(payMethod数组长度1),totalAmount必须填写,payMethod里面的amount可以不填写。如果2个都有,请保持一致。
2、仅资产聚合交易时,totalAmount必须填写。约定的扣款顺序不限制。
    除券金额无需上送,卡消费金额、积分消费金额、电子钱包消费金额都必须填写,请保证券、卡和积分的支付成功金额与理想结果保持一致。
3、纯聚合支付时,totalAmount必须填写。约定的扣款顺序保证异步交易支付方式放到最后,并且不允许出现多个异步支付方式。
    A、payMethod里面的amount都可以不填写,交易时会根据约定的扣款顺序依次支付totalAmount,当支付金额>=totalAmount时,交易停止。剩余payMethod支付方式不会再执行。
    B、如果payMethod里面的amount填写时,上述计算金额将失效,会使用填写的amount金额,后续的支付方式将继续使用计算金额。当支付金额>=totalAmount时,交易停止。请保证支付成功金额与理想结果保持一致。
-----------------
错误码

错误码 错误原因 说明
00 成功
MICRO_CASHIER_INVALID_PARAMETER 参数错误 检查请求参数,详情参考errorMessage
MICRO_CASHIER_TXN_NO_NOT_MATCHED 外部交易流水号不符合规范 以当前日期开头,格式为 yyyyMMdd
MICRO_CASHIER_PAYMENT_CHANNEL_MISSING 支付渠道不存在 配置丢失,联系管理员配置
MICRO_CASHIER_REQUEST_LENGTH_ILLEGAL 参数长度不正确 检查请求参数,详情参考errorMessage
MICRO_CASHIER_THIRD_APP_CONFIG_MISSING 找不到配置信息 配置丢失,联系管理员配置
MICRO_CASHIER_REQUEST_FREQUENTLY 请求太频繁 同一个订单号60秒内多次请求
MICRO_CASHIER_AMOUNT_ERROR 交易金额不符合规范 payMethodList 总金额不能小于订单总金额
MICRO_PLUGIN_CONFIG_ERROR 插件配置错误 联系技术人员排查
MICRO_CASHIER_COUPON_RULE_ERROR 券规则校验失败 联系技术人员排查

变更历史

变更日期变更内容
2024-06-21
2024-06-21
2024-06-21
2024-06-20
2024-06-20
2024-06-06
2024-06-06
2024-06-06
2024-06-06
2024-06-05
2024-06-05
2024-06-05
2023-10-26
2023-10-26
2023-02-01
2022-11-10
2022-09-29
2022-06-02
2022-04-02
2022-03-31
2022-03-16
2022-03-14
2022-03-14
2022-03-14
2022-03-14
2022-03-14
2022-03-14
2022-03-14
2022-03-10
2022-03-04
2022-03-04
2022-03-03
2022-02-16
2022-02-10
2021-12-13
2021-12-13
2021-11-30
2021-11-27
2021-11-27
2021-10-27
2021-10-27
2021-10-19
2021-10-15
2021-09-07
2021-07-29
2021-07-23
2021-07-21
2021-07-09
2021-07-09
2021-07-09
2021-06-30
2021-06-28
2021-06-28
2021-06-22
2021-06-19
2021-06-19
2021-06-18
2021-06-17
2021-06-15
2021-06-11
2021-06-11
2021-06-11
2021-06-11
2021-06-10
2021-06-10
2021-06-07
2021-06-07
2021-06-04
2021-06-03
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-05-24
2021-05-24
2021-05-20
2021-05-20
2021-05-20
2021-05-20
2021-05-19
2021-05-19
2021-05-18
2021-05-18
2021-05-13
2021-05-08
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-28
2021-04-23
2021-04-23
2021-04-23
2021-04-23
2021-04-23
2021-04-21
2021-04-21
2021-04-21
2021-04-16
2021-04-15
2021-04-14
2021-04-14
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-13
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
2021-04-12
api-id=27792