Skip to main content

统一下单

基本信息

接口名称:统一下单状  态:已完成
接口路径:POST /api/createTrade更新时间:2025-08-21 22:21:11
Mock地址:https://apimock.e-buychina.com/mock/713/api/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+商户号+店号+随机最大长度:32
最小长度: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
  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
  attachstring否扩展参数(发送给微信)Mock:@string
  payMethodarray是支付方式
    assetTypestring是资产类型,枚举。cash电子钱包最大长度:20
最小长度:1
Mock:@string
    payWaystring否assetType是cash,此必填。电子钱包支付必填,枚举渠道标识,枚举值。格式为:支付渠道,例如:WECHAT、ALIPAY、FOMOPAY 等最大长度:10
Mock:@string
    amountnumber否消费金额,单位元.必填Mock:@integer
    thirdUserIdstring否微信或者支付宝的openId
userId
最大长度:32
Mock:@string

返回数据

参数名称类型必填默认值备注其他信息
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是外部订单号最大长度:32
最小长度:32
Mock:@natural(32, 128)
  paidAmountstring是支付成功总金额。totalAmount - paidAmount > 0 表示用户需要另外支付金额最大长度:10
最小长度:1
Mock:@string
  userPaidstring是用户实付总金额最大长度:10
最小长度:1
Mock:@string
  merchantAmountstring是商户实收金额最大长度:10
最小长度:1
Mock:@string
  cashPaidobject否电子钱包用户支付结果
    paidAmountstring是此资产支付成功金额Mock:@string
    userAmountstring是用户实付金额Mock:@string
    merchantAmountstring是商户实收金额Mock:@string
    channelParamsstring是唤起渠道收银台报文,定制需求,要提前和 ebuy 约定
  qrCodeUrlstring否二维码最大长度:2000
最小长度:1
Mock:@imageData
  channelAppIdstring否支付渠道的 APP ID最大长度:32
最小长度:1
Mock:@natural(1, 32)
  redirectUrlstring否跳转地址最大长度:2000
最小长度:1
Mock:@string
  channelParamsobject否唤起渠道收银台报文,定制需求,要提前和 ebuy 约定

备注

金额处理逻辑:
仅支持一种支付(payMethod数组长度1),totalAmount必须填写,payMethod里面的amount可以不填写。如果2个都有,请保持一致。

变更历史

变更日期变更内容
2025-08-21
2025-03-17
2025-03-17
2025-03-17
2025-03-17
api-id=37506