开发者访问 · 已上线

银行对账单转换 API

通过简单的 REST API,从任何银行对账单 PDF 中提取结构化的 JSON 交易数据。基于驱动 PivotBank 的同一解析引擎构建, 支持 1000 多家银行、多页处理、零配置集成。

简单集成

一个端点。结构化 JSON。

POST 一个 PDF,即可获得干净、结构化的交易数据。每个响应都包含银行名称、对账单周期,以及包含规范化日期、描述、借记、贷记和余额字段的完整交易数组。

  • 所有银行的字段名称一致
  • 缺失的借记/贷记使用 null 值(绝不含糊)
  • ISO 日期格式输出
  • 自动检测银行名称和周期
  • 包含页数以便用量跟踪
POST /api/v1/convert
Authorization: Bearer {API_KEY}
Content-Type: multipart/form-data

# Response: 200 OK
{
  "bankName": "HSBC",
  "accountNumber": "1234 5678",
  "period": "Jan 2025, Mar 2025",
  "pageCount": 3,
  "transactionCount": 2,
  "reconciliation": {
    "verified": true,
    "status": "ok",
    "opening": 2384.21,
    "closing": 6841.22,
    "expectedClosing": 6841.22,
    "difference": 0,
    "totalIn": 4500.00,
    "totalOut": 42.99
  },
  "transactions": [
    {
      "date": "2025-01-03",
      "description": "AMAZON.CO.UK",
      "debit": 42.99,
      "credit": null,
      "balance": 2341.22
    },
    {
      "date": "2025-01-07",
      "description": "SALARY - ACME LTD",
      "debit": null,
      "credit": 4500.00,
      "balance": 6841.22
    }
  ]
}

如何调用

    01

    订阅 Pro

    API 访问需要有效的 Pro 订阅;接口会拒绝其他账户的密钥。

    02

    创建 API 密钥

    在账户页面生成。密钥只显示一次,且只保存它的哈希值。

    03

    POST 提交 PDF

    带上 Authorization: Bearer 请求头,把 PDF 发送到 /api/v1/convert,可以是 "file" 字段的 multipart form-data,也可以是 application/pdf 请求体,最大 15 MB。

    04

    读取 JSON

    200 响应返回 bankName、accountNumber、period、pageCount、transactionCount、一个 reconciliation 对象,以及包含 date、description、debit、credit 和 balance 的 transactions 数组。

谁在使用该 API

会计软件集成

将客户的 PDF 发送到您自己的系统,并接收可直接录入 Xero、QuickBooks 或 Sage 账簿的结构化 JSON, 无需手动重新录入。

金融科技与借贷

为贷款申请自动化负担能力分析。在几秒内解析申请人 3 至 12 个月的对账单,提取收入、经常性支出和余额趋势。

企业自动化

将银行对账单解析集成到内部工作流程中, 合规检查、费用处理、审计支持或自定义财务仪表板。

定价模式

按对账单付费

使用条件

包含在 Pro 中

支持的银行

1000 多家

The API is a Pro feature

Upgrade to Pro to create API keys and convert statements programmatically.

Upgrade to Pro
常见问题

使用这个 API

如何进行认证?

把密钥作为 bearer 令牌发送:Authorization: Bearer pvb_live_... 密钥在本页创建和吊销,该端点需要有效的 Pro 订阅,因此非 Pro 账户上的有效密钥也会以 403 被拒绝。

怎么发送 PDF?

可以用 multipart/form-data,把文件放在名为 "file" 的字段里;也可以用 Content-Type: application/pdf 直接作为请求体发送。同一个端点两种都接受。上限是 15 MB,在读取请求体之前先按声明长度检查,所以过大的文件会以 413 被拒绝,而不是先传完。

会返回什么?

一个 JSON 对象:从对账单中识别出的 bankName、accountNumber、period 和 pageCount,以及 transactionCount 和一个 transactions 数组。每笔交易包含日期、摘要以及 debit、credit 和 balance 字段,某一列确实不存在时返回 null 而不是零。

能读扫描件吗?

不能,这是 API 唯一比网页版受限的地方。浏览器会对扫描件运行 OCR;API 只解析文本层,没有可用文本的对账单会返回 422,要求提供电子版 PDF。如果你的输入包含扫描件,请在浏览器中转换,或与我们联系。

错误码分别是什么意思?

401 表示密钥缺失、无效或已吊销。403 表示密钥有效但账户没有 Pro。400 表示请求体不是可读的 PDF。413 表示超过 15 MB。422 表示 PDF 解析成功但没有得到可用文本,实际中通常意味着扫描件。

用量怎么计算?

每次成功调用记为一次转换,连同页数记录到你的账户,与在浏览器中转换的方式一致。出错的调用不计入。

大批量与企业

需要大批量转换吗?

API 已经上线,包含在 Pro 订阅中。在上方创建一个密钥即可开始发送对账单,这里没有任何排队。

如果你需要大批量转换、想要单独的价格,或希望在动手之前先聊聊集成方案,欢迎联系我们。