直連主掃調(diào)用地址-請(qǐng)求報(bào)文

卡拉合伙人 5個(gè)月前 ( 11-20 ) 232

調(diào)用地址

使用HTTP協(xié)議,POST方式提交。

測(cè)試環(huán)境:https://test.wsmsd.cn/sit/api/v3/dcp/trans/preorder

生產(chǎn)環(huán)境:https://s2.lakala.com/api/v3/dcp/trans/preorder

請(qǐng)求報(bào)文

字段名中文名稱是否必填類型說(shuō)明
merchant_no商戶號(hào)MString(32)拉卡拉分配的商戶號(hào)
term_no終端號(hào)MString(32)拉卡拉分配的業(yè)務(wù)終端號(hào)
out_trade_no商戶交易流水號(hào)MString(32)商戶系統(tǒng)唯一,同一個(gè)商戶號(hào)下不要重復(fù)。
account_type錢包類型MString(32)微信:WECHAT 支付寶:ALIPAY  微企付:ENTPAY
trans_type接入方式MString(2)

41:NATIVE(微信Native,支付寶Native)

51:JSAPI(微信公眾號(hào)支付,支付寶服務(wù)窗支付)

61:APP支付(微企付APP支付)

71:小程序支付(微信小程序支付、支付寶小程序支付、微企付小程序支付)

81:H5支付(微企付H5支付)

total_amount金額MString(12)單位分,整數(shù)型字符
location_info地址位置信息MObject地址位置信息,風(fēng)控要求必送
subject訂單標(biāo)題CString(128)標(biāo)題,用于簡(jiǎn)單描述訂單或商品主題 (賬戶端控制該字段長(zhǎng)度,間連方式下該字段小于42位)
notify_url商戶通知地址CString(128)商戶通知地址,如上傳,則按此地址通知商戶
remark備注CString(128)商戶交易備注信息
store_id商戶門店編號(hào)(商戶自定義)CString(32)商戶門店編號(hào)
store_name商戶門店名稱CString(64)商戶門店名稱
acc_busi_fields賬戶端業(yè)務(wù)信息域CObject賬戶端業(yè)務(wù)信息域

location_info字段說(shuō)明

字段名中文名稱是否必填類型說(shuō)明
request_ip請(qǐng)求方IP地址CString(64)請(qǐng)求方的IP地址,格式如36.45.36.95
request_ip、base_station、location必須上送一個(gè),建議優(yōu)先送request_ip
base_station基站信息CString(128)客戶端設(shè)備的基站信息(主掃時(shí)基站信息使用該字段)
location緯度經(jīng)度CString(32)商戶終端的地理位置,存在必填 格式:緯度,經(jīng)度,+表示北緯、東經(jīng),-表示南緯、 西經(jīng),精度最長(zhǎng)支持小數(shù)點(diǎn)后9位。舉例:+37.123456789,-121.123456789

支付寶支付情況下accBusiFields字段說(shuō)明

字段名中文名稱必選
備注
user_id買家在支付寶的用戶idMString(64)支付寶的buyer_user_id
timeout_express預(yù)下單有效時(shí)間CString(2)預(yù)下單的訂單的有效時(shí)間,以分鐘為單位。如果在有效時(shí)間內(nèi)沒(méi)有完成付款,則在賬戶端該訂單失效。如果不上送,以賬戶端訂單失效時(shí)間為準(zhǔn)。 建議不超過(guò)15分鐘。不傳值則默認(rèn)5分鐘。
extend_params業(yè)務(wù)擴(kuò)展參數(shù)CString(1024)支付寶花唄業(yè)務(wù)擴(kuò)展參數(shù) ,見(jiàn)說(shuō)明
goods_detail商品詳情CString(6000)訂單包含的商品列表信息,Json格式。
alipay_store_id商戶門店編號(hào)CString(32)支付寶收單上送,送到支付寶store_id參數(shù)中
query_options支付寶查詢選項(xiàng)CList<>支付寶收單上送

