美团企业版技术文档

# 企业版打车api文档

# 接入说明

  1. API_HOST:
  1. 美团企业版跳转三方h5页面参数说明
名称 位置 类型 必选 说明
controlGroupId url string 是 美团企业版管控组id
mtEntUserUniqueKey url string 是 美团企业版员工唯一标识
sqtTk url string 是 美团企业版token
tripSceneType url int 是 差旅子场景，5-前往机站，6-离开机站
tripartiteToken url string 是 三方认证token
  1. 公共参数 详见：公共参数说明-公共请求参数
  2. 后续问题排查时提供接口的响应结果的header中的M-TraceId，

# 1. 冒泡页自费升舱标记&车型过滤

# 接口说明

名称 描述
功能 用于标记美团企业版打车侧的自费升舱车型,并过滤美团打车侧不可用的车型
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/filterCarType
method dache.filter.car.type

# 请求参数

名称 位置 类型 必选 说明
controlGroupId body string 是 美团企业版管控组id,用于记录规则、申请单、报备单、用车方式等信息
mtEntUserUniqueKey body string 是 美团企业版用户唯一标识
sqtTk body string 是 美团企业版token
partnerId body string 是 供应商id
estimatedInfoList body List [ EstimatedInfoDTO] 是 预估信息

# EstimatedInfoDTO

名称 位置 类型 必选 说明
transportCapacityPartnerId body integer 是 运力服务商id.如 145
transportCapacityPartnerName body string 是 运力服务商名称。如:阳光出行
transportCapacityTypeId body integer 是 运力类型id。如:1454
transportCapacityTypeName body string 是 运力类型名称。如：豪华型
estimatedMileage body string 是 预估里程数.如 48.610
estimatedPriceInfoDTOS body List[EstimatedPriceInfoDTO] 是 预估价格信息.

# EstimatedPriceInfoDTO

名称 位置 类型 必选 说明
reserveType body string 是 预估类型。1.实时、2.预约
estimatedPrice body long 是 预约价格信息，单位，分

Body 请求参数

{
  "controlGroupId": "string",
  "mtEntUserUniqueKey":"",
  "sqtTk":"",
  "partnerId":"",
  "estimatedInfoList": [
    {
      "transportCapacityPartnerId": 0,
      "transportCapacityPartnerName": "string",
      "transportCapacityTypeId": 0,
      "transportCapacityTypeName": "string",
      "estimatedMileage": "string",
      "estimatedPriceInfoDTOS": [
        {
          "reserveType": "string",
          "estimatedPrice": 0
        }
      ]
    }
  ]
}

# 返回参数

名称 类型 必选 说明
status integer true 0-成功
msg String false 错误信息
data FilterCarTypeBody true

# FilterCarTypeBody

名称 类型 必选 说明
carTypeInfoDTOs List[MarkCarTypeUpgradeableDTO] true

# MarkCarTypeUpgradeableDTO

名称 类型 必选 说明
transportCapacityPartnerId integer true 运力服务商id.如 145
transportCapacityPartnerName string true 运力服务商名称。如:阳光出行
transportCapacityTypeId integer true 运力类型id。如:1454
transportCapacityTypeName string true 运力类型名称。如：豪华型
estimatedMileage string true 预估里程数.单位：m
selfPayingUpgradeCarType boolean true 是否是自费车型。非空
selfPayingRate string false 自费比例,0.15
estimatedPriceInfoDTOS List[EstimatedPriceInfoDTO] true 预估的价格信息。非空

# EstimatedPriceInfoDTO

名称 类型 必选 说明
reserveType string true 预估类型。1.实时、2.预约
estimatedPrice long ture 预约价格信息,单位分
selfPayingAmount long true 自费金额,单位：分

返回示例

成功

{
  "status": 0,
  "msg": "",
  "data": {
    "carTypeInfoDTOs": [
      {
        "transportCapacityPartnerId": 0,
        "transportCapacityPartnerName": "",
        "transportCapacityTypeId": 0,
        "transportCapacityTypeName": "string",
        "estimatedMileage": "",
        "selfPayingUpgradeCarType": true,
        "selfPayingRate": "",
        "estimatedPriceInfoDTOS": [
          {
            "reserveType": "",
            "estimatedPrice":0,
            "selfPayingAmount": 0
          }
        ]
      }
    ]
  }
}

