聚合收銀臺收銀臺訂單創建 (全報文加密)

拉卡拉支付 5個月前 ( 11-20 ) 270

調用地址

自2024年1月16日起,請通過以下接口進行接入:

使用HTTP協議,POST方式提交。

URL(測試環境外網):https://test.wsmsd.cn/sit/api/v3/ccss/counter/order/special_create_encry

URL(生產環境):https://s2.lakala.com/api/v3/ccss/counter/order/special_create_encry

商戶需在微信商家后臺配置以下支付域名(原支付目錄),2023 年 9 月后入網的商戶可忽略此配置

生產環境訂單域名:pay.lakala.com

測試環境訂單域名:pay.wsmsd.cn

請求參數

字段名是否必輸類型長度字段描述示例
out_order_noMString32商戶訂單號12345678
merchant_noMString32商戶號822100041120005
vpos_idCString32交易設備標識(非合單場景必輸該字段),進件返回接口中的termId字段,非API接口進件請聯系業務員。462621830268882944
channel_idCString32渠道號 (一般不用)24865454154
busi_modeCString8業務模式: ACQ-收單 PAY-付款 不填,默認為“ACQ-收單”
total_amountMlong12訂單金額,單位:分。JPY和KRW的單位是元,即200日元,填“200"200
order_efficient_timeMString14訂單有效期 格式yyyyMMddHHmmss,最大支持下單時間+2天20210803141700
notify_urlCString128訂單支付成功后商戶接收訂單通知的地址 http://xxx.xxx.com
support_cancelCint1是否支持撤銷 默認 0 不支持
busi_mode為“PAY-付款”不支持 撤銷
(0 不支持 1支持)
support_refundCint1是否支持退款 默認0 不支持(0 不支持 1支持)
support_repeat_payCint1是否支持“多次發起支付” 默認0 不支持(0 不支持 1支持)
out_user_idCString64發起訂單方的userId,歸屬于channelId下的userId
callback_urlCString128客戶端下單完成支付后返回的商戶網頁跳轉地址。
order_infoMString64訂單標題,在使用收銀臺掃碼支付時必輸入,交易時送往賬戶端
term_noCString32結算終端號,合單場景必輸該字段
split_markCString2合單標識,“1”為合單,不填默認是為非合單
settle_typeCString4結算類型(非合單) (“0”或者空,常規結算方式) 注意:該字段會影響結算方式,慎用。(調用拉卡拉分賬接口需必傳)
out_split_infoCList<>
拆單信息
合單標識為“1”時必傳該字段。,詳細字段見out_split_info字段說明

counter_paramCString1024收銀臺展示參數{\“pay_mode\“ : \“ALIPAY\“} ,指定支付方式為支付寶
ALIPAY:支付寶
WECHAT:微信
UNION:銀聯云閃付
CARD:POS刷卡交易

LKLAT:線上轉帳

QUICK_PAY:快捷支付
EBANK:網銀支付
UNION_CC:銀聯支付
BESTPAY:翼支付
HB_FQ:花唄分期
UNION_FQ:銀聯聚分期

ONLINE_CARDLESS:線上外卡

若要指定支付方式為支付寶傳參格式:
{\“pay_mode\“ : \“ALIPAY\“}