支付寶extendParams字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名說(shuō)明必選
備注
sysServiceProviderId服務(wù)商的PIDCString(64)系統(tǒng)商編號(hào),該參數(shù)作為系統(tǒng)商返傭數(shù)據(jù)提取的依據(jù),請(qǐng)?zhí)顚懴到y(tǒng)商簽約協(xié)議的 PID
hbFqNum花唄分期期數(shù)MString(5)支付寶花唄分期必送字段: 花唄分期數(shù) 3:3期 6:6期 12:12期
hbFqSellerPercent賣家承擔(dān)手續(xù)費(fèi)比例MString(3)支付寶花唄分期必送字段: 賣家承擔(dān)收費(fèi)比例,商家承擔(dān)手續(xù)費(fèi)傳入100,用戶承擔(dān)手續(xù)費(fèi)傳入0,僅支持傳入100、0兩種,其他比例暫不支持 100:代表商家貼息 0:代表用戶承擔(dān)手續(xù)費(fèi)
dynamicTokenOutBizNo外部業(yè)務(wù)號(hào)CString(128)填寫alipay.marketing.facetoface.decode.use接口中上送的sence_no字段,類型為String, 枚舉值20170718xxxxxxxx
foodOrderType點(diǎn)餐場(chǎng)景類型CString點(diǎn)餐場(chǎng)景類型:QR_FOOD_ORDER(點(diǎn)餐先付), P_QR_FOOD_ORDER(點(diǎn)餐后付), TAKE_OUT(餐飲外賣), SELF_PICK(門店自提)
presetPayTool支卡通相關(guān)參數(shù)CString(256)業(yè)務(wù)可根據(jù)場(chǎng)景是否需要疊加營(yíng)銷,選擇以下兩種傳參方式。疊加營(yíng)銷場(chǎng)景:forceUse-N(支卡通可疊加營(yíng)銷,使用支卡通金額以異步通知為準(zhǔn))屏蔽營(yíng)銷場(chǎng)景:forceUse-Y(支卡通不可疊加營(yíng)銷,使用支卡通金額為傳入的amount,單位元) 示例:”{"MERCHANTCARD_ZKT":[{"amount":"0.01","forceUse":"N"}]}”

支付寶businessParams字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名說(shuō)明必選
備注
scenePayLinkInfo支卡通相關(guān)參數(shù)CString(256)所有代扣訂單都必須傳該參數(shù)支卡通相關(guān)參數(shù),傳固定字符串。bizScene和subBizScene由支付寶側(cè)BD提供。 {"bizProduct":"ZCARD","bizScene":"支付寶側(cè)分配","subBizScene":"支付寶側(cè)分配","bizMode":"MERCHANT_ORDER"}

支付寶goodsDetail字段說(shuō)明

中文名稱說(shuō)明必選
備注
goods_id
MString(32)商品的編號(hào)
alipay_goods_id
CString(32)支付寶定義的統(tǒng)一商品編號(hào)
goods_name
MString(256)商品名稱
quantity
MString(12)商品數(shù)量
price
MString(12)單位為元
goods_category
CString(24)商品類目
categories_tree
CString(128)商品類目樹(shù),從商品類目根節(jié)點(diǎn)到葉子節(jié)點(diǎn)的類目 id 組成,類目 id 值使用|分 割
body
CString(512)商品描述信息
show_url
CString(256)商品的展示地址

微信支付情況下accBusiFields字段說(shuō)明

字段名中文名稱必選
備注
sub_appid子商戶公眾賬號(hào)IDCString(32)微信分配的子商戶公眾賬號(hào)ID,sub_appid(即微信小程序支付-71、公眾號(hào)支付-51),此參數(shù)必傳,只對(duì)微信支付有效 工行數(shù)字錢包情況下,該字段上送工行的openId 拉卡拉錢包情況下,該字段上送LAKALA的userId
sub_openid用戶標(biāo)識(shí)CString(64)用戶在子商戶sub_appid下的唯一標(biāo)識(shí),sub_openid,(即微信小程序支付-71、眾號(hào)支付-51),此參數(shù)必傳,只對(duì)微信支付有效
timeout_express預(yù)下單有效時(shí)間CString(2)預(yù)下單的訂單的有效時(shí)間,以分鐘為單位。如果在有效時(shí)間內(nèi)沒(méi)有完成付款,則在賬戶端該訂單失效。如果不上送,以賬戶端訂單失效時(shí)間為準(zhǔn)。 建議不超過(guò)15分鐘。不傳值則默認(rèn)5分鐘。
detail商品詳情CString(1024)單品優(yōu)惠功能字段,詳見(jiàn)下文說(shuō)明
goods_tag訂單優(yōu)惠標(biāo)記CString(32)訂單優(yōu)惠標(biāo)記,微信平臺(tái)配置的商品標(biāo)記,用于優(yōu)惠券或者滿減使用,accountType為WECHAT時(shí),可選填此字段
attach附加域CString(128)附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù)。商戶定制字段,直接送到賬戶端。
scene_info場(chǎng)景信息CString(256)該字段常用于線下活動(dòng)時(shí)的場(chǎng)景信息上報(bào),支持上報(bào)實(shí)際門店信息,商戶也可以按需求自己上報(bào)相關(guān)信息。

