swagger.yaml 9.18 KB
Newer Older
wangp's avatar
wangp committed
1
definitions:
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
  models.CashierNoticeInput:
    properties:
      channel_id:
        description: 渠道号
        type: string
      merchant_no:
        description: 结算商户号
        type: string
      order_create_time:
        description: 订单创建时间
        type: string
      order_efficient_time:
        description: 订单有效时间
        type: string
      order_info:
        description: 订单描述
        type: string
      order_status:
        description: 订单状态
        type: string
      order_trade_info:
        type: object
      out_order_no:
        description: 商户订单号
        type: string
      pay_order_no:
        description: 支付订单号
        type: string
      split_info:
        type: object
      term_no:
        description: 结算终端号
        type: string
      total_amount:
        description: 订单金额,单位:分
        type: integer
      trans_merchant_no:
        description: 交易商户号
        type: string
      trans_term_no:
        description: 交易终端号
        type: string
    type: object
wangp's avatar
wangp committed
45 46 47
  models.PlaceAnOrderParamInput:
    properties:
      app_id:
48
        description: wxAppId source code 2 小程序支付时必传、同时小程序支付必须关联了商户号支付
wangp's avatar
wangp committed
49 50
        type: string
      attach_info:
51 52 53 54
        description: 附加信息
        type: string
      auth_codes:
        description: LAKALA签约协议号列表
wangp's avatar
wangp committed
55 56
        type: string
      customer:
57
        description: 顾客信息
wangp's avatar
wangp committed
58 59
        type: string
      dynamic_id:
60
        description: 顾客手机条码的内容
wangp's avatar
wangp committed
61 62
        type: string
      goods_des:
63
        description: 商品描述
wangp's avatar
wangp committed
64 65
        type: string
      goods_detail:
66
        description: 商品详情
wangp's avatar
wangp committed
67 68
        type: string
      goods_price:
69
        description: 商品金额,个位为分
wangp's avatar
wangp committed
70 71
        type: number
      is_serve:
72
        description: 0直连模式  1服务商模式
wangp's avatar
wangp committed
73 74
        type: integer
      notice_url:
75
        description: 客户端回调的url
wangp's avatar
wangp committed
76 77
        type: string
      open_id:
78
        description: 此参数 支付类型是 JS API 的时候 必传
wangp's avatar
wangp committed
79 80
        type: string
      operator:
81
        description: 操作员
wangp's avatar
wangp committed
82 83
        type: string
      pay_type:
84
        description: 支付渠道 1:微信 2:支付宝 3:拉卡拉 4:收钱吧
wangp's avatar
wangp committed
85 86
        type: integer
      platform_info:
87
        description: 平台信息
wangp's avatar
wangp committed
88 89
        type: string
      platform_type:
90
        description: 平台类型 1:saas 2:shop 3:shop mobile 4:收银台 6:bk_shop 7:bk_shop_mobile
wangp's avatar
wangp committed
91 92
        type: integer
      quit_url:
93
        description: 返回按钮 可用于用户付款中途退出并返回到该参数指定的商户网站地址, 支付方式为 支付宝手机网站时 必传(尽量传)
wangp's avatar
wangp committed
94 95
        type: string
      return_url:
96
        description: 用户在完成支付后,会根据商户在请求支付API中传入的前台回跳地址return_url自动跳转return_url地址页面(必传)
wangp's avatar
wangp committed
97 98
        type: string
      source_code:
99 100 101
        description: 支付方式 1:微信Native 2:微信小程序 3:微信内支付 4:h5 跳微信 5:支付宝(web)-扫码或登录支付宝账户
          6:alipay(mobile) 7:alipay(app) 9:B2C 10:bk支付宝web 11:bk 支付宝手机 15:快捷支付(银行卡)
          16:微信小程序-必康自营 17:微信JASPI-必康自营
wangp's avatar
wangp committed
102 103
        type: integer
      store_sn:
104
        description: 商户门店编号
wangp's avatar
wangp committed
105 106
        type: string
      sub_mchid:
107
        description: 通过进件接口申请的支付商户号、这是由微信生成并下发的
wangp's avatar
wangp committed
108 109
        type: string
      wap_name:
110
        description: WAP网站名称, 支付方式为微信MWEB时 必传
wangp's avatar
wangp committed
111 112
        type: string
      wap_url:
113
        description: WAP网站URL地址, 支付方式为微信MWEB时 必传
wangp's avatar
wangp committed
114 115
        type: string
    type: object
116
  models.ScanNoticeInput:
wangp's avatar
wangp committed
117
    properties:
118 119
      acc_activity_id:
        description: 活动ID
wangp's avatar
wangp committed
120
        type: string
121 122
      acc_discount_amount:
        description: 账户端优惠金额
wangp's avatar
wangp committed
123
        type: string
124 125
      acc_mdiscount_amount:
        description: 商户侧优惠金额(账户端)
wangp's avatar
wangp committed
126
        type: string
127 128
      acc_other_discount_amount:
        description: 账户端其它优惠金额(待上线)
wangp's avatar
wangp committed
129
        type: string
130 131
      acc_settle_amount:
        description: 账户端结算金额
wangp's avatar
wangp committed
132
        type: string
133 134
      acc_trade_no:
        description: 账户端交易订单号
wangp's avatar
wangp committed
135
        type: string
136 137
      account_type:
        description: 钱包类型
wangp's avatar
wangp committed
138
        type: string
139 140
      bank_type:
        description: 付款银行
wangp's avatar
wangp committed
141
        type: string
142 143 144 145 146
      card_type:
        description: 银行卡类型
        type: string
      hb_fq_pay_info:
        description: 花呗分期支付信息(未上线)
wangp's avatar
wangp committed
147
        type: object
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
      log_no:
        description: 拉卡拉对账单流水号
        type: string
      merchant_no:
        description: 商户号
        type: string
      out_trade_no:
        description: 商户交易流水号
        type: string
      payer_amount:
        description: 付款人实付金额
        type: string
      remark:
        description: 备注
        type: string
      settle_merchant_no:
        description: 结算商户号
        type: string
      settle_term_no:
        description: 结算终端号
wangp's avatar
wangp committed
168
        type: string
wangp's avatar
wangp committed
169
      total_amount:
170
        description: 订单金额
wangp's avatar
wangp committed
171
        type: string
172 173 174 175 176 177 178 179 180 181 182 183 184 185
      trade_no:
        description: 拉卡拉交易流水号
        type: string
      trade_status:
        description: 交易状态
        type: string
      trade_time:
        description: 交易完成时间
        type: string
      user_id1:
        description: 用户标识1
        type: string
      user_id2:
        description: 用户标识2
wangp's avatar
wangp committed
186 187
        type: string
    type: object
wangp's avatar
wangp committed
188 189 190 191 192 193
info:
  contact: {}
  description: 采购订单项目
  title: 谛宝多多平台
  version: "1.0"
paths:
194
  /api/v1/pay/cashier_notice:
wangp's avatar
wangp committed
195 196 197
    post:
      consumes:
      - application/json
198
      description: 拉卡拉统一支付回调(收银台)
wangp's avatar
wangp committed
199 200 201 202 203 204
      parameters:
      - description: 参数
        in: body
        name: body
        required: true
        schema:
205
          $ref: '#/definitions/models.CashierNoticeInput'
wangp's avatar
wangp committed
206
      - description: 语言类型 zh-CN简体中文 en-US英文 ja-JP日文 默认中文
wangp's avatar
wangp committed
207 208 209 210 211 212 213 214
        in: header
        name: language
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ""
215
      summary: 拉卡拉统一支付回调(收银台)
wangp's avatar
wangp committed
216
      tags:
217
      - 拉卡拉统一支付回调
wangp's avatar
wangp committed
218
  /api/v1/pay/order_state/{orderId}:
219
    get:
wangp's avatar
wangp committed
220 221
      consumes:
      - application/json
222
      description: 拉卡拉支付查询
wangp's avatar
wangp committed
223
      parameters:
224 225
      - description: 订单号
        in: path
wangp's avatar
wangp committed
226
        name: orderId
wangp's avatar
wangp committed
227
        required: true
228
        type: string
wangp's avatar
wangp committed
229
      - description: 语言类型 zh-CN简体中文 en-US英文 ja-JP日文 默认中文
wangp's avatar
wangp committed
230 231 232 233 234 235 236 237
        in: header
        name: language
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ""
238
      summary: 拉卡拉支付查询
wangp's avatar
wangp committed
239
      tags:
240
      - 拉卡拉支付查询
wangp's avatar
wangp committed
241 242
  /api/v1/pay/refund/{orderId}/{operator}/{money}:
    put:
wangp's avatar
wangp committed
243 244
      consumes:
      - application/json
wangp's avatar
wangp committed
245
      description: 拉卡拉退款
wangp's avatar
wangp committed
246
      parameters:
wangp's avatar
wangp committed
247 248 249
      - description: 退款号:原对账单流水号
        in: path
        name: orderId
wangp's avatar
wangp committed
250
        required: true
wangp's avatar
wangp committed
251 252 253 254 255 256 257 258 259 260 261
        type: string
      - description: 操作人/退款原因
        in: path
        name: operator
        required: true
        type: string
      - description: 退款金额,个位为分
        in: path
        name: money
        required: true
        type: string
wangp's avatar
wangp committed
262
      - description: 语言类型 zh-CN简体中文 en-US英文 ja-JP日文 默认中文
wangp's avatar
wangp committed
263 264 265 266 267 268 269 270
        in: header
        name: language
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ""
wangp's avatar
wangp committed
271
      summary: 拉卡拉退款
wangp's avatar
wangp committed
272
      tags:
wangp's avatar
wangp committed
273 274
      - 拉卡拉退款
  /api/v1/pay/scan_notice:
275 276 277
    post:
      consumes:
      - application/json
wangp's avatar
wangp committed
278
      description: 拉卡拉统一支付回调(聚合扫码)
279 280 281 282 283 284
      parameters:
      - description: 参数
        in: body
        name: body
        required: true
        schema:
wangp's avatar
wangp committed
285
          $ref: '#/definitions/models.ScanNoticeInput'
286 287 288 289 290 291 292 293 294
      - description: 语言类型 zh-CN简体中文 en-US英文 ja-JP日文 默认中文
        in: header
        name: language
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ""
wangp's avatar
wangp committed
295
      summary: 拉卡拉统一支付回调(聚合扫码)
296
      tags:
wangp's avatar
wangp committed
297 298
      - 拉卡拉统一支付回调
  /api/v1/pay/unified_order:
299 300 301
    post:
      consumes:
      - application/json
wangp's avatar
wangp committed
302
      description: 拉卡拉统一支付
303 304 305 306 307 308
      parameters:
      - description: 参数
        in: body
        name: body
        required: true
        schema:
wangp's avatar
wangp committed
309
          $ref: '#/definitions/models.PlaceAnOrderParamInput'
310 311 312 313 314 315 316 317 318
      - description: 语言类型 zh-CN简体中文 en-US英文 ja-JP日文 默认中文
        in: header
        name: language
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: ""
wangp's avatar
wangp committed
319
      summary: 拉卡拉统一支付
320
      tags:
wangp's avatar
wangp committed
321
      - 拉卡拉统一支付
wangp's avatar
wangp committed
322 323 324 325 326 327
securityDefinitions:
  ApiKeyAuth:
    in: header
    name: Authorization
    type: apiKey
swagger: "2.0"