聚合收銀臺訂單創建參數
調用地址
注:因銀網聯測試環境問題,微信錢包在測試環境下無法下單完成支付,下單后提示”sub mch id與sub appid不匹配”報錯即可。
自2024年1月16日起,請通過以下接口進行接入:
使用HTTP協議,POST方式提交。
URL(測試環境外網):https://test.wsmsd.cn/sit/api/v3/ccss/counter/order/special_create
URL(生產環境):https://s2.lakala.com/api/v3/ccss/counter/order/special_create
商戶需在微信商家后臺配置以下支付域名(原支付目錄),2023 年 9 月后入網的商戶可忽略此配置:
生產環境訂單域名:pay.lakala.com
測試環境訂單域名:pay.wsmsd.cn
請求參數
| 字段名 | 是否必輸 | 類型 | 長度 | 字段描述 | 示例 |
|---|---|---|---|---|---|
| out_order_no | M | String | 32 | 商戶訂單號 | 12345678 |
| merchant_no | M | String | 32 | 銀聯商戶號 | 822100041120005 |
| vpos_id | C | String | 32 | 交易設備標識,進件返回接口中的termId字段,非API接口進件請聯系業務員。 | 462621830268882944 |
| channel_id | C | String | 32 | 渠道號 (一般不用) | 24865454154 |
| total_amount | M | long | 12 | 訂單金額,單位:分 | 200 |
| order_efficient_time | M | String | 14 | 訂單有效期 格式yyyyMMddHHmmss,最大支持下單時間+7天 | 20210803141700 |
| notify_url | C | String | 128 | 訂單支付成功后商戶接收訂單通知的地址 http://xxx.xxx.com | |
| support_cancel | C | int | 1 | 是否支持撤銷 默認 0 不支持 busi_mode為“PAY-付款”不支持 撤銷 | (0 不支持 1支持) |
| support_refund | C | int | 1 | 是否支持退款 默認0 不支持 | (0 不支持 1支持) |
| support_repeat_pay | C | int | 1 | 是否支持“多次發起支付” 默認0 不支持 | (0 不支持 1支持) |
| out_user_id | C | String | 64 | 發起訂單方的userId,歸屬于channelId下的userId | |
| callback_url | C | String | 128 | 客戶端下單完成支付后返回的商戶網頁跳轉地址。 | |
| order_info | M | String | 64 | 訂單標題,在使用收銀臺掃碼支付時必輸入,交易時送往賬戶端 | |
| term_no | C | String | 32 | 結算終端號,合單場景必輸該字段 | |
| split_mark | C | String | 2 | 合單標識,“1”為合單,不填默認是為非合單 | |
| settle_type | C | String | 4 | 結算類型(非合單) (“0”或者空,常規結算方式) | |
| out_split_info | C | List<> | 拆單信息 合單標識為“1”時必傳該字段。,詳細字段見out_split_info字段說明 | ||
| counter_param | C | String | 1024 | json字符串 收銀臺展示參數 | {\“pay_mode\“ : \“ALIPAY\“} ,指定支付方式為支付寶 ALIPAY:支付寶 WECHAT:微信 UNION:銀聯云閃付 CARD:POS刷卡交易 LKLAT:線上轉帳 QUICK_PAY:快捷支付 EBANK:網銀支付 UNION_CC:銀聯支付 BESTPAY:翼支付 ONLINE_CARDLESS:線上外卡 JDBT:京東白條 ALIPAY_HK:支付寶香港錢包支付 若要指定支付方式為支付寶傳參格式: |
| counter_remark | C | String | 128 | 收銀臺備注 | |
| busi_type_param | C | String | 256 | 業務類型控制參數,jsonStr格式 | [{\“busi_type\“:\“UPCARD\“,\“params\“:{\“crd_flg\“:\“CRDFLG_D|CRDFLG_C|CRDFLG_OTH\“}},{\“busi_type\“:\“SCPAY\“,\“params\“:{\“pay_mode\“:\“ALIPAY\“,\“crd_flg\“:\“CRDFLG_D\“}}] 說明:UPCARD-刷卡,SCPAY-掃碼,CRDFLG_D-借記卡,CRDFLG_C-貸記卡,CRDFLG_OTH-不明確是借記卡還是貸記卡 pay_mode送參說明:ALIPAY-支付寶,WECHAT-微信,UNION-銀聯二維碼,DCPAY-數字貨幣,BESTPAY-翼支付 說明:一旦使用該字段,則增加限制,必須在指定限制范圍內支付。比如,只配置”busi_type”:”UPCARD”的參數而不配置”busi_type”:”SCPAY”的參數,則只能通過刷卡而不能通過掃碼完成支付 |
| sgn_info | C | list<> | 簽約協議號列表(字符串) | [“1234”,”2345”],不支持空列表[];列表中簽約協議號不能為空;列表中簽約協議號不能重復 | |
| product_id | C | String | 6 | 指定產品編號 (200809:線上外卡收銀臺) 注意:該字段默認不需要指定,特殊場景下使用,慎用 | |
| goods_mark | C | String | 商品信息標識 (1:含商品信息,不填默認不含商品信息) | ||
| goods_field | C | String | 2 | 商品信息域(good_mark送1時該域必填,否則不送。只有線上外卡業務上送該字段) 詳細字段見goods_field字段說明 | |
| order_scene_field | C | Object | 2 | 訂單場景域,特殊場景下需要上送 詳細字段見order_scene_field字段說明 | |
| age_limit | C | String | 1 | 0:不限年齡;1:年齡限制 | |
| repeat_pay_auto_refund | C | String | 1 | 0:重復支付后不自動退貨;1:重復支付后自動退貨 (默認不送為0),注意:請詳細了解字段場景后上送 需注意互斥條件:repeat_pay_auto_refund選擇“1”重復支付后自動退貨后,repeat_pay_notify僅支持選擇“0”重復支付訂單不通知 | |
| repeat_pay_notify | C | String | 1 | 0:重復支付訂單不通知;1:重復支付訂單通知 (默認不送為0) | |
| close_order_auto_refund | C | String | 1 | 0:不自動退貨;1:關閉訂單后支付成功觸發自動退貨 (默認不送為0)注意:請詳細了解字段場景后上送 | |
| shop_name | C | String | 64 | 網點名稱 | |
| inte_routing | C | String | 2 | 智能路由下單標識 1-是 0-否(默認不送為0)備注:需要在收銀臺管控臺配置聚合收銀臺小程序白名單 | |
| discount_code | C | String | 64 | 優惠碼(目前供線上國補下單使用) | |
| electrical_equipment_category | C | String | 128 | 支付寶優惠碼(目前優惠碼的地區:浙江、江蘇、上海、福建、重慶) | |
| trade_biz_tp | C | String | 16 | 線上業務通道類型 | 具體類型見補充枚舉 |
out_split_info字段說明
| 字段名 | 中文名稱 | 是否必填 | 類型 | 說明 |
|---|---|---|---|---|
| out_sub_order_no | 外部子訂單號 | M | String(32) | 商戶子訂單號 |
| merchant_no | 商戶號 | M | String(32) | 拉卡拉分配的銀聯商戶號 |
| term_no | 終端號 | M | String(32) | 拉卡拉分配的業務終端號 |
| amount | 金額 | M | String(12) | 單位分,整數型字符 |
| settle_type | 結算類型(合單) | C | String(4) | “0”或者空,常規結算方式 |
說明:
1)拆單信息域中商戶號不可重復;
2)交易層訂單金額必須是拆單信息域中各個子單的金額匯總之和;
3)對拆單信息域中每個結算商戶號和終端號的權限交易都必須通過,其中一個校驗失敗,則交易中止,失敗返回;
4)拆單域中子單條數最少兩條、最多20條,否則拒絕。
goods_field字段說明
| 字段名 | 中文名稱 | 是否必填 | 類型 | 說明 |
|---|---|---|---|---|
| goods_amt | 商品單價 | M | Long | 單位:分 |
| goods_num | 商品數量 | M | Integer | |
| goods_pricing_unit | 商品計價單位 | M | String(8) | 1-箱 2-件 3-瓶 4-個 |
| goods_name | 商品名稱 | M | String(128) | |
| te_platform_type | 交易電商平臺類型 | M | String(2) | 1-境內平臺 2-境外平臺 |
| te_platform_name | 交易電商平臺名稱 | M | String(256) | |
| goods_type | 交易商品類型 | M | String(8) | 1:服飾箱包 2:食品藥品 3:化妝品 4:電子產品 5:日用家居 7:航空機票 8:酒店住宿 9:留學教育 10:旅游票務 11:國際物流 12:國際租車 13:國際會議 14:軟件服務 15:醫療服務 16:通訊 17:休閑娛樂 |
order_scene_field字段說明
| 字段名 | 中文名稱 | 是否必填 | 類型 | 說明 |
|---|---|---|---|---|
| order_scene_type | 訂單場景類型 | M | String(16) | 訂單場景類型(按下述定義場景送值) HB_FQ:花唄分期場景 KL_FQ:考拉分期場景 |
| scene_info | 訂單場景信息 | C | String(1024) | 訂單場景信息(json字符串格式),不同的訂單場景類型需要上送的結構不一樣(詳見具體場景) |
HB_FQ場景
scene_info字段說明
| 字段名 | 中文名稱 | 是否必填 | 類型 | 說明 |
|---|---|---|---|---|
| hbFqNum | 花唄分期期數 | M | String | 支付寶花唄分期必送字段: 花唄分期數 3:3期 6:6期 12:12期 |
| hbFqSellerPercent | 賣家承擔手續費比例 | M | String | 支付寶花唄分期必送字段: 賣家承擔手續費比例,間連模式下只支持傳0。 |
JDBT場景
scene_info字段說明
| 字段名 | 中文名稱 | 是否必填 | 類型 | 說明 |
|---|---|---|---|---|
| LOCKPLAN | String | |||
| ->jdbtFqNum | 京東白條分期期數 | M | String | 京東白條分期數 3:3期,6:6期,12:12期 ,24:24期 |
trade_biz_tp字段說明
| 拉卡拉業務種類編碼 | 編碼含義 |
|---|---|
| 100001 | 虛擬商品購買 |
| 100002 | 預付費類賬戶充值 |
| 100003 | 實物消費 |
| 100004 | 航空商旅消費 |
| 100005 | 生活及商業服務消費 |
| 100006 | 其他商戶消費 |
| 100007 | 招投標保證金支付 |
| 100008 | 境外商品購買 |
| 100A01 | 實物商品租賃 |
| 100A03 | 單用途預付卡充值 |
| 100A06 | 商業服務消費 |
| 100A05 | 航旅交通服務 |
| 100A07 | 生活服務消費 |
| 100A08 | 個人經營服務 |
| 110001 | 公共事業繳費 |
| 110002 | 教育醫療繳費 |
| 110003 | 政府服務繳費 |
| 110004 | 公益捐款 |
| 110005 | 農林牧副漁收購 |
| 110006 | 政府服務 |
| 110007 | 薪資發放 |
| 110008 | 其他公共服務 |
| 110A01 | 水電煤氣繳費 |
| 110A02 | 稅費繳納 |
| 110A03 | 非營利性教育繳費 |
| 110A05 | 罰款繳納 |
| 110A06 | 路橋通行繳費 |
| 110A07 | 郵政繳費 |
| 110A08 | 電視賬單繳費 |
| 110A09 | 話費賬單繳費 |
| 110A10 | 寬帶賬單繳費 |
| 110A13 | 財政非稅收入 |
| 110A14 | 營利性教育培訓 |
| 110A15 | 公共交通 |
| 110A16 | 急救救援 |
| 110A17 | 物業繳費 |
| 110A18 | 國庫經收 |
| 110A19 | 供暖費繳納 |
| 110A20 | 廢棄物處理費用繳納 |
| 110A21 | 租金繳納 |
| 110A22 | 會員費用繳納 |
| 110A23 | 稅費退還 |
| 120001 | 其他金融付款 |
| 120002 | 其他金融收款 |
| 120003 | 基金購買 |
| 120004 | 保險選購 |
| 120005 | 投資理財 |
| 120006 | 信貸償還 |
| 120007 | 信用卡還款轉出 |
| 120008 | 基金贖回/返還/分紅 |
| 120009 | 保險理賠/分紅 |
| 120010 | 投資理財贖回/返還/分紅 |
| 120011 | 信貸發放 |
| 120012 | 信用卡還款轉入 |
| 120A01 | 基金理財產品申購 |
| 120A02 | 基金理財產品認購 |
| 120A03 | 非投資型保險費用繳納 |
| 120A05 | 商業眾籌 |
| 120A06 | 貴金屬投資買入 |
| 120A07 | 基金理財產品贖回 |
| 120A08 | 基金理財產品到期返還 |
| 120A09 | 認/申購失敗返還 |
| 120A10 | 基金理財產品分紅 |
| 120A11 | 保險理賠或退費 |
| 120A12 | 保險紅利發放或給付發放 |
| 120A13 | 貴金屬投資買出 |
| 120A16 | 融資租賃 |
| 120A19 | 投資型保險費用繳納 |
| 120A20 | 小貸公司貸款還款 |
| 120A21 | 保單貸款發放 |
| 120A22 | 其他保險資金代發 |
| 130001 | 支付賬戶充值 |
| 130002 | 支付賬戶回提 |
| 130003 | 銀行賬戶轉賬轉出 |
| 130004 | 其他賬戶充值 |
| 130005 | 銀行賬戶轉賬轉入 |
| 130006 | 其他賬戶回提 |
| 130A03 | 向他人支付賬戶轉賬 |
| 130A05 | 預付卡贖回 -個人贖回 |
| 130A06 | 預付卡贖回-單位贖回 |
| 130A08 | 測試驗證資金 |
| 130A09 | 薪酬福利發放 |
| 130A10 | 代發貨款 |
| 140001 | 商戶結算-交易資金結算 |
| 140002 | 營銷返現 |
| 140003 | 其他商戶結算 |
| 140A02 | 預付卡商戶結算 |
| 140A03 | 商戶收單資金提現 |
| 150A01 | 資金歸集 |
| 200000 | 對公業務 |
請求樣例
{
"req_data": {
"out_order_no": "KFPT20220714160009228907288",
"merchant_no": "8222900701106PZ",
"vpos_id": "587305941625155584",
"channel_id": "2021052614391",
"total_amount": "1",
"order_efficient_time": "20220714170009",
"notify_url": "http://run.mocky.io/v3/b02c9448-20a2-4ff6-a678-38ecab30161d",
"support_cancel": "0",
"support_refund": "1",
"support_repeat_pay": "1",
"busi_type_param": "[{\"busi_type\":\"UPCARD\",\"params\":{\"crd_flg\":\"CRDFLG_D|CRDFLG_C|CRDFLG_OTH\"}},{\"busi_type\":\"SCPAY\",\"params\":{\"pay_mode\":\"WECHAT\",\"crd_flg\":\"CRDFLG_D\"}}]",
"counter_param": "{\"pay_mode\":\"ALIPAY\"}",
"out_user_id": "",
"order_info": "自動化測試",
"extend_info": "自動化測試",
"callback_url": ""
},
"version": "3.0",
"req_time": "20220714160009"}復制
返回參數
| 字段名 | 是否必輸 | 類型 | 長度 | 字段描述 | 示例 |
|---|---|---|---|---|---|
| merchant_no | M | String | 32 | 銀聯商戶號 | |
| channel_id | M | String | 32 | ||
| out_order_no | M | String | 32 | 商戶訂單號 | |
| order_create_time | M | String | 32 | 創建訂單時間 | 訂單系統創建訂單的時間,格式yyyyMMddHHmmss |
| order_efficient_time | M | String | 32 | 訂單有效截至時間 | 格式yyyyMMddHHmmss |
| pay_order_no | M | String | 64 | 平臺訂單號 | 21070211012001970631000383039 |
| total_amount | M | long | 12 | 訂單金額,單位:分 | 200 |
| counter_url | M | String | 256 | 收銀臺地址信息 |
響應樣例
{
"msg": "操作成功",
"resp_time": "20210922181057",
"code": "000000",
"resp_data": {
"merchant_no": "8222900701106PZ",
"channel_id": "25",
"out_order_no": "KFPT20220714160009228907288",
"order_create_time": "20210922181056",
"order_efficient_time": "20210803141700",
"pay_order_no": "21092211012001970631000488056",
"counter_url": "http://q.huijingcai.top/b/pay?merchantNo=8221210594300JY&merchantOrderNo=08F4542EEC6A4497BC419161747A92FQ&payOrderNo=21092211012001970631000488056"
}
}復制
返回碼code一覽表
| msg | code |
|---|---|
| 成功 | 000000 |