微信detail字段說(shuō)明

字段名中文名稱必選
備注
cost_price
CString(12)1.商戶側(cè)一張小票訂單可能被分多次支付,訂單原 價(jià)用于記錄整張小票的交易金額。 2.當(dāng)訂單原價(jià)與支付金額不相等,則不享受優(yōu)惠。 3.該字段主要用于防止同一張小票分多次支付,以 享受多次優(yōu)惠的情況,正常支付訂單不必上傳此參 數(shù)。 如:608800
receipt_id
CString(12)商家小票 ID
goods_detail
MString(1024)單品信息,使用 Json 數(shù)組格式提交

微信goods_detail字段說(shuō)明

字段名中文名稱必選
備注
goods_id
MString(32)由半角的大小寫字母、數(shù)字、中劃線、下劃線中的一種或幾種組成。如“商品編碼”
wxpay_goods_id
CString(32)微信支付定義的統(tǒng)一商品編號(hào)
goods_name
CString(256)商品的實(shí)際名稱
quantity
MString(12)用戶購(gòu)買的數(shù)量
price
MString(12)單位為:分。如果商戶有優(yōu)惠,需傳輸商戶優(yōu)惠后的單價(jià)

銀聯(lián)支付情況下accBusiFields字段說(shuō)明

字段名中文名稱必選
備注
user_id用戶idMString(64)
timeout_express預(yù)下單有效時(shí)間CString(2)預(yù)下單的訂單的有效時(shí)間,以分鐘為單位。如果在有效時(shí)間內(nèi)沒(méi)有完成付款,則在賬戶端該訂單失效。如果不上送,以賬戶端訂單失效時(shí)間為準(zhǔn)。 建議不超過(guò)15分鐘。不傳值則默認(rèn)5分鐘。
acq_addn_data_order_info銀聯(lián)訂單信息CString(600)銀聯(lián)單品營(yíng)銷訂單信息
acq_addn_data_goods_info銀聯(lián)商品信息CString(6000)銀聯(lián)單品營(yíng)銷商品信息
front_url銀聯(lián)前臺(tái)通知地址CString(256)收款方向銀聯(lián)推送訂單時(shí)上送的前臺(tái)通知地址(僅允許為外網(wǎng)地址),用戶完成支付點(diǎn)擊,“返回”后,銀聯(lián)通過(guò)瀏覽器POST請(qǐng)求到該地址。 當(dāng)transType為JSAPI,payMode為UQRCODEPAY時(shí),可選填此字段
front_fail_url銀聯(lián)失敗交易前臺(tái)通知地址CString(256)收款方向銀聯(lián)推送訂單時(shí)上送的失敗交易前臺(tái)通知地址(僅允許為外網(wǎng)地址),用戶支付過(guò)程中交易失敗,點(diǎn)擊“返回”后,銀聯(lián)通過(guò)瀏覽器GET請(qǐng)求到該地址。 當(dāng)transType為JSAPI,payMode為UQRCODEPAY時(shí),可選填此字段,需與frontUrl同時(shí)出現(xiàn),未上送默認(rèn)為frontUrl的值

微企付情況下accBusiFields字段說(shuō)明

字段名中文名稱必選
備注
purchaser_type指定付款類型C
指定付款類型(個(gè)人付款卡號(hào):INDIVIDUAL_CARD 個(gè)人付款人姓名:INDIVIDUAL_NAME企業(yè)名稱:ENTERPRISE)
channel_options

String渠道選項(xiàng),指定收銀臺(tái)支持的付款渠道
payer付款方信息CString付款方信息
memo
Cstring(1, 128)附言,只支持空格、中文、數(shù)字、英文大小寫、下劃線、全角半角的連字符、逗號(hào)和句號(hào)
detail商品信息Marray[object] (1,5)商品信息,建議上送不多于5種商品信息
attach訂單附加信息Cstring(1, 255)訂單附加信息,附加數(shù)據(jù),在查詢API中原樣返回,可作為自定義參數(shù)使用
risk_control風(fēng)控信息CString
front_callback_url前端回跳地址MString前端回跳地址,支付結(jié)果通知,包含所有前端類型的通知地址
area_code地區(qū)編號(hào)C
地區(qū)編號(hào),詳細(xì)地區(qū)編號(hào)信息可參照:微企付官方文檔
profit_allocation_flag分賬標(biāo)識(shí)C
(NO_PROFIT_ALLOCATION:無(wú)需分賬,profit_allocation_flag不傳時(shí)默認(rèn)為無(wú)需分賬API_PROFIT_ALLOCATION:需要分賬)

