my.ix.startapp（刷脸支付/扫码支付） -凯发app官方网站

android 开发文档

windows 开发文档

linux 开发文档

iot 小程序开发文档

其它

iot 开放平台 spi 流程概览

复杂类型管理

api

收银台

刷脸核身

刷脸登录

会员与授权

发送付款码

发送和接收小指令

版本查询

获取系统属性

系统设置页面

二维码识别

生成二维码

ui 控制

语音播报

本地数据库

本地图片存储

串口通信

外设管理

打印指令

监听按键事件

身份证读卡器适配

电子秤

钱箱

非接卡通信

ic 卡通信

红外测温仪

消息服务

日志服务

前后屏通信

更多使用指南

更新时间：2024-06-18 10:23:35

订阅更新

我的文档

设置

简介

my.ix.startapp

是启动 iot 应用的 api，在这个 api 的基础上可以扩展为打开系统设置页面 api 和收银台 api。

本节介绍的是收银台 api。

收银台

是 iot 小程序集成刷脸支付和扫码支付功能的主要 api。

使用限制

●

收银台刷脸支付单笔单日限额为 5000 元。

●

收银台功能要求蜻蜓应用 2.8.1 及以上版本。

●

本接口仅适用于

。

●

蜻蜓设备每 30 分钟自动检查最新软件版本，若检查到新版本则在闲置 5 分钟后下载安装，开机或重启则会直接检查更新并下载安装。自动升级暂不支持手动关闭。

●

iot 小程序开发刷脸支付功能，需要在服务端接入当面付

alipay.trade.pay

（统一收单交易支付接口），并签约当面付功能，不需要签约除当面付以外的其他功能。

●

收银台功能支持刷脸支付和扫码支付，而扫码支付支持花呗分期，刷脸支付不支持花呗分期。

●

蜻蜓应用 2.9.0

之前的版本，

若需要测试收银台功能，需要先完成

分发 iot 小程序

，否则可能导致调试后直接退出收银台和不返回

barcode

付款码等现象。若小程序未上架，可以先使用蜻蜓 api 测试用小程序 appid：2019053165441001 进行分发。调试完成后请尽快使用正式版的小程序 appid 进行分发。

接口调用

启动收银台

蜻蜓小程序调用收银台 api 后，蜻蜓将进入收银台页面，用户可以选择刷脸支付或者扫码支付，收银台会返回付款码。小程序从收银台回调方法接收到支付宝付款码后，需要将付款码传回小程序服务端或发送到收银机（点击

发送付款码

查看发送方法），由小程序服务端/收银机服务端调用支付宝当面付条码支付接口 alipay.trade.pay（统一收单交易支付接口）发起支付。

注意

：

●

扫码成功后收银台会返回付款码（barcode），并且默认自动退出，需要小程序自定义支付结果页。

●

刷脸成功后收银台会返回付款码（barcode），此时收银台界面不会退出，会保留在前台获取并展示刷脸支付结果，可以通过

获取收银台页面实际退出的时机。

●

收银台正在运行时，请勿重复唤起收银台，可以等待收银台退出后再次唤起，可以通过

获取收银台页面实际退出的时机。

●

蜻蜓应用 3.3.6 和刷脸应用 5.0.4

之后的版本

，收银台正在运行时，重复唤起收银台，会返回 1400 错误码。

●

通过收银台 api 获取的刷脸付款码（barcode），仅用于

当面付

接口 alipay.trade.pay（统一收单交易支付接口）发起支付。调用 alipay.trade.pay 发起支付时，入参

scene=bar_code

。如果传入其他值会导致收银台无法获取刷脸支付结果。

●

iot 小程序的刷脸支付已支持

当面付

的

。

●

刷脸支付结果页默认展示时长为 5 秒，有运营内容（如会员开卡等）展示时长延长为 10 秒。

●

刷脸支付页面和刷脸支付结果页不支持自定义。

示例代码

js 示例代码

入参

参数	类型	必填	描述
appname	string	是	固定值 cashier，不能修改。
bizno	string	是	商户业务流水号；需保证在商户端不重复。
totalamount	string	否	订单总金额。入参上限为 100 万元，即单笔订单最大金额不能超过 100 万元。
sellerid	string	否	支付 pid。
storeid	string	否	门店 id。
phonenumber	string	否	刷脸支持传入手机号。
orderdetail	json	否	自定义订单详情（仅用于展示订单相关信息），支持两栏，最多五行： ●每行文案分成两个字段：名称、内容详情，名称不要超过 4 个字，内容详情不要超过 15 个字。 ●文案可以设置两种颜色：灰色（#999999）、红色（#ff0000）。 ●格式：[{name:'名称',content:'详情',fontcolor:'gray/red'}]。 ●格式错误时，不能正常显示订单详情。注意：蜻蜓应用 2.8.1 版本不支持。
postimeout	string	否	凯发k8官方网娱乐官方的支付方式选择页超时时间默认为 120，单位为秒，可自定义时长取值范围为大于等于 10 秒，低于 10 秒报错，或设置为（-1）表示不超时。
faceloadingtimeout	string	否	等待获取刷脸支付结果的页面超时时间默认 15，单位为秒，可自定义时长取值范围为 5~180 秒，低于 5 秒或高于 180 秒报错若超时后仍未获取到支付结果，会提示用户“请等待收银员确认支付结果”，无法展示具体的支付结果。
showscanpayresult	bool	否	该参数已失效，建议去除或传入 false。扫码成功后收银台会返回付款码（barcode），并且默认自动退出，需要小程序自定义支付结果页。
scanloadingtimeout	string	否	扫码支付结果等待页超时时间默认 5 秒，单位为秒，可自定义时长取值范围为 5~180 秒，低于 5 秒或高于 180 秒报错。
scenemode	string	否	传入 pos 代表在连接收银机场景使用，启动收银台时不播报付款引导语音，页面展示电子海报。小程序容器 10.1.60.24 开始支持。

出参

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

错误码

错误码	说明
102	参数错误。
1700	收银台页面，点击键盘设置，收银台退出并返回错误码 1700。小程序容器 10.1.60.20-18 版本开始支持。
1400	收银台正在运行时，重复唤起收银台（蜻蜓应用 3.3.6 和刷脸应用 5.0.4 之后支持）。

收银台操作指令

是指控制在收银台界面上刷脸、扫码等功能开关的指令。

启动收银台后，可以使用收银台操作指令。也就是说需要

先调用

收银台 api

后才能调用收银台操作指令 api。建议在开发

支付宝盒 f4 plus

双屏屏小程序时使用，单屏小程序本身在前屏已附带操作指令对应的功能不需要调用本接口。那么可以在

后屏小程序

中调用

收银台操作指令

api，控制

前屏小程序

的收银台。

参数	类型	必填	描述
cmd	string	是	支付选择页操作指令： ●scantip：展开扫码提示。 ●cancel：退出。刷脸页面操作指令： cancel：返回支付选择页。

相关问题