安全墙,js

我们很高兴能为Airwallex.js推出新的综合文献网站。 Airwallex.js将所有Airwallex元素合并为一个单一,统一的SDK,以提高效率并方便整合. SDK包括:

• 支付元素(信用卡,苹果支付,谷歌支付等)
• 支付要素(受益人、转账、税务表)
• 入职要件(KYC,KYB)
• 风险因素(RFI)
• 遵约支助要素

如果你在使用下面列出的SDK,我们建议 升级到新的Airwallex.js SDK 获取最新特性和增强功能.

• 活墙支付要素
• 支付SDK

• 安全墙,js
  • 安装
  • 初始化
    • 创建元素
      • 方法参数
      • options 对象属性 :
      • 示例
  • element 对象
    • 挂载元素
    • 卸载元素
    • 摧毁元素
    • 倾听元素事件
  • KYC 元素事件
    • ready
    • success
    • cancel
    • error
  • KYB 元素事件
    • ready
    • success
    • reserveOptionsOffered
    • selectReserve
    • cancel
    • error
  • RFI 元素活动
    • ready
    • success
    • cancel
    • error
  • SCA 元素事件
    • ready
    • scaSetupSucceed
    • verificationSucceed
    • verificationFailed
    • resetPasscodeSucceed
    • cancel
    • error
  • 他们
• 变化

安装

使用@ airwallex/ 组件- sdk

用 Yarn 安装

yarn add @airwallex/components-sdk

或者,与国家预防机制

npm install @airwallex/components-sdk

初始化

import { init } from '@airwallex/components-sdk';

const options = {
  locale: 'en',
  env: 'prod',
  authCode: 'x4D7A7wOSQvoygpwqweZpG0GFHTcQfVPBTZoKV7EibgH',
  clientId: 'BIjjMYsYTPuRqnkEloSvvf',
  codeVerifier:
    '~wh344Lea1FsCMVH39Fn9R2~nqq2uyD4wbvG9XCzWRxd0sZh9MFiF9gSVkM0C-ZvrdtjBFA6Cw1EvCpJcIjaeXg1-BXCfZd25ZmvuYZAqZtjJQA3NAa~7X1sgEfbMZJwQ',
};

await init(options);

创建元素

打电话 createElement(elementName, options) 以创建元素对象.

方法参数

options 对象属性 :

示例

import { createElement } from '@airwallex/components-sdk';

const options = {
  hideHeader: true,
  hideNav: true,
};

const element = await createElement('kyc', options);

element 对象

export type EVENT_TYPE = 'ready' | 'success' | 'error' | 'cancel';

interface Element {
  /**
   * Mount element to your HTML DOM element
   */
  mount(domElement: string | HTMLElement): void;
  /**
   * Using this function to unmount the element, opposite to mount function
   * The element instance is still kept
   */
  unmount(): void;
  /**
   * Using this function to destroy the element instance
   */
  destroy(): void;
  /**
   * Listen to event
   */
  on(
    eventCode: EVENT_TYPE,
    handler: (eventData: Record<string, unknown>) => void,
  ): void;
}

挂载元素

将元素挂入页面.

// type
element.mount: (domElement: string | HTMLElement) => void

// There are two ways to mount element:
// 1. call with container dom id
element.mount('container-dom-id');

// 2.find the created DOM in existing HTML and call with container DOM element
const containerElement = document.getElementById("container-dom-id");
element.mount(containerElement);

卸载元素

使用此函数来卸载元素, 相对于挂载函数 . 元素实例仍然保留.

element.unmount();

摧毁元素

3⁄4 ̄ ̧漯B.

element.destroy();

倾听元素事件

3⁄4 ̄ ̧漯B.

element.on('success', () => {
  // Handle success event
});

KYC 元素事件

这个 Onboarding component 可能在其生命周期内出现下列事件.

ready

本次活动将在下列情况下发射:

• 如果已启用, 同意页面已准备就绪 。 事件数据将是 { type: 'consent'}。使用此事件来决定何时从页面中删除装入状态.
• Kyc页面准备好了 事件数据将是 {type: 'kyc', kycStatus: 'INIT'},代表账户的入职状态。 使用 kycStatus 以制作自己的状态页并处理重返方案.

类型

