聚合收银台收银台订单创建 (全报文加密)

拉卡拉支付 6天前 ( 11-20 20:02 ) 28

调用地址

自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