API 参考

PaymentKit Node.js SDK 围绕资源进行组织，每个资源都可作为主 payment 客户端对象的一个属性来访问。本 API 参考为所有可用资源提供了全面的指南，详细介绍了它们的方法、参数以及它们返回的数据结构。每个资源部分都包含实用的代码示例，以帮助您快速入门。

有关如何安装和初始化 SDK 的信息，请参阅快速入门指南。

SDK 资源地图#

下图展示了 SDK 的结构以及核心资源之间的关系。

资源#

以下是所有可用 API 资源的列表。选择一个资源以查看其详细文档，包括可用方法、参数和示例。

资源	描述
客户	用于管理客户记录的 API，包括检索、更新和列出。
产品	用于创建、检索、更新和列出产品的 API。
价格	用于管理与产品相关的定价模型的 API，包括创建、检索和库存更新。
支付意图	用于处理支付生命周期的 API，包括创建支付、确认和退款。
支付货币	用于管理支持的支付货币的 API。
支付方式	用于管理支付方式配置和详细信息的 API。
支付链接	用于创建和管理可共享支付链接的 API。
结账会话	用于管理结账会话的 API，这些会话为客户协调支付流程。
订阅	用于管理客户订阅的 API，包括状态、取消和恢复。
订阅项	用于管理订阅中单个项目的 API，包括用量报告。
Webhooks	用于配置和管理 Webhook 端点以接收事件通知的 API。
退款	用于发起和跟踪支付退款的 API。
设置	用于管理各种应用范围的设置（如通知）的 API。
计量器	用于创建和管理计量器以跟踪基于信用的计费的用量事件的 API。
计量事件	用于报告用量事件和检索用量统计的 API。
信用授权	用于向客户发放和管理信用授权的 API。
信用交易	用于列出和汇总客户信用交易历史的 API。

本参考为每个 SDK 资源提供了基础详情。对于面向工作流的示例，例如处理一次性付款或设置订阅，请参阅我们的使用指南。