type kycEventData = {
  type: 'kyc',
  kycStatus: 'INIT' | 'SUBMITTED' | 'SUCCESS' | 'FAILURE'
};

type consentEventData = {
  type: 'consent'
};

element.on('ready', (data: kycEventData | consentEventData) => void);

示例

element.on('ready', (data: kycEventData | consentEventData) => {
  // Handle ready event
});

success

此事件在登船流程成功完成时会起火.

类型

element.on('success', () => void);

示例

element.on('success', () => {
  // Handle success event
});

cancel

此事件在元素被取消时起火 .

类型

element.on('cancel', () => void);

示例

element.on('cancel', () => {
  // Handle cancel event
});

error

当元素内发生错误时,此事件会起火 .

类型

type errorCode = 'API_ERROR' | 'SUBMIT_FAILED' | 'UNKNOWN';
type ErrorData = { code: errorCode, message?: string }

element.on('error', (data: ErrorData) => void);

示例

element.on('error', (data: ErrorData) => {
  // Handle error event
});

KYB 元素事件

ready

当支付 Kyb 元件准备启动 Kyb 应用程序时, 此事件将被启动 。 如果发生 PERMISION DENIED 错误,此事件将不会被触发 .

data 类型

{
  kybStatus: 'PENDING_REVIEW' | 'IN_REVIEW' | 'REJECTED' | 'ACCEPTED' | 'APPROVED',
  kycStatus: 'INIT' | 'SUBMITTED' | 'SUCCESS' | 'FAILED'
}

success

此事件在 KYB 初始案例成功提交时发生 .

data 类型

{
  storeList: Array<StoreObject>;
}

reserveOptionsOffered

只有在可供账户使用的准备金选择时才使用。 联系人账户管理员了解更多细节 .

data 类型

{
  reserveOptions: UserReserveSelection;
}

selectReserve

这是用户选择保留选项的内容 。 仅用于账户的准备金选择。 联系人账户管理员了解更多细节 .

data 类型

{
  selected: UserReserveSelection;
}

cancel

此事件在元素被取消时起火 .

类型

element.on('cancel', () => void);

示例

element.on('cancel', () => {
  // Handle cancel event
});

error

参见下面错误一节

data 类型

{ code: string, message?: string }

RFI 元素活动

ready

本次活动将在下列情况下发射:

• RFI页面已准备就绪. 事件数据为:
  • {type: 'kycRfi' | 'paymentEnablementRfi' | 'transactionRfi' | 'mrmRfi'}

类型

type RfiEventData = {
  type: 'kycRfi' | 'paymentEnablementRfi' | 'transactionRfi' | 'mrmRfi',
};

element.on('ready', (data: RfiEventData) => void);

示例

element.on('ready', (data: RfiEventData) => {
  // Handle ready event
});

success

当rfi流成功完成时,此事件会起火.

类型

type RfiSuccessEventData = {
  rfiId: string;
};

element.on('success', (data: RfiSuccessEventData) => void);

示例

element.on('success', (data: RfiSuccessEventData) => {
  // Handle success event
});

cancel

此事件在元素被取消时起火 .

类型

element.on('cancel', () => void);

示例

element.on('cancel', () => {
  // Handle cancel event
});

error

当元素内发生错误时,此事件会起火 .

类型

type errorCode = 'API_ERROR' | 'SUBMIT_FAILED' | 'INVALID_KYC_STATUS' | 'INVALID_RFI_STATUS' | 'UNKNOWN';
type ErrorData = { code: errorCode, message?: string }

element.on('error', (data: ErrorData) => void);

示例

element.on('error', (data: ErrorData) => {
  // Handle error event
});

SCA 元素事件

ready

此事件将在: sca page 准备就绪后启动 .

类型

element.on('ready', () => void);

示例

element.on('ready', () => {
  // Handle ready event
});

scaSetupSucceed

当用户成功配置了 SCA 时, 此事件将被启动 :

类型

element.on('scaSetupSucceed', (
  data: {
    mobileInfo?: {
      /** countryCode is represented as pure number codes string, such as '44'. */
      countryCode: string;
      nationalNumber: string;
    }
  }) => void);

示例

element.on('scaSetupSucceed', () => {
  // Handle event
});

verificationSucceed

成功验证 SCA 流量时触发此事件

类型

