最新更新時(shí)間:2020.03.05 版本說明
用戶申請(qǐng)使用服務(wù)時(shí),商戶可通過此接口申請(qǐng)創(chuàng)建微信支付分訂單。
?免確認(rèn)模式下創(chuàng)單成功返回的state是DOING:進(jìn)行中;state_description:USER_CONFIRM:用戶確認(rèn)。
?如免確認(rèn)模式下返回的是CREATED:商戶已創(chuàng)建服務(wù)訂單,則為創(chuàng)單失敗。
?API參數(shù)涉及時(shí)間參數(shù)時(shí)需注意,可能由于商戶時(shí)鐘系統(tǒng)和微信支付分時(shí)鐘系統(tǒng),取當(dāng)前時(shí)間存在一定誤差。可能導(dǎo)致在API調(diào)用出現(xiàn)失敗情況。因此商戶在傳入時(shí)間參數(shù)時(shí)需預(yù)留一定誤差時(shí)間
適用對(duì)象:直連商戶
請(qǐng)求URL:https://api.mch.weixin.qq.com/v3/payscore/serviceorder
請(qǐng)求方式:POST
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)需在請(qǐng)求URL傳參
body 指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
商戶服務(wù)訂單號(hào) | out_order_no | string[1,32] | 是 | body 商戶系統(tǒng)內(nèi)部服務(wù)訂單號(hào)(不是交易單號(hào)),要求此參數(shù)只能由數(shù)字、大小寫字母_-|*組成,且在同一個(gè)商戶號(hào)下唯一。詳見[商戶訂單號(hào)]。 示例值:1234323JKHDFE1243252 |
應(yīng)用ID | appid | string[1,32] | 是 | body 微信為調(diào)用商戶分配的公眾賬號(hào)ID,接口傳入的appid應(yīng)該為公眾號(hào)的appid和小程序的appid(在mp.weixin.qq.com申請(qǐng)的)或APP的appid(在open.weixin.qq.com申請(qǐng)的)。 校驗(yàn)規(guī)則: 1、該appid需要與調(diào)用接口的商戶號(hào)(即請(qǐng)求頭中的商戶號(hào))有綁定關(guān)系,若未綁定,可參考該指引完成綁定(商家商戶號(hào)與AppID賬號(hào)關(guān)聯(lián)管理); 2、該appid需要在支付分系統(tǒng)中先進(jìn)行配置 示例值:wxd678efh567hg6787 |
服務(wù)ID | service_id | string[1,32] | 是 | body該服務(wù)ID有本接口對(duì)應(yīng)產(chǎn)品的權(quán)限。 示例值:500001 |
服務(wù)信息 | service_introduction | string[1,20] | 是 | body 服務(wù)信息,用于介紹本訂單所提供的服務(wù) ,當(dāng)參數(shù)長(zhǎng)度超過20個(gè)字符時(shí),報(bào)錯(cuò)處理。 示例值:某某酒店 |
+后付費(fèi)項(xiàng)目 | post_payments | array | 否 | body后付費(fèi)項(xiàng)目列表,最多包含100條付費(fèi)項(xiàng)目。 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
+后付費(fèi)商戶優(yōu)惠 | post_discounts | array | 否 | body后付費(fèi)商戶優(yōu)惠列表,最多包含30條商戶優(yōu)惠。 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
+服務(wù)時(shí)間段 | time_range | object | 是 | body 服務(wù)時(shí)間范圍 |
+服務(wù)位置 | location | object | 否 | body服務(wù)位置信息 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
+訂單風(fēng)險(xiǎn)金 | risk_fund | object | 是 | body訂單風(fēng)險(xiǎn)金信息 |
商戶數(shù)據(jù)包 | attach | string[1,256] | 否 | body商戶數(shù)據(jù)包可存放本訂單所需信息,需要先urlencode后傳入。 當(dāng)商戶數(shù)據(jù)包總長(zhǎng)度超出256字符時(shí),報(bào)錯(cuò)處理。 注意:創(chuàng)單接口的商戶數(shù)據(jù)包和支付分訂單的對(duì)賬單中返回的商戶數(shù)據(jù)包實(shí)際上是不一致的,只和查單、回調(diào)中返回的商戶數(shù)據(jù)包一致。 示例值:Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald |
商戶回調(diào)地址 | notify_url | string[1,255] | 是 | body商戶接收用戶確認(rèn)訂單和付款成功回調(diào)通知的地址。 示例值:https://api.test.com |
用戶標(biāo)識(shí) | openid | string[1,128] | 條件選填 | body微信用戶在商戶對(duì)應(yīng)appid下的唯一標(biāo)識(shí)。 免確認(rèn)訂單:必填 需確認(rèn)訂單:不填 獲取用戶openid指引 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否需要用戶確認(rèn) | need_user_confirm | bool | 否 | body枚舉值: false:免確認(rèn)訂單 true:需確認(rèn)訂單 默認(rèn)值true 示例值:true |
{
"out_order_no": "1234323JKHDFE1243252",
"appid": "wxd678efh567hg6787",
"service_id": "500001",
"service_introduction": "某某酒店",
"post_payments": [
{
"name": "就餐費(fèi)用服務(wù)費(fèi)",
"amount": 4000,
"description": "就餐人均100元服務(wù)費(fèi):100/小時(shí)",
"count": 1
}
],
"post_discounts": [
{
"name": "滿20減1元",
"description": "不與其他優(yōu)惠疊加"
}
],
"time_range": {
"start_time": "20091225091010",
"end_time": "20091225121010"
},
"location": {
"start_location": "嗨客時(shí)尚主題展餐廳",
"end_location": "嗨客時(shí)尚主題展餐廳"
},
"risk_fund": {
"name": "ESTIMATE_ORDER_COST",
"amount": 10000,
"description": "就餐的預(yù)估費(fèi)用"
},
"attach": "Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald",
"notify_url": "https://api.test.com",
"openid": "oUpF8uMuAJO_M2pxb1Q9zNjWeS6o",
"need_user_confirm": true
}
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 調(diào)用接口提交的公眾賬號(hào)ID。 示例值:wxd678efh567hg6787 |
商戶號(hào) | mchid | string[1,32] | 是 | 調(diào)用接口提交的商戶號(hào)。 示例值:1230000109 |
商戶服務(wù)訂單號(hào) | out_order_no | string[1,32] | 是 | 調(diào)用接口提交的商戶服務(wù)訂單號(hào)。 示例值:1234323JKHDFE1243252 |
服務(wù)ID | service_id | string[1,32] | 是 | 調(diào)用該接口提交的服務(wù)ID。 示例值:500001 |
服務(wù)信息 | service_introduction | string[1,20] | 是 | 服務(wù)信息,用于介紹本訂單所提供的服務(wù)。 示例值:某某酒店 |
服務(wù)訂單狀態(tài) | state | string[1,32] | 是 | 表示當(dāng)前單據(jù)狀態(tài)。 枚舉值: |
訂單狀態(tài)說明 | state_description | string (32) | 否 | 對(duì)服務(wù)訂單"進(jìn)行中"狀態(tài)的附加說明。 1、USER_CONFIRM:用戶確認(rèn) 2、MCH_COMPLETE:商戶完結(jié) 示例值:MCH_COMPLETE |
+后付費(fèi)項(xiàng)目 | post_payments | array | 否 | 后付費(fèi)項(xiàng)目列表,最多包含100條付費(fèi)項(xiàng)目。 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
+后付費(fèi)商戶優(yōu)惠 | post_discounts | array | 否 | 后付費(fèi)商戶優(yōu)惠,最多包含30條付費(fèi)項(xiàng)目。 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
+訂單風(fēng)險(xiǎn)金 | risk_fund | object | 是 | 訂單風(fēng)險(xiǎn)金信息 |
+服務(wù)時(shí)間段 | time_range | object | 是 | 服務(wù)時(shí)間范圍 |
+服務(wù)位置 | location | object | 否 | 服務(wù)使用信息。 如果傳入,用戶側(cè)則顯示此參數(shù)。 |
商戶數(shù)據(jù)包 | attach | string[1,256] | 否 | 商戶數(shù)據(jù)包,可存放本訂單所需信息,需要先urlencode后傳入,總長(zhǎng)度不大于256字符,超出報(bào)錯(cuò)處理。 示例值:Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald |
商戶回調(diào)地址 | notify_url | string[1,255] | 否 | 商戶接收用戶確認(rèn)訂單或扣款成功回調(diào)通知的地址。 示例值:https://api.test.com |
微信支付服務(wù)訂單號(hào) | order_id | string[1,64] | 是 | 微信支付服務(wù)訂單號(hào),每個(gè)微信支付服務(wù)訂單號(hào)與商戶號(hào)下對(duì)應(yīng)的商戶服務(wù)訂單號(hào)一一對(duì)應(yīng)。 示例值:15646546545165651651 |
跳轉(zhuǎn)微信側(cè)小程序訂單數(shù)據(jù) | package | string[1,300] | 是 | 用戶跳轉(zhuǎn)到微信側(cè)小程序訂單數(shù)據(jù),需確認(rèn)模式特有API中調(diào)起支付分-確認(rèn)訂單傳入。該數(shù)據(jù)一小時(shí)內(nèi)有效。 示例值:DJIOSQPYWDxsjdldeuwhdodwxasd_dDiodnwjh9we |
{
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"out_order_no": "1234323JKHDFE1243252",
"service_id": "500001",
"service_introduction": "某某酒店",
"state": "CREATED",
"state_description": "MCH_COMPLETE",
"post_payments": [
{
"name": "就餐費(fèi)用服務(wù)費(fèi)",
"amount": 4000,
"description": "就餐人均100元服務(wù)費(fèi):100/小時(shí)",
"count": 1
}
],
"post_discounts": [
{
"name": "滿20減1元",
"description": "不與其他優(yōu)惠疊加"
}
],
"risk_fund": {
"name": " ESTIMATE_ORDER_COST",
"amount": 10000,
"description": "就餐的預(yù)估費(fèi)用"
},
"time_range": {
"start_time": "20091225091010",
"end_time": "20091225121010"
},
"location": {
"start_location": "嗨客時(shí)尚主題展餐廳",
"end_location": "嗨客時(shí)尚主題展餐廳"
},
"attach": "Easdfowealsdkjfnlaksjdlfkwqoi&wl3l2sald",
"notify_url": "https://api.test.com",
"order_id": "15646546545165651651",
"package": " DJIOSQPYWDxsjdldeuwhdodwxasd_dDiodnwjh9we "
}
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 5開頭的狀態(tài)碼都為系統(tǒng)問題,請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 根據(jù)錯(cuò)誤提示,傳入正確參數(shù) |
403 | NO_AUTH | 商戶信息不合法 | 登錄商戶平臺(tái)核對(duì),傳入正確信息 |
429 | FREQUENCY_LIMITED | 頻率超限 | 請(qǐng)求量不要超過接口調(diào)用頻率限制 |
400 | INVALID_REQUEST | 請(qǐng)求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 請(qǐng)確認(rèn)相同單號(hào)是否使用了不同的參數(shù) |
404 | ORDER_NOT_EXIST | 訂單不存在 | 確認(rèn)入?yún)ⅲ瑐魅胝_單據(jù) |
400 | INVALID_ORDER_STATE | 單據(jù)狀態(tài)錯(cuò)誤 | 確認(rèn)操作是否符合流程 |
400 | ORDER_CANCELED | 單據(jù)已取消 | 當(dāng)前狀態(tài)無(wú)需操作 |
400 | ORDER_DONE | 訂單已完成 | 當(dāng)前狀態(tài)無(wú)需操作 |