# @fincode/node 中文文档

规范地址：https://npmcn.com/package/%40fincode/node/

版本：1\.1\.0
npm 元数据更新时间：2024-10-02T08:11:13.177Z
中文译文更新时间：2026-11-14T18:34:45.924Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fincode/node
原文对照：https://npmcn.com/package/%40fincode/node/?lang=original
项目主页：https://www.fincode.jp/
源码仓库：https://github.com/fincode-byGMO/fincode-sdk-node

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

- 包体积（解压后）：524 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.0\.0
- 运行依赖：3 个
- 首次发布：2024-02-19T07:31:21.715Z
- 最新版本发布：2024-10-02T08:11:12.969Z
- 近 30 天下载量：144868（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点编码。

## 安装

```sh
npm install @fincode/node
```

也可以使用：`pnpm add @fincode/node`、`yarn add @fincode/node`、`bun add @fincode/node`

## README

# 由 GMO 为 fincode 编写的 Node.js SDK 库

节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点编码。

\*##Node.js###fincode########节点[eS 模块的条码](https://github.com/fincode-byGMO/fincode-sdk-js.git)を利用できます。

## 开始

节点的"npm""fincode.js"。

```bash
$ npm i @fincode/node

# yarnやpnpmなど、npmと互換のあるパッケージ管理システムによるインストールも可能です。
$ yarn add @fincode/node
```

## 使用量

### 1\. 鳍编码 .

亚军。

APIキーは**シークレットキー**である必要があります。

### 2\. 国家

开始 {} `@fincode/node` をプロジェクトにインストールします。

### 3\. fincode インスタンスの作成

`createFincode`缩写。

```typescript
import { createFincode } from "@fincode/node"

const fincode = createFincode({
    apiKey: "m_****_**********", // Secret key
    isLiveMode: true,  // fincode Environment. true: Live mode, false: Test mode. default: false
    
    // Optional,
    options: {   
        // API Version
        version: "20211101",
        // Timeout
        timeout: 10000,
        // Proxy
        proxyAgent: "http://url.to.proxy:8080"
    }
})

(async () => {
    
    // Register a payment with idempotent key
    const createdPayment = await fincode.payments.create({
        pay_type: "Card",
        job_code: "CAPTURE",
        amount: "3000"
    }, {
        idempotentKey: "{{idempotent key}}"
    })
    // Execute a payment
    const executedPayment = await fincode.payment.execute(
        payment.id,
        {
            pay_type: createdPayment.pay_type,
            access_id: createdPayment.access_id,
            customer_id: "{{id of customer}}",
            card_id: "{{id of customer's card}}",
        }
    )
    // Retrieve a payment
    const payment = await fincode.payments.retrieve(executedPayment.id, { pay_type : "Card" })

    // Retrieve a list of payments
    const payments = await fincode.payments.retrieveList({
        pay_type: "Card",
        limit: 10,
        page: 1,
        total_amount_min: 1000,
        total_amount_max: 10000,
    })
})()

```

## 调用指针 API

fincode-Qincode API-X。 fincode QQAPI++++。

### クエリパラメーターとヘッダー

亚军。 ヘッダー情報は下記のようなオブジェクトに格納します。

```typescript
{
    // idempotent_key に対応。冪等キー。
    idempotentKey?: string | undefined;
    // Tenant-Shops-Id に対応。テナントショップID。
    tenantShopId?: string | undefined;
    // Content-Type に対応。コンテンツタイプ。
    contentType?: string | undefined;
}
```

API= API=。 クエリパラメーターは下記のようなオブジェクトに格納します。

```typescript
{
    limit?: string | number | null
    page?: string | number | null
    count_only?: boolean | null
    // その他APIによって異なるクエリパラメーター
}
```