element.on('verificationSucceed', ({token}: {token:string}) => void);

示例

element.on('verificationSucceed', ({ token }: { token: string }) => {
  // Handle success event
});

verificationFailed

当SCA流认证失败时,此事件会触发.

类型

element.on('verificationFailed', ({reason}:{reason:string}) => void);

示例

element.on('verificationFailed', () => {
  // Handle event
});

resetPasscodeSucceed

当用户成功重放密码时, 此事件触发

类型

element.on('resetPasscodeSucceed', () => void);

示例

element.on('resetPasscodeSucceed', () => {
  // Handle event
});

cancel

此事件在元素被取消时起火 .

类型

element.on('cancel', () => void);

示例

element.on('cancel', () => {
  // Handle cancel event
});

error

当元素内发生错误时,此事件会起火 .

类型

element.on('error', (data: { code: string, message?: string }) => void);

示例

element.on('error', (data: { code: string; message?: string }) => {
  // Handle error event
});

他们

我们可以配置元素 以反映你的品牌的色调和标志。 联系您的 Airwalex 账户管理器, 以便按照您的业务要求定制 .

变化

1.36.0 (简体中文) (2026-10-21) (中文(简体) )

特征

• 暴露在受益表格选项上[GCORP-4447] (中文(简体) )e9bf674 (单位:千美元)(中文(简体) )

1.35.2 国家 (2026-09-15) (中文(简体) )

错误修正

