# @auspayplus/open-payments-checkout 中文文档
规范地址：https://npmcn.com/package/%40auspayplus/open-payments-checkout/
版本：1\.8\.0
npm 元数据更新时间：2026-10-29T04:10:29.402Z
中文译文更新时间：2026-11-07T05:35:11.103Z
软件包许可：Apache-2\.0
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40auspayplus/open-payments-checkout
原文对照：https://npmcn.com/package/%40auspayplus/open-payments-checkout/?lang=original
项目主页：https://gitlab.com/b707/platform-and-payments/ho-oh#readme
源码仓库：https://gitlab.com/b707/platform-and-payments/ho-oh
弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：92.4 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：1 个
- 首次发布：2023-03-23T07:27:13.649Z
- 最新版本发布：2024-06-12T00:05:14.584Z
- 近 30 天下载量：3847（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 0 个）
## 中文简介
公共设施、类型和离职援助
## 安装
```sh
npm install @auspayplus/open-payments-checkout
```
也可以使用：`pnpm add @auspayplus/open-payments-checkout`、`yarn add @auspayplus/open-payments-checkout`、`bun add @auspayplus/open-payments-checkout`
## README
# 开放式付款核对
一个图书馆/框架不可知的国家预防机制软件包,它提供了启动公开支付核对程序和其他相关公用事业职能的手段.
## 开始
通过运行以下操作之一来安装软件包:
- 对于雅恩: `yarn add @auspayplus/open-payments-checkout`
- 就国家预防机制而言: `npm install @auspayplus/open-payments-checkout`
- 用于 PNPM : `pnpm install @auspayplus/open-payments-checkout`
## 基本用途
### Javascript
为了在联署机构的环境中即时取出,您可以做到以下几点:
```ts
import { Checkout } from '@auspayplus/open-payments-checkout';
const checkout = new Checkout({
orderId: '123',
url: 'https://{checkout_url}',
clientId: 'client_id',
onCheckoutClosed: () => {
console.log('CHECKOUT COMPLETED!');
},
});
```
然后将触发器绑定在事件听众身上:
```ts
const openCheckout = () => checkout.open();
```
### 反应
对于回放,以下是如何即时取出的例子.
```ts
import { Checkout } from '@auspayplus/open-payments-checkout';
export function MyComponent() {
const checkout = new Checkout({
orderId: '123',
url: 'https://{checkout_url}',
onCheckoutClosed: () => {
console.log('CHECKOUT COMPLETED!');
},
onError: () => {
console.log('AN ERROR OCCURRED!');
},
onPaymentSuccess: () => {
console.log('PAYMENT IS SUCCESSFUL!');
},
onPaymentError: () => {
console.log('PAYMENT HAS ERRORED!');
},
onTokensChanged: ({ accessToken, refreshToken }) => {
console.log('TOKENS HAVE CHANGED!');
},
});
const onClick = () => {
checkout.open();
};
useEffect(() => {
// This is required for the callbacks provided to work
// otherwise, is negligible
checkout.listenMessage();
}, []);
return ;
}
```
## 检出参数
您可以在“ 退出” 类构建器中通过一些参数来即时进行退出
| 参数 | 说明 | 需求 |
| --- | --- | --- |
| 认证 : **对象** | 允许快速取出的授权对象 。 这必须与属性模式一起被定义为"表达". 详见 [参数的进一步信息](https://npmcn.com/package/%40auspayplus/open-payments-checkout/#readme-auth) | 可选 |
| 顺序 : **字符串** | 需要命令 ID 来引用退出程序 . | 需求 |
| 客户端文件 : **字符串** | 客户端ID用于标记正在使用的钱包(如Beem),同时也在取出行程中提供不同的经验和功能. 如果不提供客户端ID,则客户端ID会默认为Beem. | 可选 |
| 模式吗 : **字符串** | 如果尝试使用快取, 则必须定义此属性 。 值可以是字符串"默认"或"表达" | 可选 |
| 检查已关闭( {错误: **错误**,顺序: **字符串** } | 在关闭出账窗口时可被引用的回调 . | 可选 |
| 错误 : **错误**,顺序: **字符串** } | 在退出过程中遇到错误时可被引用的回调 | 可选 |
| 支付成功( { 错误 : **错误**,顺序: **字符串** } | 在支付过程中成功时,可重复使用. | 可选 |
| 在 PaymentError ({ 错误 : **错误**,顺序: **字符串** } | 可在支付过程中因出错而引用的回调. | 可选 |
| 在 TokensChanged({ access Token, rest Token }) 上进行更改 | 当访问令牌和(或)刷新令牌更改时,可以引用的回调 . | 可选 |
| 窗口形状 | 这决定了如何呈现窗口. | 可选 |
### 参数的进一步信息
#### 认证
这个 `auth` 属性将允许在目标检出站点进行快速检出。 A 类 `mode` 有字符串值 `express` 为了实现这一功能,必须同时宣布.
| 财产 | 数值 | 需求 |
| --- | --- | --- |
| 访问( t) | 字符串 | 需求 |
| 过期( i) | 编号 | 可选 |
| 缩写( t) | 字符串 | 可选 |
| 刷新( tk) | 字符串 | 需求 |
| 范围 | 字符串 | 可选 |
| 符号类型 | 字符串 | 可选 |
您可以将此对象传递到 `auth` 类似在即决中的财产
```ts
const checkout = new Checkout({
// Pass tokens into the auth property object
auth: {
access_token: '12345',
refresh_token: '678910',
},
mode: 'express',
orderId: '123',
url: 'https://{checkout_url}',
});
```
#### 改变的
这个 `onTokensChanged` 调用将接收包含新对象 `accessToken` 财务报告和审定财务报表 `refreshToken` 值当它们改变.
#### 窗口形状
窗口Features param 正在接受一个包含以下内容的对象:
| 财产 | 数值 |
| --- | --- |
| 高度 | 编号 |
| 左边 | 编号 |
| 弹出 | "是""没有"""1""""""0" |
| 可调整 | "是""没有"""1""""""0" |
| 顶端 | 编号 |
| 宽度 | 编号 |
例如,如果您想要自定义窗口特性,您会像这样即时跳出:
```ts
const checkout = new Checkout({
orderId: '123',
url: 'https://{checkout_url}',
windowFeatures: {
width: 200,
height: 200,
},
});
```
## 可用方法
在即时停课时,将提供下列公开方法/用途:
| 方法 | 说明 |
| --- | --- |
| 正在取出打开:布尔 | 检查退出窗口是否打开 |
| 听觉消息 (): 无效 | 使用回调退出时需要 |
| 打开( i): 空 | 打开并即时处理取出窗口 |
| 关闭 (): 空 | 关闭取出窗口 |
* * *
## 回调和错误
除了取消离职手续外,商家套件还便利商家之间的通信 还有退票 商家包通过4个回调方法容纳了这个功能,3个可以提供访问 用于商业商家在成功付款后可能想要完成的任何额外任务时与 1 相差错。 回调会使用下列签名作为参数 .
```ts
interface ICheckoutCallback {
orderId: string;
error?: Error;
}
```
下一节将基本概述总体流量,并随后进一步详细说明这些回调.
### 基本套件流程
从商家的工地开始, 商贸套装即时化 使用方法。 其中一个是 **打开** 方法。 这个 **打开** 然后绑定方法 切入按钮,例如“用 FlyPay 检查”按钮,然后立即切入 检查流。 商地必须提供 `orderId` 从创建中获取 通过Beem As A Service(BaaS) API命令并提供此服务 `orderId` 即时 商业套餐.
离职程序开始时,用户认证程序即开始 用户重定向为 PING 登录/签名流程。 完成流动时 `userToken` 生成并传递到退出。 用户被带入退票登陆页面, 询问 BaaS 与 `userToken` 财务报告和审定财务报表 `orderId` 获取用户的详细信息 命令。 命令。 用户随后可以管理他们的牌(查看、添加、去除、更新、设置牌为 默认),或简单地击出 `pay` 按钮开始支付.
当用户点击 `pay` 按钮,与 BaaS 交换一系列请求,简化 在这里,作为"支付流"。 如果所有这些都成功, 用户会被带入“ 付款 ” 成功屏幕和 `onPaymentSuccess()` 在商场上触发回调 (注意这是在成功付款时发生的,而且不会等到结账时才进行).
### 商业套件召回
4个商包回调图在这里被描述. 请注意: **支付成功** 已经 不提供错误访问。 只有 **顺序** 可以从那里进入.
#### 检查已关闭( {错误: 错误, 顺序: 字符串 })
结账(以前在付账完成时)随时结束结账,没有付款 失败。 如果会话结束时出现错误,则可以在 除此以外, 只有命令可以访问 .
#### 错误( {错误: 错误, 顺序: 字符串 })
错误只有在瞬间发生,如果 `orderId` 期间未提供 商业套件即时处理,或 `orderId` 条件是过期.
#### 在 PaymentError( { 错误: 错误, 顺序: 字符串} )
支付时只发生错误,允许访问 **错误** 财务报告和审定财务报表 页:1 **顺序** 在回调功能和任何支付错误处理中.
#### 支付成功( { 顺序: 字符串 })
当付款流完全成功时,即称为支付成功。 只有顺序 可从此调用。 这种回调还提供了额外执行手段 如果商家需要,则工作.
## 可能的错误
下面列出的是可能发生的错误,哪些是回调手柄。 请注意, 退出过程中发生的任何错误都不利于交易的成功 如果交易发生,用户将无法完成交易.
| 错误 | 细节 | 友好信件 + UI 实例 | 行动 |
| --- | --- | --- | --- |
| 错误召回 |
| 编号已过期 | 如果通过了过期的 " 订单 " ,则在即时离职时发生. |  _付款加载出错_
不要担心,你的订单还在,你还没有到 充电了 请尝试关闭窗口并再次检查或联系客户服务 如果这个问题继续下去. |
- 显示错误消息
- 生成一个新 `orderId` 再来一次
|
| 缺少命令 ID | 如果未通过 " 命令 " ,则立即离职. | "" "" (英语) |
- 通过未过期的\`命令 ' 再试一次.
|
| 证明错误 | 如果出现以上未涵盖的错误, 则出现一般错误 | "" "" (英语) |
- 日志错误并调查 .
|
| 支付错误召回 |
| 一般支付错误 | 如果在支付过程中出错, 一般错误 |  _支付处理出错_
我们很遗憾, 但有一个问题处理你的付款。 不要担心 已经被起诉了。 如果问题依然存在,请再次尝试或联系客户服务处. |
- 日志错误并调查 .
|
| 已取消的回电 |
| 认证错误 | 导致用户在平时登录/签名流程失败后退出 | _小平处理出错_ |
- 日志错误并调查 .
- 问题要么是用户输入,要么是平通服务.
|
| 卡片管理出错 | 试图管理 BAAS 上的卡片时出错 |  _保存卡片出错_
对不起, 但有一个问题保存你的名片。 不要担心,没有变化 已经做了。 如果这个问题继续存在,请尝试再次保存或联系客户服务处.
 _删除纸牌出错_
我们很抱歉, 但有一个问题, 不要担心,没有变化 已经做了。 如果这个问题继续存在,请设法再次删除或联系客户服务处. |
- 日志错误 .
|
| 获取命令细节失败 | 由于未能从BAAS获得订单细节 |  _付款加载出错_
也还没有受到指控。 请试试 如果这个问题继续存在,则关闭窗口并再次检查或联系客户服务处. |
- 日志错误并调查 .
|
| 获取用户细节失败 | 原因是未能从BAAS获得用户信息(主要关心的是用户的付款方法) |  _钱包细节出错_
抱歉 夹上钱包的细节有问题 你的命令还在这里 试试走 返回,然后重新开始离职或联系客户服务处寻求帮助. |
- 日志错误并调查 .
|
| 常规错误 | 如果出错没有被其他错误覆盖, 一般性错误 |  _支付处理出错_
我们很遗憾, 但有一个问题处理你的付款。 不要担心 已经被起诉了。 如果问题依然存在,请再次尝试或联系客户服务处. |
- 日志错误并调查 .
|
* * *
## 常见问题
### @auspayplus/open-payments-checkout 是什么？
公共设施、类型和离职援助注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.
### 如何安装 @auspayplus/open-payments-checkout？
在项目目录运行 npm install @auspayplus/open-payments-checkout，或使用 pnpm add / yarn add / bun add。
### @auspayplus/open-payments-checkout 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @auspayplus/open-payments-checkout 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。
### @auspayplus/open-payments-checkout 需要什么版本的 Node\.js？
package\.json 的 engines 字段要求 Node\.js \>= 18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
### @auspayplus/open-payments-checkout 可以商用吗？
@auspayplus/open-payments-checkout 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。
### @auspayplus/open-payments-checkout 的下载量有多少？
根据 npm 官方下载统计，@auspayplus/open-payments-checkout 在 2026/10/07 – 2026/11/05 这 30 天内被下载 3,847 次，日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @auspayplus/open-payments-checkout 还在维护吗？
最新版本 1\.8\.0 发布于 2024/06/12（2 年前）；至今共发布 22 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/03/23。作者已将其标记为弃用，新项目建议寻找替代方案。