### 支付 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 決済 | 登録 | `POST /v1/payments` | `fincode.payments.create(requestBody)` |
|  | 実行 | `PUT /v1/payments/{id}` | `fincode.payments.execute(id, requestBody)` |
|  | 一覧取得 | `GET /v1/payments` | `fincode.payments.retrieveList({ pay_type: payType})` |
|  | 取得 | `GET /v1/payments/{id}` | `fincode.payments.retrieve(id, { pay_type: payType})` |
|  | 売上確定 | `PUT /v1/payments/{id}/capture` | `fincode.payments.capture(id, requestBody)` |
|  | キャンセル | `PUT /v1/payments/{id}/cancel` | `fincode.payments.cancel(id, requestBody)` |
|  | 再オーソリ | `PUT /v1/payments/{id}/auth` | `fincode.payments.reauthorize(id, requestBody)` |
|  | 金額変更 | `PUT /v1/payments/{id}/change` | `fincode.payments.changeAmount(id, requestBody)` |
|  | 3Dセキュア2.0認証実行 (カード決済) | `PUT /v1/secure2/{access_id}` | `fincode.payments.execute3DSecureAuth(access_id, requestBody)` |
|  | 3Dセキュア2.0認証実行結果取得 (カード決済) | `GET /v1/secure2/{access_id}` | `fincode.payments.retrieve3DSecureAuthResult(access_id)` |
|  | 認証後決済実行(カード決済) | `PUT /v1/payments/{id}/secure` | `fincode.payments.executeAfter3DSecureAuth(id, requestBody)` |
|  | バーコード取得(コンビニ決済) | `PUT /v1/payments/{id}/barcode` | `fincode.payments.generateKonbiniPaymentBarcode(id, requestBody)` |

### 客户API( QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 顧客 | 登録 | `POST /v1/customers` | `fincode.customers.create(requestBody)` |
|  | 页:1 | `PUT /v1/customers/{id}` | `fincode.customers.update(id, requestBody)` |
|  | 一覧取得 | `GET /v1/customers` | `fincode.customers.retrieveList()` |
|  | 取得 | `GET /v1/customers/{id}` | `fincode.customers.retrieve(id)` |
|  | 削除 | `DELETE /v1/customers/{id}` | `fincode.customers.delete(id)` |

### 卡片 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| カード | 登録 | `POST /v1/customers/{customer_id}/cards` | `fincode.cards.create(customerId, requestBody)` |
|  | 页:1 | `PUT /v1/customers/{customer_id}/cards/{id}` | `fincode.cards.update(customerId, id, requestBody)` |
|  | 一覧取得 | `GET /v1/customers/{customer_id}/cards` | `fincode.cards.retrieveList(customerId)` |
|  | 取得 | `GET /v1/customers/{customer_id}/cards/{id}` | `fincode.cards.retrieve(customerId, id)` |
|  | 削除 | `DELETE /v1/customers/{customer_id}/cards/{id}` | `fincode.cards.delete(customerId, id)` |

### API计划( QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| プラン | 登録 | `POST /v1/plans` | `fincode.plans.create(requestBody)` |
|  | 页:1 | `PUT /v1/plans/{id}` | `fincode.plans.update(id, requestBody)` |
|  | 一覧取得 | `GET /v1/plans` | `fincode.plans.retrieveList()` |
|  | 取得 | `GET /v1/plans/{id}` | `fincode.plans.retrieve(id)` |
|  | 削除 | `DELETE /v1/plans/{id}` | `fincode.plans.delete(id)` |

### 订阅 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| サブスクリプション | 登録 | `POST /v1/subscriptions` | `fincode.subscriptions.create(requestBody)` |
|  | 页:1 | `PUT /v1/subscriptions/{id}` | `fincode.subscriptions.update(id, requestBody)` |
|  | 一覧取得 | `GET /v1/subscriptions` | `fincode.subscriptions.retrieveList()` |
|  | 取得 | `GET /v1/subscriptions/{id}` | `fincode.subscriptions.retrieve(id)` |
|  | 解約 | `DELETE /v1/subscriptions/{id}` | `fincode.subscriptions.cancel(id)` |
| サブスクリプション結果 | 一覧取得 | `GET /v1/subscriptions/{id}/result` | `fincode.subscriptions.retrieveResultList(id)` |

### 会话 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 卢尔 | 作成 | `POST /v1/sessions` | `fincode.paymentSessions.create(requestBody)` |
| 卢尔 | 作成 | `POST /v1/card_sessions` | `fincode.cardRegistrationSessions.create(requestBody)` |

