Billium

本地服务

billium.to金融数据019 周前更新

代码仓库访问官网

关于 Billium

Billium 提供非托管加密货币支付 SDK，以及供商户管理发票和 Webhook 的 MCP 服务。其 MCP 软件包可让 Claude、Cursor 等 MCP 主机执行这些管理操作。

主要功能

01管理加密货币发票
02管理 Webhook
03验证 Webhook 签名
04Billium 的 Node.js SDK

适用场景

01创建和管理付款发票
02管理商户 Webhook
03验证收到的 Webhook 签名

MCP 相关

@billium/mcp 服务可供 MCP 客户端管理 Billium 发票和 Webhook。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "billiumhq-billium": {
      "command": "npx",
      "args": [
        "-y",
        "@billium/mcp"
      ],
      "env": {
        "BILLIUM_API_KEY": "<BILLIUM_API_KEY>",
        "BILLIUM_MERCHANT_ID": "<BILLIUM_MERCHANT_ID>",
        "BILLIUM_BASE_URL": "<BILLIUM_BASE_URL>"
      }
    }
  }
}

启动命令npx -y @billium/mcp

需要配置的环境变量

BILLIUM_API_KEY密钥Secret API key (sk_...), from the dashboard under Settings → Developer → API keys.

BILLIUM_MERCHANT_IDMerchant ID (mer_...).

BILLIUM_BASE_URLOverride the API base URL (testing / staging environments).

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npm@billium/mcp0.1.3stdio

工具

收录的工具列表 · 更新于 3 周前

参数	类型	必填	说明
name	string	是	账单显示名称，例如 "Order #1234"。
currency	string	否	货币代码，例如 'USD'。默认为 USD。
rawAmount	number	是	以指定货币表示的金额（例如 99.99）。
description	string	否
redirectUrl	string	否	成功付款后将客户重定向到的 URL。
customerName	string	否
customerEmail	string	否
idempotencyKey	string	否	可选的去重键。若省略，则会生成 UUID，确保重试不会创建重复账单。
customerAddress	string	否
customerPhoneNumber	string	否

详细介绍

Billium SDK

BIllium 的官方客户端库，支持非托管式加密货币支付、发票和 Webhook。

软件包

软件包	版本	描述
`@billium/node`		Node.js SDK — 发票、Webhook 签名验证、Webhook 管理
`@billium/mcp`		MCP 服务 — 在 Claude、Cursor 和任何 MCP 宿主中管理发票和 Webhook

随着其他语言的 SDK 发布，它们也将作为同级目录放在 packages/ 下。

快速开始

npm install @billium/node

import { Billium } from '@billium/node';

const billium = new Billium({
  apiKey: process.env.BILLIUM_API_KEY,
  merchantId: process.env.BILLIUM_MERCHANT_ID,
  webhookSecret: process.env.BILLIUM_WEBHOOK_SECRET,
});

const invoice = await billium.invoices.create(
  { name: 'Order #1234', rawAmount: 99.99 },
  { idempotencyKey: crypto.randomUUID() },
);

完整的 Node.js SDK 参考请参阅 packages/node/README.md。

仓库结构

.
├── packages/
│   ├── node/              # @billium/node — TypeScript Node.js SDK
│   │   ├── src/           # Source
│   │   ├── tests/         # Vitest test suite
│   │   ├── README.md      # Public-facing docs (rendered on npmjs.com)
│   │   └── CHANGELOG.md   # Per-release notes
│   └── mcp/               # @billium/mcp — Model Context Protocol server
│       ├── src/           # Server + tool definitions
│       ├── tests/         # Vitest in-memory round-trip suite
│       └── README.md      # Host setup (Claude Code, Cursor, …)
└── .github/
    ├── workflows/         # CI + release automation
    ├── ISSUE_TEMPLATE/    # Bug + feature request forms
    └── CODEOWNERS         # Review requirements

开发

这是一个 npm 工作区。请在仓库根目录运行脚本：

npm install        # installs all workspace packages
npm run lint       # typechecks every package (src + tests)
npm test           # runs every package's test suite
npm run build      # builds every package

如需开发特定软件包，也可以运行 cd packages/node && npm <script>。

发布

推送 v*.*.* 标签后，GitHub Actions 会将版本发布到 npm：

将 packages/node/package.json#version 和 packages/node/src/version.ts#SDK_VERSION 更新为新版本（CI 会验证两者是否一致）。
在 packages/node/CHANGELOG.md 中添加一个章节，说明变更内容。
在 main 上提交版本更新。
创建并推送标签：git tag v1.0.1 && git push origin v1.0.1。
发布工作流会依次运行 lint、test、build，然后使用来源证明运行 npm publish。