微企付channelOptions字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

include_bank_snames與exclude_ban_snames不可同時(shí)填寫

字段名中文名稱必選
備注
include_bank_snames指定銀行簡(jiǎn)稱列表Carray[String]銀行簡(jiǎn)稱,指定收銀臺(tái)不支持的銀行列表,例如平安銀行為:PAB
exclude_ban_snames指定排除銀行簡(jiǎn)稱列表Carray[String]銀行簡(jiǎn)稱,指定收銀臺(tái)不支持的銀行列表,例如平安銀行為:PAB
include_pay_channels指定支付渠道Carray[String]指定支付渠道(個(gè)人銀行卡:INDIVIDUAL企業(yè)網(wǎng)銀:ENTERPRISE微信零錢:WX_BALANCE)
exclude_pay_channels指定排除支付渠道Carray[String]指定排除支付渠道(個(gè)人銀行卡:INDIVIDUAL企業(yè)網(wǎng)銀:ENTERPRISE微信零錢:WX_BALANCE)

微企付payer字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名中文名稱必選
備注
payer_name
Cstring(1, 256)當(dāng)purchaser_type為ENTERPRISE時(shí),該字段必須設(shè)置為付款企業(yè)名稱,當(dāng)purchaser_type為INDIVIDUAL_NAME時(shí),該字段必須設(shè)置為指定個(gè)人付款人姓名

微企付detail字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名中文名稱必選
備注
good_name
Mstring(1, 255)商品名稱
good_number
Minteger(int32)商品數(shù)量
good_amount
Minteger(int32)單位為:分。商品金額

微企付riskControl字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名中文名稱必選
備注
device_id
Cstring(1, 32)設(shè)備號(hào),終端設(shè)備號(hào)(門店號(hào)或收銀設(shè)備ID)
payer_client_ip
Mstring(1, 45)用戶終端IP,用戶端實(shí)際ip,示例值:14.17.22.32
payer_ua
Mstring(1, 1000)用戶UA,瀏覽器User-Agent
pick_type
CString提貨方式(自提:SELF_PICK 物流:LOGISTICS 改歸屬:CHANGE_OWNER)
pick_description
Cstring(1, 256)提貨描述

微企付frontCallbackUrl字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名中文名稱必選
備注
android_url
Mstring(1,256)APP-Android 支付完成前端回跳url(app下單填寫)
ios_url
Mstring(1,1024)App-IOS 支付完成前端回跳url(app下單填寫)
mp_path
Mstring(1, 1024)Mp 支付完成前端回跳小程序路徑,路徑和參數(shù)內(nèi)容由開(kāi)發(fā)者設(shè)置,受環(huán)境限制目前騰訊微企付在 iOS 里使用 wx.navigateBackMiniProgram ,在 Android 里使用wx.navigateToMiniProgram 回跳到你的小程序,建議路徑為訂單詳情或結(jié)果頁(yè),onShow 時(shí)查詢最新的訂單狀態(tài)按需展示(小程序下單填寫)
mp_appid
Mstring(1, 64)Mp 支付完成前端回跳小程序appid(小程序下單填寫)
mp_username
Cstring(1, 64)Mp 支付完成前端回跳小程序原始id(小程序下單填寫)
mp_urlscheme
Cstring(1, 64)Mp 支付完成前端回跳小程序urlscheme(小程序下單填寫)
h5_url
Cstring(1,1024)微信h5頁(yè)面回跳地址,支付成功后回跳到指定的頁(yè)面(H5下單填寫)

響應(yīng)報(bào)文

字段名中文名稱是否必填類型說(shuō)明
out_trade_no商戶請(qǐng)求流水號(hào)MString(64)請(qǐng)求報(bào)文中的商戶請(qǐng)求流水號(hào)
settle_channel_type結(jié)算渠道類型MString(16)

微信:WECHAT 支付寶:ALIPAY  拉卡拉:LAKALA

trade_no平臺(tái)交易流水號(hào)MString(32)平臺(tái)交易流水號(hào)
acc_resp_fields賬戶端返回信息域CObject賬戶端返回信息域