# 2. 提单

# 接口说明

名称 描述
功能 用于美团企业版打车侧提单校验
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/createOrder
method dache.create.order

# 请求参数

名称 位置 类型 必选 说明
mtEntUserUniqueKey body string 是 美团企业版用户唯一标识
sqtTk body string 是
partnerId body string 是 供应商id
startLocationType body int 是 起点交通枢纽类型，0-普通地点，1-机站，2-火车站，3-港口
endLocationType body int 是 终点交通枢纽类型，0-普通地点，1-机站，2-火车站，3-港口
lngOrg body double 是 起点经度,示例：37.533995
latOrg body double 是 起点纬度
lngArr body double 是 到达经度
latArr body double 是 到达维度
useCarTime body long 是 用车时间
submitCarTypes body List[SubmitCarTypeDTO] 是 车型信息
controlGroupId body string 是 美团企业版管控组id,用于记录规则、申请单、报备单、用车方式等信息

# SubmitCarTypeDTO

名称 位置 类型 必选 说明
transportCapacityPartnerId body integer 是 运力服务商id
transportCapacityTypeId body integer 是 运力类型id
selfPayingUpgradeCarType body boolean 是 自费升舱标识

Body 请求参数

{
  "lngOrg": 0,
  "latOrg": 0,
  "lngArr": 0,
  "latArr": 0,
  "useCarTime": 0,
  "mtEntUserUniqueKey":"",
  "sqtTk":"",
  "partnerId":"",
  "startLocationType": 1,
  "endLocationType": 0,
  "submitCarTypes": [
    {
      "transportCapacityPartnerId": 0,
      "transportCapacityTypeId": 0,
      "selfPayingUpgradeCarType": true
    }
  ],
  "controlGroupId": "string"
  }

# 返回结果

名称 类型 必选 说明
status integer true 0-成功,非0-失败，从data里获取失败展示信息
msg String false 错误信息
data CarSubmitOrderVerifyBody true 提单响应

# CarSubmitOrderVerifyBody

名称 类型 必选 说明
supplyOrderId string true 美团企业版供给本地订单号
blockWindowDTO BlockWindowDTO true 弹窗信息,提单校验不通过时返回弹窗展示信息，提单通过时为空

# BlockWindowDTO

名称 类型 必选 说明
title string false 弹窗标题
buttonShowList List[ButtonShowDTO] false 按钮列表
text string false 弹窗文案

# ButtonShowDTO

名称 类型 必选 说明
name string false 按钮名称
index integer false 按钮顺序
needJump boolean false 是否需要跳转
jumpUrl string false 跳转url
needHighlight boolean false 是否高亮，true-是

返回示例

成功

{
  "status": 0,
  "msg": "",
  "data": {
    "supplyOrderId": ""
  }
}

失败

{
  "status": 499,
  "msg": "",
  "data": {
    "blockWindowDTO": {
      "title": "温馨提示",
      "buttonShowList": [
        {
          "name": "查看用车规则",
          "index": 0,
          "needJump": true,
          "jumpUrl": "",
        }
      ],
      "text": "今日考勤异常不可打车"
    }
  }
}

# 3. 待支付页获取用户自费金额及管控费用明细

# 接口说明

名称 描述
功能 用于美团企业版打车自费金额和是否展示管控逻辑
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/getPayDetail
method dache.get.pay.detail

# 请求参数

名称 类型 必选 说明
mtEntUserUniqueKey body string 是
sqtTk body string 是
partnerId body string 是
bizOrderId string true 供应商订单id
supplyOrderId string 是 美团企业版提单接口返回的供给订单id
personPayPercent string true 个人支付比例,0.85
useCarTime long 是 用车时间
orderAmount long 是 订单金额，单位：分
afterTripPrice long 是 附加费，单位：分

