开放式付款核对

一个图书馆/框架不可知的国家预防机制软件包,它提供了启动公开支付核对程序和其他相关公用事业职能的手段.

开始

通过运行以下操作之一来安装软件包:

• 对于雅恩: yarn add @auspayplus/open-payments-checkout
• 就国家预防机制而言: npm install @auspayplus/open-payments-checkout
• 用于 PNPM : pnpm install @auspayplus/open-payments-checkout

基本用途

Javascript

为了在联署机构的环境中即时取出,您可以做到以下几点:

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!');
  },
});

然后将触发器绑定在事件听众身上:

const openCheckout = () => checkout.open();
<button class="my-button" onclick=openCheckout()>My Button</button>

反应

对于回放,以下是如何即时取出的例子.

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 <Button {...args} onClick={onClick} />;
}

检出参数

您可以在“ 退出” 类构建器中通过一些参数来即时进行退出

参数的进一步信息

认证

这个 auth 属性将允许在目标检出站点进行快速检出。 A 类 mode 有字符串值 express 为了实现这一功能,必须同时宣布.

您可以将此对象传递到 auth 类似在即决中的财产

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 正在接受一个包含以下内容的对象:

例如,如果您想要自定义窗口特性,您会像这样即时跳出:

const checkout = new Checkout({
  orderId: '123',
  url: 'https://{checkout_url}',
  windowFeatures: {
    width: 200,
    height: 200,
  },
});

可用方法

在即时停课时,将提供下列公开方法/用途:

回调和错误

除了取消离职手续外,商家套件还便利商家之间的通信 还有退票 商家包通过4个回调方法容纳了这个功能,3个可以提供访问 用于商业商家在成功付款后可能想要完成的任何额外任务时与 1 相差错。 回调会使用下列签名作为参数 .

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获得用户信息(主要关心的是用户的付款方法)	钱包细节出错 抱歉 夹上钱包的细节有问题 你的命令还在这里 试试走 返回,然后重新开始离职或联系客户服务处寻求帮助.	日志错误并调查 .
常规错误	如果出错没有被其他错误覆盖, 一般性错误	支付处理出错 我们很遗憾, 但有一个问题处理你的付款。 不要担心 已经被起诉了。 如果问题依然存在,请再次尝试或联系客户服务处.	日志错误并调查 .