cashier 收银组件 -凯发app官方网站

更新时间：2022-11-15 16:39:55

订阅更新

我的文档

设置

简介

cashier 收银组件

在

收银台 api

的基础上开放了支付选择页面，并兼容支持除蜻蜓以外的其它 iot 设备，例如双屏收银机等。

说明

：收银组件刷脸支付单笔单日限额为 5000 元。

交互示意图

组件 ui 规范

软件版本要求

●

iot 小程序容器：10.1.80 及以上。

●

蜻蜓应用：2.12.0 及以上。

使用

在小程序页面集成收银组件（刷脸入口）

示例代码如下：

注意

：

●

需要为收银组件

预留半个屏幕空间，设置参数：

style="width:100%; height:50vh;"

。

●

组件渲染成功后，动态调整参数时，需要调用 cmd 指令刷新组件。

组件属性说明

使用说明

：在

控件中设置属性和值。

参数	类型	必填	说明
totalamount	string	否	订单总金额。入参上限为 100 万元，即单笔订单最大金额不能超过 100 万元。
faceloadingtimeout	string	否	等待获取刷脸支付结果的页面超时时间默认 15，单位为秒，可自定义时长取值范围为 5 ~ 180 秒，低于 5 秒或高于 180 秒报错。若超时后仍未获取到支付结果，会提示用户请等待收银员确认支付结果，无法展示详细的支付结果。
enabledoubledisplays	string	否	双屏设备相关参数。双屏场景，前屏展示刷脸支付过程，后屏由开发者自定义。 false：默认值。 true：表示双屏设备。
enablescan	string	否	扫码功能开关。 false：默认值。 true：表示在有收银组件的页面支持扫码，退出组件页面后自动关闭扫码功能。说明：本参数仅适用于蜻蜓系列机型。
enablescandi	string	否	false：默认值，配合扫码功能使用。 true：表示组件扫码成功后播报滴。说明： ●要求小程序容器 10.1.80.20 或更高版本，蜻蜓应用 3.1.0.239 或更高版本。不满足版本要求的情况需要开发者自行调用语音播报api。 ●本参数仅适用于蜻蜓系列机型。
theme	string	否	v：默认值，表示竖屏。 h：表示横屏。

组件自定义事件说明

onsuccess 事件

使用说明

：收银小程序组件渲染成功时，会触发成功事件。

.js 示例代码

onfail 事件

使用说明

：收银小程序组件渲染失败时，会触发失败事件。

.js 示例代码

失败事件返回码如下：

名称	描述
q1201	收银台 app 未安装（q1201）。
q1202	收银组件注册失败（q1202)。
q1203	组件参数设置异常（q1203）。
q1204	组件 ui 设置异常（q1204）。
q1205	组件服务断开连接（q1205）。
q1207	摄像头异常，请收银员重启设备后再试（q1207）。
q1400	刷脸支付结果等待页超时时间设置有误（q1400）。
q1402	支付金额超限，请使用其它凯发k8官方网娱乐官方的支付方式（q1402）。
q1403	支付金额格式错误，请使用正确格式（q1403）。

onchange 事件

使用说明

：

用户点击刷脸按钮并完成刷脸后

，会触发 onchange 事件

。

通过

onchange 事件可以获取到当次刷脸的结果。

.js 示例代码

onchange 事件返回参数如下：

参数	类型	说明
success	bool	是否成功。
barcode	string	刷脸/扫码成功后返回付款码，其中刷脸返回的付款码仅用于当面付接口 alipay.trade.pay（统一收单交易支付接口）发起支付，barcode 付款码的有效期为 2 分钟。可以使用 my.request api 将付款码传递给服务端。
buyerid	string	买家支付宝 user_id，刷脸成功有返回，扫付款码不返回。
codetype	string	f 代表刷脸，c 代表扫码。
devicesn	string	机具 sn。
errorcode	string	失败错误码，仅错误时返回。
errormessage	string	失败错误信息，仅错误时返回。
ftoken	string	目前无效, 请勿使用 ftoken 进行支付。
subcode	string	刷脸返回的错误码。

onchange 事件返回码如下：

名称	描述
q1208	网络不可用（q1208）。
q1209	暂时无法使用刷脸（q1209）。
q1210	刷脸按钮点击过快（q1210）。
q1211	网络不可用（q1211）。
q1401	刷脸支付金额超限，请使用其它凯发k8官方网娱乐官方的支付方式（q1401）。
z6021	暂时无法使用刷脸（z6021）。

onstatus 事件

使用说明

：

用户点击刷脸按钮，刷脸过程中，会触发 onstatus 事件。通过 onstatus 事件可以获取到刷脸过程中不同阶段的状态码。

.js 示例代码

onstatus 事件返回参数如下：

名称	类型	描述
biztype	string	参数取值如下： ●result_btn_function ⽀付结果⻚⾃定义功能按钮。 ●result_closed 收银台/结果⻚关闭。 ●result_df_status 收银状态。
status	string	刷脸⻚⾯： ●capture 刷脸采集⻚⾯。 ●keyboard_0 确认支付⻚⾯。 ●keyboard_4 4 位⼿机号确认⻚⾯。 ●keyboard_11 11 位⼿机号确认⻚⾯。 ●protocol 协议⻚⾯。 ●error 刷脸异常⻚⾯。 ●qrcode ⼆维码确认⻚⾯。⽀付结果⻚： ●show_result_success ⽀付成功事件。 ●show_result_default 未知结果事件。 ●show_result_error ⽀付失败事件。 ●result_close 关闭结果页事件。 ●result_searching 等待支付结果事件。
subcode	string	错误类型（error 事件会带有错误码）。
errormessage	string	错误描述。

组件 cmd 指令

在收银组件运行过程中，可以使用 invoke 方法执行对应的指令。

示例代码

.js 示例代码

入参

参数	说明
cancel	通过指令关闭刷脸页面。
refresh	收银组件渲染成功后，如果参数发生变化，需调用该指令更新参数。

相关问题