Body 请求参数

{
  "bizOrderId": "string",
  "supplyOrderId": "string",
  "mtEntUserUniqueKey":"",
  "sqtTk":"",
  "partnerId": "string",
  "personPayPercent":0.85,
  "useCarTime":0,
  "orderAmount":0,
  "afterTripPrice":0
}

# 返回结果

名称 类型 必选 说明
status integer true 0-成功
msg String false 错误信息
data PayDetailBody false

# PayDetailBody

名称 类型 必选 说明
userPaymentType integer true 支付方式，0-需要个人支付；1-全单企业支付；2-无法判定当前订单是否可全单企业支付
amountControlLogic integer true 是否存在限额类的管控逻辑，0-不存在，不需要展示半页弹窗，1-存在，需要展示半页弹窗
entPayAmount long true 企业支付金额，单位：分
staffPayAmount long true 个人支付金额，单位：分
feeSystemAmountList List[FeeSystemAmount] false 费用模式可用额度
amountLimitList List[LimitAmount] false 管控限额

# FeeSystemAmount

名称 类型 必选 说明
consumeAmountOwner string true 消费额度归属人
consumeAmount long true 消费额度可用金额,单位：分

# LimitAmount

名称 类型 必选 说明
type integer true 费用类型1-每单限额，2-用车申请单可用限额，3-今日可用限额，5-自费升舱限额，6-费用制度可用额度
typeValue string true 费用类型展示文案，"每单限额"，"今日可用限额"，"用车申请单可用限额"，"自费升舱限额"，"费用制度可用额度"
limitAmount long true 管控额度,单位：分
needLimit boolean true 是否需要管控,不需要则不展示这一项，为true时展示

返回示例

成功

{
  "status": 0,
  "msg": "",
  "data": {
    "userPaymentType": 0,
    "amountControlLogic": 0,
    "entPayAmount": 0,
    "staffPayAmount": 0,
    "feeSystemAmountList": [
    {
      "consumeAmountOwner": "string",
      "consumeAmount": 0
    }
   ],
  "amountLimitList": [
    {
      "type": 0,
      "typeValue": "string",
      "limitAmount": 0,
      "needLimit": true
    }
  ],
  "entPayPercent": "string"
  }
}

# 4. 订单状态回传api

# 接口说明

名称 描述
功能 用于向美团企业版打车回传订单状态
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/orde/change
method dache.order.change

# 请求参数

名称 类型 必选 说明
bizOrderId string true 供应商订单号
partnerId string true 供应商id
supplyOrderId string true 美团企业版提单接口返回的供给订单id
type string true 事件类型，司机接单，司机到达，发送账单，订单取消（需要识别出司机取消，无人接单取消，主动撤单取消）等事件
time long true 事件时间
extendJson map true 扩展数据
riskParam RiskParam true 司机违规数据

# RiskParam

名称 类型 必选 说明
riskType int true 风险类型 1-里程异常、2-价格异常，3-附加费异常
riskTips string true 风险提示文案

Body 请求参数

{
  "time": 0,
  "type": "",
  "bizOrderId": "string",
  "partnerId": "string",
  "supplyOrderId": "string",
  "riskParam": {
    "riskType": 1,
    "riskTips": ""
  }
}

# 响应参数

名称 类型 必选 说明
status integer true 0-成功
msg String false 错误信息
data boolean true

返回示例

成功

{
  "status": 0,
  "msg": "",
  "data": true
}

# 5. 订单支付

# 接口说明

名称 描述
功能 用于支付美团企业版打车订单
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/orde/pay
method dache.order.pay

# 请求参数

名称 类型 必选 说明
mtEntUserUniqueKey body string 是
sqtTk body string 是
partnerId string true 供应商id
bizOrderId string true 订单id
supplyOrderId string true 美团企业版提单接口返回的供给订单id
orderAmount long true 订单金额，单位：分
expenseType integer true 费用类型，1, "行程费"，2, "取消费"，3, "预付费"

Body 请求参数