counter_remarkCString128收銀臺備注
busi_type_paramCString256業務類型控制參數,jsonStr格式[{\“busi_type\“:\“UPCARD\“,\“params\“:{\“crd_flg\“:\“CRDFLG_D|CRDFLG_C|CRDFLG_OTH\“}},{\“busi_type\“:\“SCPAY\“,\“params\“:{\“pay_mode\“:\“ALIPAY\“,\“crd_flg\“:\“CRDFLG_D\“}},{\“busi_type\“:\“DCPAY\“,\“params\“:{\“pay_mode\“:\“DCPAY\“}}]
說明:UPCARD-刷卡,SCPAY-掃碼,DCPAY-數幣 CRDFLG_D-借記卡,CRDFLG_C-貸記卡,CRDFLG_OTH-不明確是借記卡還是貸記卡
pay_mode送參說明:ALIPAY-支付寶,WECHAT-微信,UNION-銀聯二維碼,DCPAY-數字貨幣,BESTPAY-翼支付
說明:一旦使用該字段,則增加限制,必須在指定限制范圍內支付。比如,只配置”busi_type”:”UPCARD”的參數而不配置”busi_type”:”SCPAY”的參數,則只能通過刷卡而不能通過掃碼完成支付
sgn_infoClist<>
簽約協議號列表(字符串)[“1234”,”2345”],不支持空列表[];列表中簽約協議號不能為空;列表中簽約協議號不能重復
transfer_fieldCObject
轉賬支付時可以上送,詳細字段見transfer_field字段說明
identity_infoCString128實名信息 json字符串{\“identityNo\“:\“32000000000000000X\“,\“name\“:\“張三\“,\“identityType\“:"01\“}
證件類型 01:身份證 02:軍官證 03:護照 04:港澳證(港澳居民來往內地通行證/回鄉證) 05:臺胞證 06:警官證 07:士兵證 99:其它證件
目前僅支持證件類型為01-身份證
product_idCString6指定產品編號 (200809:線上外卡收銀臺) 注意:該字段默認不需要指定,特殊場景下使用,慎用。
goods_markCString2商品信息標識 (1:外卡交易商品下單,不填默認不送商品信息)
goods_fieldCString2048json字符串,商品信息域(good_mark送1時該域必填,否則不送。只有線上外卡業務上送該字段) 詳細字段見goods_field字段說明
order_scene_fieldCObject
訂單場景域,特殊場景下需要上送 詳細字段見order_scene_field字段說明
trans_currencyCString
幣種(三位數字),參見國標,默認值:156 詳細見trans_currency字段說明特定場景下使用
discount_codeC
String
64優惠碼(目前供線上國補下單使用)
customer_infoCString1024
用戶信息域(目前供線上國補下單使用)示例:{\“certifTp\“:\“22222\“,\“certifId\“:\“1111\“,\“customerNm\“:\“333\“,\“smsCode\“:\“888\“,\“pin\“:\“777\“,\“cvn2\“:\“444\“,\“expired\“:\“555\“,\“phoneNo\“:\“666\“}
electrical_equipment_categoryCString128
支付寶優惠碼(目前優惠碼的地區:浙江、江蘇、上海、福建、重慶)

out_split_info字段說明

字段名中文名稱是否必填類型說明
out_sub_order_no外部子訂單號MString(32)商戶子訂單號
merchant_no商戶號MString(32)拉卡拉分配的商戶號
term_no終端號MString(32)拉卡拉分配的業務終端號
amount金額MString(12)單位分,整數型字符
settle_type(計劃中)結算類型(合單)CString(4)“0”或者空,常規結算方式
sub_remark子單備注CString(64)子單備注

transfer_field字段說明

字段名中文名稱是否必填類型說明
acc_out_no付款人賬號CString(32)付款人賬號 上送則校驗
acc_out_name付款人姓名CString(64)付款人姓名 上送則校驗
additional轉賬附言CString(128)轉賬附言 上送則校驗

goods_field字段說明

字段名中文名稱是否必填類型說明
goods_amt商品單價MLong單位:分
goods_num商品數量MInteger
goods_pricing_unit商品計價單位MString(8)1-箱 2-件 3-瓶 4-個
goods_name商品名稱MString(128)
te_platform_type交易電商平臺類型MString(2)1-境內平臺 2-境外平臺
te_platform_name交易電商平臺名稱MString(256)
goods_type交易商品類型MString(8)1:服飾箱包
2:食品藥品
3:化妝品
4:電子產品
5:日用家居
7:航空機票
8:酒店住宿
9:留學教育
10:旅游票務
11:國際物流
12:國際租車
13:國際會議
14:軟件服務
15:醫療服務
16:通訊
17:休閑娛樂

order_scene_field字段說明

字段名中文名稱是否必填類型說明
order_scene_type訂單場景類型MString(16)訂單場景類型(按下述定義場景送值)

ONLINE_WILDCARD:線上外卡場景

KL_FQ:考拉分期場景

encrypted_field加密域CString(516)加密域信息(json字符串格式),不同的訂單場景類型需要上送的結構不一樣(詳見具體場景)
scene_info訂單場景信息CString(1024)訂單場景信息(json字符串格式),不同的訂單場景類型需要上送的結構不一樣(詳見具體場景)

ONLINE_WILDCARD場景

encrypted_field字段說明

字段名中文名稱是否必填類型說明
billingAddress賬單地址CString賬單地址(json字符串結構體)
–> houseNumberOrName門牌號或姓名MString賬單地址 - 門牌號或姓名
–> street街道MString賬單地址 - 街道
–> city城市MString賬單地址 - 城市
–> country國家MString賬單地址 - 國家
–> street街道MString賬單地址 - 街道
–> stateOrProvince州或省CString賬單地址 - 州或省
–> postalCode郵編MString賬單地址 - 郵編
mobilePhone注冊手機號CString用戶注冊手機號
email注冊郵箱CString注冊郵箱
recipientFirstName收件人名MString收件人名
recipientLastName收件人姓MString收件人姓

scene_info字段說明

字段名中文名稱是否必填類型說明
userId用戶idMString用戶id
userCreateDate用戶創建時間MString消費者在商戶網站創建賬號的日期 (yyyyMMddHHmmss)
recipientStreet收件人街道MString收件人街道
recipientCity收件人城市MString收件人城市
recipientStateOrProvince收件人州 省MString收件人州 省
recipientCountry收件人國家MString收件人國家

trans_currency字段說明

幣種名稱數字代碼
人民幣156
美元840
英鎊826
歐元978
日元392
加元124
澳元036
韓元410
港元344

KL_FQ場景

encrypted_field字段說明

字段名中文名稱是否必填類型說明
UNFQ銀聯聚分期CStringjson字符串結構體
–> cardNo卡號CString卡號
–> bankNm銀行簡稱CString銀行簡稱
HBINCREASE花唄提額(僅供花唄時使用,即order_scene_type為KL_FQ時的花唄場景,或者直接是HB_FQ)CStringjson字符串結構體
–> identityNo身份證CString身份證
–> name姓名CString姓名
–> projectName項目名稱CString項目名稱
–> fqOption分期選項(用戶付息-user,商戶貼息-merchant)CString分期選項(用戶付息-user,商戶貼息-merchant)
–> fqNum分期期數(僅支持3、6、12)CString分期期數
–> secondaryMerchantId支付寶子商戶號CString支付寶子商戶號

scene_info字段說明

字段名中文名稱是否必填類型說明
UNFQ銀聯聚分期CStringjson字符串結構體
–> isForce是否強制CString01:強制
–> unFqNum分期期數CString
–> unFqSellerPercent分期費率CString
HBFQ花唄分期CStringjson字符串結構體
–> hbFqNum分期期數CString
–> hbFqSellerPercent分期費率CString

考拉分期order_scene_field送值樣例

{
    "order_scene_field":
    {
        "encrypted_field": "{\"UNFQ\":\"{\\\"cardNo\\\":\\\"623622656535665656\\\",\\\"bankNm\\\":\\\"招商銀行\\\"}\"}",
        "order_scene_type": "KL_FQ",
        "scene_info": "{\"UNFQ\":\"{\\\"isForce\\\":\\\"01\\\",\\\"unFqNum\\\":\\\"6\\\",\\\"unFqSellerPercent\\\":\\\"0\\\"}\",\"HBFQ\":\"{\\\"hbFqNum\\\":\\\"3\\\",\\\"hbFqSellerPercent\\\":\\\"0\\\"}\"}"
    }
}復制

請求樣例

{
    "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": "自動化測試",
        "transfer_field": {
            "acc_out_no": "62266211223334323",
            "acc_out_name": "張三",
            "additional": "轉賬附言"
        },
        "callback_url": "",
        "product_id": "200809",
        "goods_mark": "1",
        "goods_field": "{\"goods_amt\":1,\"goods_name\":\"卅\",\"goods_num\":1,\"goods_pricing_unit\":\"1\",\"goods_type\":\"11\",\"te_platform_name\":\"amazon\",\"te_platform_type\":\"2\"}",
        "order_scene_field": {
            "order_scene_type": "ONLINE_WILDCARD",
            "encrypted_field": "{\"billingAddress\":\"{\\\"houseNumberOrName\\\":\\\"123 Main St\\\",\\\"street\\\":\\\"Main Street\\\",\\\"city\\\":\\\"New York\\\",\\\"country\\\":\\\"USA\\\",\\\"stateOrProvince\\\":\\\"BT\\\",\\\"postalCode\\\":\\\"10001\\\"}\",\"mobilePhone\":\"+86 13531231231\",\"recipientFirstName\":\"王\",\"recipientLastName\":\"五\"}",
            "scene_info": "{\"userId\":\"12312312\",\"userCreateDate\":\"20230402121212\",\"recipientStreet\":\"Main Street\",\"recipientCity\":\"New York\",\"recipientStateOrProvince\":\"BT\",\"recipientCountry\":\"USA\"}"
        }
    },
    "version": "3.0",
    "req_time": "20220714160009"
}復制

返回參數

字段名是否必輸類型長度字段描述示例
merchant_noMString32
結算商戶號
channel_idMString32

out_order_noMString32商戶訂單號
order_create_timeMString32創建訂單時間訂單系統創建訂單的時間,格式yyyyMMddHHmmss
order_efficient_timeMString32訂單有效截至時間格式yyyyMMddHHmmss
pay_order_noMString64平臺訂單號21070211012001970631000383039
total_amountMlong12訂單金額,單位:分200
counter_urlMString256收銀臺地址信息

響應樣例

{
    "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一覽表

msgcode
成功000000


The End