微信(71-小程序)微信(51-JSAPI)場(chǎng)景下accRespFields域

字段名中文名稱是否必填類型說(shuō)明
prepay_id預(yù)下單IdMString(32)預(yù)支付交易會(huì)話ID
pay_sign支付簽名信息MString(256)簽名
app_id小程序idMString(32)商戶注冊(cè)具有支付權(quán)限的小程序成功后即可獲得小程序id
time_stamp時(shí)間戳MString(32)當(dāng)前的時(shí)間
nonce_str隨機(jī)字符串MString(32)隨機(jī)字符串
package訂單詳情擴(kuò)展字符串MString(128)
sign_type簽名方式MString(32)簽名類型,支持RSA

支付寶(41-NATIVE)場(chǎng)景下返回accRespFields域

字段名中文名稱是否必填類型說(shuō)明
code二維碼信息MString(256)商戶可用此參數(shù)自定義去生成二維碼后展示出來(lái)進(jìn)行掃碼支付
code_image二維碼圖片內(nèi)容MString(256)商戶收款二維碼圖片。Base64編碼,暫無(wú)

支付寶(51-JSAPI)場(chǎng)景下返回accRespFields域

字段名中文名稱是否必填類型說(shuō)明
prepay_id預(yù)下單IdMString(32)預(yù)支付交易會(huì)話ID

銀聯(lián)二維碼(51-JSAPI)場(chǎng)景下返回acc_resp_fields域

字段名中文名稱是否必填類型說(shuō)明
redirect_url銀聯(lián)JS支付重定向地址MString(256)銀聯(lián)JS支付返回重定向地址

微企付(71-小程序 61-app 81-H5)場(chǎng)景下返回accRespFields域

字段名中文名稱是否必填類型說(shuō)明
code跳轉(zhuǎn)鏈接MString(64)
payer微企付付款方信息Cstring(app支付返回)
prepayId預(yù)下單IdMString(32)預(yù)支付交易會(huì)話ID
miniProgram小程序信息CString(小程序支付返回)

微企付payer字段說(shuō)明(該字段類型為String,非object,值為json字符串,需要加轉(zhuǎn)義)

字段名中文名稱必選
備注
payer_name
Cstring(1, 256)當(dāng)purchaser_type為ENTERPRISE時(shí),該字段必須設(shè)置為付款企業(yè)名稱,當(dāng)purchaser_type為INDIVIDUAL_NAME時(shí),該字段必須設(shè)置為指定個(gè)人付款人姓名
out_payer_id
Cstring(1, 128)平臺(tái)付款方Id,即合作平臺(tái)的用戶id,付款方在平臺(tái)的唯一id,只支持英文大小寫以及數(shù)字
payer_acct_last4
Cstring(4,4)付款方付款銀行后四位

示例

請(qǐng)求報(bào)文:

{
    "req_time": "20220207142827",
    "version": "3.0",
    "req_data": {
        "merchant_no": "82229005812059B",
        "term_no": "A0104508",
        "out_trade_no": "KFPT20220207142827914820665",
        "account_type": "WECHAT",
        "trans_type": "41",
        "total_amount": "1",
        "location_info": {
            "request_ip": "127.0.0.1",
            "base_station": "00 6361   58130",
            "location": "+37.123456789,-121.123456789"
        },
        "subject": "自動(dòng)化測(cè)試",
        "notify_url": "http://run.mocky.io/v3/b02c9448-20a2-4ff6-a678-38ecab30161d",
        "remark": "",
        "store_id": "",
        "store_name": "",
        "acc_busi_fields": {
            "sub_appid": "wx9ef39b708f164d",
            "sub_openid": "olpr-0sDrT5GmLUgUenVcDPo",
            "goods_tag": "",
            "attach": "",
            "timeout_express": "",
            "detail": ""
        }
    }
}

復(fù)制

響應(yīng)報(bào)文:

{
    "code": "DCP00000",
    "msg": "成功",
    "resp_time": "20220207142828",
    "resp_data": {
        "out_trade_no": "KFPT20220207142827914820665",
        "trade_no": "2022020733210004680036",
        "settle_channel_type": "WECHAT",
        "acc_resp_fields": {
            "code": "weixin://wxpay/bizpayurl?pr=iKq5yFPzz",
            "code_image": null,
            "prepay_id": "wx07142828576915c9ba21d215d93faf0000",
            "app_id": null,
            "pay_sign": null,
            "time_stamp": null,
            "nonce_str": null,
            "sign_type": null
        }
    }
}


The End