{
  "bizOrderId": "string",
  "partnerId": "string",
  "sqtTk": "string",
  "supplyOrderId": "string",
  "mtEntUserUniqueKey":"",
  "orderAmount":0,
  "expenseType":1
}

# 响应参数

名称 类型 必选 说明
status integer true 0-请求成功,非0-请求失败
message String false 错误信息
data PayReault false 请求结果

# PayReault

名称 类型 必选 说明
needCashier boolean false 是否需要跳转收银台
cashierUrl string false 如需跳转收银台支付，此处返回收银台url

返回示例

静默支付

{
  "status": 0,
  "message": "",
  "data": {
      "needCashier":false
    }
}

需要跳转收银台

{
  "status": 0,
  "message": "",
  "data": {
    "needCashier":true,
    "cashierUrl": ""
    }
}

失败

{
  "status": 499,
  "message": "企业余额不足"
  
}

# 6. 支付结果通知

# 接口说明

名称 描述
功能 用于美团企业版打车订单支付通知
HTTP方法 POST
请求方 美团企业版
响应方 第三方平台
url $API_HOST/dache/pay/notify
method dache.pay.notify

# 请求参数

名称 类型 是否必填 示例 说明
bizOrderId string 是 306092209006387202 供应商单号
supplyOrderId String 是 1592988152350002 美团企业版提单返回的供给单号
payStatus String 是 10 10, "未支付",20, "已支付",30, "退款中",31, "部分退款",32, "全额退款"
payTime Long 是 1609430400000 变更时间，13位时间戳
extInfoMap Map<String,String> 否 三方定制额外推送参数，需要双方协商确定
 {
  "bizOrderId": "",
  "supplyOrderId": "694866826080335",
  "payStatus": "20",
  "payTime": 1621222800000,
  "extInfoMap": {}
 }

# 响应参数

名称 类型 必选 说明
status integer true 0-请求成功,非0-请求失败
msg String false 错误信息
data object false 请求结果

业务响应

{
    "status": 0,//当且仅当status=0,被认为下游接收通知成功
    "msg": "成功",
    "data": {}
}

{
    "status": 1,//status!=0,均认为下游接收通知失败
    "msg": "参数校验失败",
    "data": {}
}

# 7. 订单信息查询

# 接口说明

名称 描述
功能 用于订单支付信息查询
HTTP方法 POST
请求方 第三方平台
响应方 美团企业版平台
url $API_HOST/dache/orde/query
method dache.order.query

# 请求参数

名称 类型 必选 说明
mtEntUserUniqueKey body string 是
sqtTk body string 是
partnerId body string 是
bizOrderId string true 订单id
supplyOrderId string true 美团企业版提单接口返回的供给订单id

Body 请求参数

{
  "bizOrderId": "string",
  "sqtTk": "string",
  "partnerId": "string",
  "mtEntUserUniqueKey":"",
  "supplyOrderId":""
}

# 响应参数

名称 类型 必选 说明
status integer true 0-请求成功,非0-请求失败
msg String false 错误信息
data OrderDetailInfo false 请求结果

# OrderDetailInfo

名称 类型 必选 说明
payInfo PayInfoDTO false 请求结果

# PayInfoDTO

名称 类型 必选 说明
totalPayAmount long 是 1500
totalRefundAmount long 是 1500
totalRealAmount long 是 0
entPayAmount long 是 3540
staffPayAmount long 是 0
entRefundAmount long 是 0
staffRefundAmount long 是 0
payStatus Integer 是 32
payStatusName String 是 全额退款
payTime long 否 13位时间戳

返回示例

成功

{
  "status": 0,
  "message": "",
  "data": {
    "totalPayAmount": 3924,
    "totalRefundAmount": 0,
    "totalRealAmount": 3924,
    "payStatus": 20,
    "payStatusName": "已支付",
    "entPayAmount": 3924,
    "staffPayAmount": 0,
    "entRefundAmount": 0,
    "staffRefundAmount": 0,
    "payTime": 0
    }
}
上次更新: 4/22/2024, 4:15:08 PM

← 外卖API →