• [OSAI-13450] 增加平衡要素(32d9f65 (英语)(中文(简体) )

1.35.1 国家 (2026-08-04) (中文(简体) )

错误修正

• [GTA-4230] 制作发布-npm版本的凸起同位素((ac4a221) (单位:千美元)(中文(简体) )
• [OSAI-13217] 将国家防范机制更名为国家防范机制07a61b7 (韩语)(中文(简体) )

1.35.0 (中文(简体) ) (2026-07-08) (中文(简体) )

特征

• [OSAI-13212] (英语). 支持部署到 SG 预览f399 bab (中文(简体) )(中文(简体) )

1.3.4.0 导弹 (2026-06-29) (中文(简体) )

特征

• ADV-7443 从远程重新装入计费类型(57cfc8a (中文(简体) )(中文(简体) )

1.27.2 (中文(简体) ) (2025-11-07) (中文(简体) )

错误修正

• [AJS-184] 添加输入日志(30b4b87 (中文(简体) )(中文(简体) )

1.27.1 国家 (2025-11-04) (中文(简体) )

错误修正

• [AJS-184] 预选PA脚本(63155d7 (中文(简体) )(中文(简体) )
• [AJS-184] 支持预选支付脚本((单位:千美元)(中文(简体) )

1.27.0 (简体中文) (2025-10-21) (中文(简体) )

特征

• [PACST-6601] 更改 kr 牌元素命名, 2 为 2 ()d58abac (中文(简体) )(中文(简体) )

1.26.0 (简体中文) (2025-09-26) (中文(简体) )

特征

• [PACST-6601] 添加 kr 牌分块元素( K)13个c1f27(中文(简体) )

1.25.0 (简体中文) (2025-09-08) (中文(简体) )

特征

• 更新跑道机(双子座20(中文(简体) )
• 更新类型( e)963343b (单位:千美元)(中文(简体) )

1.2.4.2 国家 (2025-07-22) (中文(简体) )

错误修正

• [AJS-179] 优化出错日志(80a6e6d (韩语)(中文(简体) )

1.24.1 国家 (2025-07-18) (中文(简体) )

错误修正

• @ airwallex/ 组件运行于 Next.js ()f63c268 (英语)(中文(简体) )
• 隐藏未使用类型( n)37f8bd7 (中文(简体) )(中文(简体) )

1.24.0 (简体中文) (2025-07-16) (中文(简体) )

特征

• [OBD-5984] 更新 README.md 以包含 “ mrmRfi” (98e8894 (英语)(中文(简体) )

1.23.0 (韩语) (2025-07-15) (中文(简体) )

特征

• [OBD-5739] 在 KycRfi 中添加 MrmRfi 支持处理事件((单位:千美元)(中文(简体) )
• [OBD-5739] 用通用的EventCode类型参数加强KycRfi事件处理,改进类型推论(b772056 (韩语)(中文(简体) )
• [OBD-5739] 在生态系统App中实施MrmRfi支持((简体中文)(中文(简体) )

1.22.3 国家 (2025-07-04) (中文(简体) )

错误修正

• [AJS-178] 更新错误消息 (0a87f17 (韩语)(中文(简体) )

1.22.2 (中文(简体) ) (2025-07-04) (中文(简体) )

错误修正

• [AJS-178] 添加无效元素类型错误(b70a0c7 (韩语)(中文(简体) )

1.2.2.1 国家 (2025-07-03) (中文(简体) )

错误修正

• [AJS-178] 更新错误消息 ((单位:千美元)(中文(简体) )

1.22.0 (中文(简体) ) (2025-07-03) (中文(简体) )

错误修正

• 管道(12个bda3a(中文(简体) )

特征

• 更新缓存策略( e)fa5f3ca (法语)(中文(简体) )

1.21.0 国家 (2025-06-11) (中文(简体) )

特征

• [OBD-5580] 更新类型((单位:千美元)(中文(简体) )

1.20.1 联合国 (2025-05-30) (英语)

错误修正

• [OBD-5489]支助贷款87b53f3 (韩语)(中文(简体) )

1.2.0 (中文(简体) ) (2025-05-15) (中文(简体) )

特征

• [DEVX-1874] 更新 pa 类型: 添加 appance 选项 (0daa844 (英语)(中文(简体) )

1.19.1 联合国 (2025-04-22) (中文(简体) )

错误修正

• [OBD-522] 选项中的主题类型(0d05e2a (中文(简体) )(中文(简体) )
• 添加 sca 回归测试 (08d5f83 (英语)(中文(简体) )

1.19.0 (中文(简体) ) (2025-04-08) (中文(简体) )

特征

• 更新类型( e)2407fd8 (中文(简体) )(中文(简体) )
• 更新类型( e)221283b (中文(简体) )(中文(简体) )

1.18.0 (简体中文) (2025-02-24) (中文(简体) )

特征

• 地址:5824889 (英语)(中文(简体) )
• 更新(71个f0e56(中文(简体) )
• 更新读取器。 (01e85be (英语)(中文(简体) )

1.17.2 联合国 (2025-01-14) (中文(简体) )

错误修正

• [osai-1129] 更新支付类型来源和sca类型(221e19d (英语)(中文(简体) )

1.17.1 联合国 (2025-01-13) (中文(简体) )

错误修正

• 更新 sdk 名称 (638190c (中文(简体) )(中文(简体) )

1.17.0 (简体中文) (2024-12-27) (中文(简体) )

特征

• 添加缺失的 langKey (6d81f49 (英语)(中文(简体) )
• 添加 ro & pt 语言( p)02a9add (英语)(中文(简体) )
• 格式 (单位:千美元)df90de4 请检查url=值 (帮助)(中文(简体) )

1.16.0 (简体中文) (2024-12-19) (中文(简体) )

特征

• 添加启用 Element 选项 (239af6a (中文(简体) )(中文(简体) )
• 地址注释( e)e98562e (中文(简体) )(中文(简体) )

1.15.0 (韩语) (2024-12-16) (中文(简体) )

特征

• 更改 pa 静态url (0ed7b86 (英语)(中文(简体) )

1.1.4.2 国家 (2024-10-21) (中文(简体) )

错误修正

• [AJS-161] 更新支付部分类型(5e22d39 (英语)(中文(简体) )

1.14.1 国家 (2024-10-18) (中文(简体) )

错误修正

• [PFF-3463] README列刊 (中文(简体) )902c9c9 (英语)(中文(简体) )

1.14.0 (中文) (2024-10-16) (中文(中国大陆) )

特征

• [osai-10331] 在 sdk 中添加税务表(9763153 (英语)(中文(简体) )

1.13.0 (韩语) (2024-09-12) (中文(简体) )

特征

• 更新类型( e)30633a1 (韩语)(中文(简体) )

1.1.2.2 国家 (2024-09-12) (中文(简体) )

错误修正

• [AJS-150] 更新读取(单位:千美元)(中文(简体) )

1.12.1 国家 (2024-09-11) (中文(简体) )

错误修正

• [osai-10516] 将一些 sca 属性重命名为 sca (a2dea75 (中文(简体) )(中文(简体) )

1.12.1 国家 (2024-09-11) (中文(简体) )

错误修正

• [osai-10516] 将一些 sca 属性重命名为 sca (a2dea75 (中文(简体) )(中文(简体) )

1.12.0 国家 (2024-09-10) (中文(简体) )

特征

• [osai-10516] 在 sca 设置中添加移动信息成功事件(a47522a (单位:千美元)(中文(简体) )

1.11.0 国家 (2024-09-06) (中文(简体) )

特征

• [AJS-150] 支持本地化并贬低langKey(b933de2 (单位:千美元)(中文(简体) )

1.10.2 国家 (2024-08-27) (中文(简体) )

错误修正

• [OBD-2931] 清理付款 Kyb打字(4055117 (英语)(中文(简体) )

1.10.1 国家 (2024-08-26) (中文(简体) )

错误修正

• 更新文件及类型(031f3fe (英语)(中文(简体) )

1.10.1 国家 (2024-08-16) (中文(中国大陆) )

错误修正

• 更新文件及类型(031f3fe (英语)(中文(简体) )

1.1.0 (中文(简体) ) (2024-08-07) (中文(简体) )

特征

• 更改 PA 静态url (e640c5a (单位:千美元)(中文(简体) )

1.9.2 (中文(简体) ) (2024-08-06) (中文(中国大陆) )

错误修正

• [AJS-141] 更新付款f7b8fdc (中文(简体) )(中文(简体) )

1.9.1 国家 (2024-08-05) (中文(简体) )

错误修正

• [AJS-139] 在js doc上添加取消事件解释(J页:1(中文(简体) )

1.9.0 导弹 (2024-07-30) (中文(简体) )

特征

• [AJS-67] 预选脚本(e82e86d (中文(简体) )(中文(简体) )

1.8.2 国家 (2024-07-29) (中文(简体) )

错误修正

• 更新 README (f2b4ed5 (英语)(中文(简体) )

1.8.1 国家 (2024-07-18) (中文(中国大陆) )

错误修正

• 组合后缺少命名空间导出( n)(单位:千美元)(中文(简体) )

1.8.0 国家 (2024-07-18) (中文(中国大陆) )

特征

• [osai-10139] 更新接口和文档并添加sca函数(00f2克达(中文(简体) )
• 以命名空间来覆盖所有域类型( n)页:1(中文(简体) )

1.7.1 联合国 (2024-06-28) (中文(简体) )

错误修正

• [OBD-2389]固定管道((单位:千美元)(中文(简体) )

1.7.0 (单位:千美元) (2024-06-28) (中文(简体) )

特征

• [OBD-2389] 更新类型(咖啡馆702c(中文(简体) )

1.6.0 (简体中文) (2024-06-28) (中文(简体) )

错误修正

• [OBD-2083] (英语). 添加可支付组件( E)f913354 (中文(简体) )(中文(简体) )

特征

• 添加sca (页:1(中文(简体) )

1.5.0 (中文(简体) ) (2024-05-13) (中文(简体) )

特征

• 添加 perf 日志 (广告526ef(中文(简体) )

1.4.16 信息技术 (2024-04-17) (中文(中国大陆) )

错误修正

• [OSAI-9559]日志脚本上载时间(1590e47 (英语)(中文(简体) )

1.4.15 国家 (2024-04-07) (中文(简体) )

错误修正

• [OSAI-9436]上传到多克克克克克克克克克克克5c4a7d4 国家(中文(简体) )

1.4.14 (中文(简体) ) (2024-04-03) (中文(中国大陆) )

错误修正

• [OSAI-9436]水桶版本 (中文(简体) )9170595 (英语)(中文(简体) )

1.4.13 国家 (2024-04-03) (中文(中国大陆) )

错误修正

• [OSAI-9436]水桶版本 (中文(简体) )第2条cb6a3b(中文(简体) )

1.4.12 (中文(简体) ) (2024-04-03) (中文(中国大陆) )

错误修正

• [OSAI-9436]上传多桶页:1(中文(简体) )

1.4.11 (中文(简体) ) (2024-03-08) (中文(简体) )

错误修正

• 强化 " 更改日志 " 更新的CI(37094cb (中文(简体) )(中文(简体) )