Skip to main content

扣款接口

基本信息

接口名称:线下扫码支付状  态:已完成
接口路径:POST /paas/micro/cashier/pay更新时间:2023-02-17 19:15:43
Mock地址:https://apimock.e-buychina.com/mock/587/paas/micro/cashier/pay

请求参数

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
    offLinePaymentstring否FACE_TO_FACE_PAYMENT产品码(当面付场景下,如果签约的是当面付快捷版,则传 OFFLINE_PAYMENT);其它支付宝当面付产品传 FACE_TO_FACE_PAYMENT;不传则默认使用FACE_TO_FACE_PAYMENTMock:@string
    sellerIdstring否默认为商户签约账号对应的支付宝用户ID收款账号,payway=alipay时使用该字段可以指定Mock:@string
  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
    pointsnumber否assetType是points,此必填。使用积分数Mock:@string
    cardCouponsstring否assetType是coupon、cashcard,此必填。卡或者券码列表,格式:"cardCoupon01|secret01" '|'分隔。secret01 是卡密或码密。最大长度:255
Mock:@string
    payWaystring否assetType是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:pay
timestampnumber是返回时间戳Mock:@timestamp
errorCodestring是错误码最大长度:50
Mock:@word
errorMessagestring是错误描述最大长度:50
Mock:@csentence
signTypestring是签名类型最大长度:20
Mock:sha256
signstring是签名值最大长度:500
Mock:@natural
contentobject是返回报文
  outTradeNostring是外部订单号最大长度:128
最小长度:32
Mock:@natural(32, 128)
  paidAmountstring是支付成功总金额最大长度:10
最小长度:1
Mock:@string
  userPaidstring是用户实付总金额最大长度:10
最小长度:1
Mock:@string
  merchantAmountstring是商户实收金额最大长度:10
最小长度:1
Mock:@string
  userInfoobject否用户信息
    userIdstring是用户idMock:@string
    platformstring是平台标识,枚举Mock:@string
  cardPaidobject否cashcard 支付结果
    paidAmountstring是此资产支付成功金额最大长度:10
最小长度:1
Mock:@string
    tenderCodestring否商户收入映射码最大长度:20
    discountCodestring否商户优惠映射码最大长度:20
    merchantAmountstring是商户实收金额最大长度:10
最小长度:1
    userAmountstring是用户实付金额最大长度:10
最小长度:1
    cardresultarray否卡使用结果
  couponPaidobject否coupon支付结果
    paidAmountstring是此资产支付成功金额最大长度:10
最小长度:1
Mock:@string
    tenderCodestring否商户收入映射码最大长度:20
Mock:@string
    discountCodestring否商户优惠映射码最大长度:20
Mock:@string
    merchantAmountstring是商户实收金额最大长度:10
最小长度:1
Mock:@string
    userAmountstring是用户实付金额最大长度:10
最小长度:1
Mock:@string
    couponresultarray否券使用结果
  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否商户收入映射码Mock:@string
    discountCodestring否商户优惠映射码Mock:@string

备注

变更历史

变更日期变更内容
2023-02-17
2023-02-17
2023-02-17
2023-02-17
2023-02-03
2023-02-03
2022-09-16
2021-12-13
2021-08-09
2021-07-09
2021-06-19
2021-06-17
2021-06-17
2021-06-16
2021-06-16
2021-06-15
2021-06-11
2021-06-11
2021-06-11
2021-06-09
2021-06-07
2021-06-07
2021-06-07
2021-06-07
2021-06-07
2021-06-07
2021-06-03
2021-06-03
2021-06-03
2021-06-03
2021-06-03
2021-06-03
2021-06-03
2021-05-28
2021-05-28
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-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
api-id=27797