# @cabloy/paypal-server-sdk 中文文档

规范地址：https://npmcn.com/package/%40cabloy/paypal-server-sdk/

版本：2\.2\.0
npm 元数据更新时间：2026-03-05T12:04:29.980Z
中文译文更新时间：2026-11-08T23:15:19.080Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cabloy/paypal-server-sdk
原文对照：https://npmcn.com/package/%40cabloy/paypal-server-sdk/?lang=original
项目主页：https://github.com/paypal/PayPal-TypeScript-Server-SDK
源码仓库：https://github.com/paypal/PayPal-TypeScript-Server-SDK

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.3 MB，3486 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.17\.0
- 运行依赖：5 个
- 首次发布：2026-03-05T12:04:29.487Z
- 最新版本发布：2026-03-05T12:04:29.742Z
- 近 30 天下载量：5103（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

与 REST API 互动的 PayPal 的 SDK

## 安装

```sh
npm install @cabloy/paypal-server-sdk
```

也可以使用：`pnpm add @cabloy/paypal-server-sdk`、`yarn add @cabloy/paypal-server-sdk`、`bun add @cabloy/paypal-server-sdk`

## README

# 开始使用 PayPal 服务器 SDK

## 导言

### 重要说明

-   **可用特性 :** 这个SDK目前只包含5个PayPal的API端点. 今后将增加更多的终点和功能.

### 资料

PayPal服务器SDK提供集成访问PayPal REST APIs. API端点分为不同的控制器:

-   命令控制器 : [命令 API v2](https://developer.paypal.com/docs/api/orders/v2/)
-   付款主计长: [付款 API v2](https://developer.paypal.com/docs/api/payments/v2)
-   默认控制器 : [支付方法 Tokens API v3](https://developer.paypal.com/docs/api/payment-tokens/v3/) _在美国才有._
-   交易搜索控制器 : [交易搜索 API v1](https://developer.paypal.com/docs/api/transaction-search/v1/)
-   订阅控制器 : [订阅 API v1](https://developer.paypal.com/docs/api/subscriptions/v1/)

## 安装软件包

从项目目录中运行以下命令以从 npm 安装软件包 :

```bash
npm install @paypal/paypal-server-sdk@2.2.0
```

补充软件包详情见 [@paypal/paypal-server-sdk@2.2.0npm的Npm页面](https://www.npmjs.com/package/@paypal/paypal-server-sdk/v/2.2.0)。 。 。 .

## 初始化 API 客户端

**_说明:_** 可找到客户端的文档 [在这里.](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/client.md)

API 客户端可配置以下参数:

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| 环境 | `Environment` | API环境.  
**默认 : `Environment.Sandbox`** |
| 超时 | `number` | API呼叫暂停.  
_默认_数字 : `0` |
| httpclient 选项 | [`Partial<HttpClientOptions>`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/http-client-options.md) | 稳定配置 http 客户端选项. |
| 不稳定的 Http Client 选项 | `any` | 不稳定可配置的 http 客户端选项 . |
| 记录 | [`PartialLoggingOptions`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/partial-logging-options.md) | 启用日志的日志配置 |
| 客户端证书 | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/auth/oauth-2-client-credentials-grant.md) | 客户端证书对象 |

API客户端可初始化如下:

### 基于代码的客户端初始化

```ts
import { Client, Environment, LogLevel } from '@paypal/paypal-server-sdk';

const client = new Client({
  clientCredentialsAuthCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret'
  },
  timeout: 0,
  environment: Environment.Sandbox,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});
```

### 基于配置的客户端初始化

```ts
import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);
```

见 [基于配置的客户端初始化](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/configuration-based-client-initialization.md) 详细情况.

### 环境客户端初始化

```ts
import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);
```

见 [环境客户端初始化](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/environment-based-client-initialization.md) 详细情况.

## 环境

SDK可以被配置为使用不同的环境来进行API调用. 可用的环境有:

### 字段

| 名称 | 说明 |
| --- | --- |
| 生产 | PayPal 活环境 |
| 沙盒 | **默认** PayPal 沙盒环境 |

## 授权

此API使用以下认证方案.

-   [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/auth/oauth-2-client-credentials-grant.md)

## API 列表

-   [命令](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/controllers/orders.md)
-   [付款](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/controllers/payments.md)
-   [默认](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/controllers/vault.md)
-   [交易搜索](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/controllers/transaction-search.md)
-   [订阅](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/controllers/subscriptions.md)

## SDK 基础设施

### 配置

-   [Httpclient 选项](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/http-client-options.md)
-   [重试配置](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/retry-configuration.md)
-   [代理设置](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/proxy-settings.md)
-   [基于配置的客户端初始化](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/configuration-based-client-initialization.md)
-   [环境客户端初始化](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/environment-based-client-initialization.md)
-   [部分日志选项](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/partial-logging-options.md)
-   [部分请求日志选项](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/partial-request-logging-options.md)
-   [部分响应记录选项](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/partial-response-logging-options.md)
-   [锁定界面](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/logger-interface.md)

### HTTP 密码

-   [Http 请求](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/http-request.md)

### 公用事业

-   [回复](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/api-response.md)
-   [痛苦](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/2.2.0/doc/api-error.md)

## 常见问题

### @cabloy/paypal-server-sdk 是什么？

与 REST API 互动的 PayPal 的 SDK

### 如何安装 @cabloy/paypal-server-sdk？

在项目目录运行 npm install @cabloy/paypal-server-sdk，或使用 pnpm add / yarn add / bun add。

### @cabloy/paypal-server-sdk 支持 TypeScript 吗？

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

### @cabloy/paypal-server-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cabloy/paypal-server-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=14\.17\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cabloy/paypal-server-sdk 可以商用吗？

@cabloy/paypal-server-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cabloy/paypal-server-sdk 的下载量有多少？

根据 npm 官方下载统计，@cabloy/paypal-server-sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 5,103 次，日均约 170 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cabloy/paypal-server-sdk 还在维护吗？

最新版本 2\.2\.0 发布于 2026/03/05（8 个月前）；至今共发布 1 个版本，其中过去 12 个月发布了 1 个；首次发布于 2026/03/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。