@finapi/web-form

中文文档
2.48.0发布于 2026/06/29ISCTypeScriptCommonJS零依赖近 30 天下载 3.4万

Library for integrating the finAPI Web Form

原始使用文档

Web Form 2.0

We have revised and improved the previous finAPI Web Form. The new finAPI Web Form 2.0 offers additional advantages for both you and your customers.

  • Easy integration: fewer API endpoints and simplified interface handling (XS2A, FINTS, Scraper) in the background on the finAPI side, resulting in less effort and testing
  • UX-driven: Improved user experience through optimized UX/UI
  • Integrated bank search
  • Integrated SCA (Strong Customer Authentication methods)
  • White-labeling function: use your logo, colors, and font and much more
  • Responsive design for desktop, tablet and smartphone
  • Easy embedding in web applications and mobile applications
  • Multilingual: currently supported languages are CS, DE, EN, ES, FR, IT, NL, PL, RO, SK, and TR

When to use the Web Form?

With finAPI’s Web Form 2.0 REST Services, we aim to provide the best possible version of the Web Form for customers to present to end users for their use cases. But when should you use the Web Form?

As a customer of finAPI services, the regulatory requirements of the European PSD2 regulation (ZAG law in Germany) may apply to you (please consult your lawyer or national financial regulator for advice).

If you do not have the permission or license from your national financial regulator to provide PSD2-relevant services, the German regulator requires you to meet the minimum requirements for not processing bank credentials or accessing banks directly. To enable finAPI customers without a PSD2 license from their regulator to meet this minimum requirement, we created the finAPI PSD2 Web Form. Please note that additional regulatory requirements may apply to your business and that finAPI cannot provide legal advice. Here is an overview of the different regulatory permissions and their implications for the use of the finAPI Web Form:

Customer’s Regulatory permissionWeb Form required for
No regulatory permission- import/update bank connection
- edit bank connection (editing end-user bank credentials)
- execute SEPA Money Transfer (SCT)
- execute SEPA Direct Debit (SDD)
Payments (PIS/ZAD)- import/update bank connection (batch updates)
- edit bank connection (editing end-user bank credentials)
Account Information (AIS/KID)- execute SEPA Money Transfer (SCT)
- execute SEPA Instant Money Transfer (SCT-Inst)
- execute SEPA Direct Debit (SDD)
Fully regulated (both AIS/KID + PIS/ZAD)- optional (no Web Form required for any finAPI service)

Further information

Information for developers (API references and the public documentation) can be found in the finAPI Developer Portal.

版本与发布记录

@finapi/web-form 共发布 68 个版本,首次发布于 2021/03/29;过去 12 个月发布了 11 个版本。

版本发布日期距今
2.48.0latest2026/06/294 个月前
2.48.0-alpha.0alpha2026/06/294 个月前
2.47.0-alpha.02026/05/285 个月前
2.46.02026/05/285 个月前
2.46.0-alpha.02026/05/076 个月前
2.45.0-alpha.02026/05/066 个月前

关于 @finapi/web-form 的常见问题

@finapi/web-form 是什么?

Library for integrating the finAPI Web Form

如何安装 @finapi/web-form?

在项目目录运行 npm install @finapi/web-form,或使用 pnpm add / yarn add / bun add。

@finapi/web-form 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@finapi/web-form 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@finapi/web-form 可以商用吗?

@finapi/web-form 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@finapi/web-form 的下载量有多少?

根据 npm 官方下载统计,@finapi/web-form 在 2026/10/15 – 2026/11/13 这 30 天内被下载 33,682 次,日均约 1,123 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@finapi/web-form 还在维护吗?

最新版本 2.48.0 发布于 2026/06/29(4 个月前);至今共发布 68 个版本,其中过去 12 个月发布了 11 个;首次发布于 2021/03/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。