### 支付批量 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 一括決済 | 登録 | `POST /v1/payments/bulk` | `fincode.bulkPayments.create(pay_type, process_plan_date, file, file_name)` |
|  | 一覧取得 | `GET /v1/payments/bulk` | `fincode.bulkPayments.retrieveList()` |
|  | 削除 | `DELETE /v1/payments/bulk/{id}` | `fincode.bulkPayments.delete(id)` |
| 一括決済詳細情報 | 一覧取得 | `GET /v1/payments/bulk/{id}` | `fincode.bulkPayments.retrieveDetailList(id)` |

### API 平台 (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| プラットフォーム | 一覧取得 | `GET /v1/platforms` | `fincode.platforms.retrieveList()` |
|  | 取得 | `GET /v1/platforms/{id}` | `fincode.platforms.retrieve(id)` |
|  | 页:1 | `PUT /v1/platforms/{id}` | `fincode.platforms.update(id, requestBody)` |

### 平台账户 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| プラットフォーム売上 | 一覧取得 | `GET /v1/platform_accounts` | `fincode.platformAccounts.retrieveList()` |
|  | 取得 | `GET /v1/platform_accounts/{id}` | `fincode.platformAccounts.retrieve(id)` |
| プラットフォーム売上サマリー | 一覧取得 | `GET /v1/platform_accounts/{id}/summary` | `fincode.platformAccounts.retrieveSummaryList(id)` |

### 租户API( QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| テナント | 一覧取得 | `GET /v1/tenants` | `fincode.tenants.retrieveList()` |
|  | 取得 | `GET /v1/tenants/{id}` | `fincode.tenants.retrieve(id)` |
|  | 新規作成(新規ユーザー) | `POST /v1/tenant_entries` | `fincode.tenants.createWithNewUser(requestBody)` |
|  | 新規作成(既存ユーザー) | `POST /v1/tenant_entries` | `fincode.tenants.createWithExistingUser(requestBody)` |
| テナント本番環境申請情報 | 取得 | `GET /v1/contracts/examinations_v2/tenants/{id}` | `fincode.tenants.retrieveExaminationInfoV2(id)` |
|  | 页:1 | `PUT /v1/contracts/examinations_v2/tenants/{id}` | `fincode.tenants.updateExaminationInfoV2(id, requestBody)` |
| テナント契約情報 | 取得 | `GET /v1/contracts/{id}` | `fincode.tenants.retrieveContract(id)` |
| 本番環境 | 申請 | `POST /v1/contracts/examinations` | `fincode.tenants.requestExamination(requestBody)` |
| 審査ファイル | アップロード |  |  |
| テナント決済手段追加 | 申請 |  |  |

### 账户 API (QQAPI)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 売上入金 | 一覧取得 | `GET /v1/accounts` | `fincode.accounts.retrieveList()` |
|  | 取得 | `GET /v1/accounts/{id}` | `fincode.accounts.retrieve(id)` |
| 売上入金詳細 | 取得 | `GET /v1/accounts/{id}/detail` | `fincode.accounts.retrieveDetailList(id)` |

### Webhook 设置 API (Webhook $ 1 API)

| API 密码 |  | 網址 | 呼び出し方 |
| :-- | :-- | :-- | :-- |
| 网络hook (%) | 登録 | `POST /v1/webhook_settings` | `fincode.webhookSettings.create(requestBody)` |
|  | 一覧取得 | `GET /v1/webhook_settings` | `fincode.webhookSettings.retrieveList()` |
|  | 取得 | `GET /v1/webhook_settings/{id}` | `fincode.webhookSettings.retrieve(id)` |
|  | 页:1 | `PUT /v1/webhook_settings/{id}` | `fincode.webhookSettings.update(id, requestBody)` |
|  | 削除 | `DELETE /v1/webhook_settings/{id}` | `fincode.webhookSettings.delete(id)` |

## 所需资源

翻译:。

| 環境 | バージョン |
| :-- | :-- |
| 节点.js | \>=12.0.0 |

## 常见问题

### @fincode/node 是什么？

节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点/节点编码。

### 如何安装 @fincode/node？

在项目目录运行 npm install @fincode/node，或使用 pnpm add / yarn add / bun add。

### @fincode/node 支持 TypeScript 吗？

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

### @fincode/node 支持 ESM 还是 CommonJS？

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

### @fincode/node 需要什么版本的 Node\.js？

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

### @fincode/node 可以商用吗？

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

### @fincode/node 的下载量有多少？

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

### @fincode/node 还在维护吗？

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