# @changelly/fiat-api-sdk-node 中文文档

规范地址：https://npmcn.com/package/%40changelly/fiat-api-sdk-node/

版本：1\.0\.3
npm 元数据更新时间：2024-01-25T14:28:39.222Z
中文译文更新时间：2026-11-09T10:16:21.027Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：86 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-01-22T14:23:07.537Z
- 最新版本发布：2024-01-25T14:28:39.066Z
- 近 30 天下载量：3902（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

Changelly Fiat API 的节点Js SDK

## 安装

```sh
npm install @changelly/fiat-api-sdk-node
```

也可以使用：`pnpm add @changelly/fiat-api-sdk-node`、`yarn add @changelly/fiat-api-sdk-node`、`bun add @changelly/fiat-api-sdk-node`

## README

# 用于 Typescript 和 Javascript 的 Changelly Fiat API SDK

这个SDK允许你和 [变化中的菲亚特 API](https://fiat-api.changelly.com/docs/) 在JavaScript和TypeScript中。 JavaScript开发者会找到一个功能齐全的库,其功能是方便的,可以将Tangelly fiat API内的所有方法调用自动化;使用TypeScript的开发者会找到对严格类型的丰富定义.

# 使用这个 SDK

1.  联合国 [变化中的网站](https://changelly.com/) 如果你还没有账户的话.
2.  给我们写信 [psp@changelly.com (英语)](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/psp@changelly.com) 以获取 API 密钥。 指定您在 Changelly 网站上注册的电子邮件 .

**说明.** 如果你对SDK的整合有任何疑问, 不要犹豫,给我们写信 [psp@changelly.com (英语)](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/psp@changelly.com)。 。 。 .

这个教程会引导您通过创建项目的基础, 使用 Changelly Fiat API SDK .

1.  首先运行以下命令以创建默认 `package.json` 文件 :

```bash
> npm init --y
```

2.  如果您选择使用TypeScript,现在可以在此工程中添加TypeScript特性. 以下步骤将安装 TypeScript, 创建 `tsconfig.json` 文件,并获取大多数节点JS内置类型:

```bash
> npm install typescript
> npx tsc --init
> npm install -D @types/node
```

3.  通过节点包管理器将 Changelly Fiat API SDK 添加到您的项目中 :

```bash
> npm install @changelly/fiat-api-sdk-node
```

4.  设置环境变量的 API 密钥, 如 `CHANGELLY_PRIVATE_KEY` 财务报告和审定财务报表 `CHANGELLY_PUBLIC_KEY` 以便它不会致力于源控制.
5.  创建基本 `index.ts` 您创建 Changelly Fiat API 客户端的项目的文件 :

```typescript
import { ChangellyFiatClient } from "@changelly/fiat-api-sdk-node";

const client = new ChangellyFiatClient({
  privateKey: process.env["CHANGELLY_PRIVATE_KEY"],
  publicKey: process.env["CHANGELLY_PUBLIC_KEY"],
});
```

6.  拨打API并检查结果 :

```typescript
const providers = await client.getProviderList();
const currencies = await client.getCurrencyList();

console.log({ providers, currencies });
```

7.  更多信息见 [文档](https://fiat-api.changelly.com/docs/#tag/Integration-guide/SDK)。 。 。 .

# API 参考

## 千变万化的密钥

Changelly Fiat API Node.js SDK类.

### 构造器

创建 ChangellyFiatClient 实例 .

```typescript
new ChangellyFiatClient(
  params: ChangellyFiatClientParams
): ChangellyFiatClient
```

**参数**

-   **段落**数字 : [_千变万化的图像_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyfiatclientparams)

**回返** [_千变万化的密钥_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyfiatclient)

### 方法

-   [签名](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-buildsignature)
-   [校验命令回调符号](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-validateordercallbacksignature)
-   [获取提供列表](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-getproviderlist)
-   [获取紧急列表](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-getcurrencylist)
-   [获得国家可操作性列表](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-getcountryavailabilitylist)
-   [获取输出](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-getoffers)
-   [创建命令](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-createorder)
-   [验证钱包地址](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-validatewalletaddress)

### 签名

构建 X- Api- 签名 .

```typescript
buildSignature(
  params: ChangellyBuildSignatureParams
): string;
```

**参数**

-   **段落**数字 : [_Changelly 构建签名程序_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellybuildsignatureparams)

**回返** _字符串_ – 变形X- Api 签名

### 校验命令回调符号

验证命令 X- Callback- Signal.

```typescript
validateOrderCallbackSignature(
  signature: string,
  orderId: string
): boolean;
```

**参数**

-   **签名**数字 : _字符串_ ——串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行.
-   **顺序**数字 : _字符串_ - 更改订单标识符.

**回返** _布尔_ - 回调签名有效吗?

### 获取提供列表

获取On-Ramp供应商的扩展信息给用户.

```typescript
getProviderList(
  config?: AxiosRequestConfig
): Promise<ChangellyGetProviderListResponse[]>;
```

**参数**

-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[Changelly 获取保护列表响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetproviderlistresponse)\[ >\]_

### 获取紧急列表

获取所支持的密码和fiat货币列表.

```typescript
getCurrencyList(
  params?: ChangellyGetCurrencyListParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetCurrencyListResponse[]>;
```

**参数**

-   (可选) **段落**数字 : [_Changelly 获取当前列表_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcurrencylistparams)
-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[变化中获取紧急响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcurrencylistresponse)\[ >\]_

### 获得国家可操作性列表

获取支持加密购买的国家列表 .

```typescript
getCountryAvailabilityList(
  params?: ChangellyGetCountryAvailabilityParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetCountryAvailabilityResponse[]>;
```

**参数**

-   (可选) **段落**数字 : [_Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcountryavailabilityparams)
-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcountryavailabilityresponse)\[ >\]_

### 获取输出

获取 On-Ramp 供应商的购买报价列表 .

```typescript
getOffers(
  params: ChangellyGetOffersParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetOffersResponse[]>;
```

**参数**

-   **段落**数字 : [_Changelly Get Offers-Params (英语)_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetoffersparams)
-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[变化中获取任务响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetoffersresponse)\[ >\]_

### 创建命令

创建加密定购单并获得重定向URL到购买页面. 如果请求中未提供任何可选参数,则会在响应中以"null"值返回.

```typescript
createOrder(
  data: ChangellyCreateOrderParams,
  config?: AxiosRequestConfig
): Promise<ChangellyCreateOrderResponse>;
```

**参数**

-   **数据**数字 : [_变化中生成命令_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycreateorderparams)
-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[变化中生成命令响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycreateorderresponse)\[ >\]_

### 验证钱包地址

检查给定的钱包地址和(可选)额外ID对给定的货币是否有效 .

```typescript
validateWalletAddress(
  data: ChangellyValidateWalletAddressParams,
  config?: AxiosRequestConfig
): Promise<ChangellyValidateWalletAddressResponse>;
```

**参数**

-   **数据**数字 : [_变化中ValideWallet AddressParams (英语)_](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyvalidatewalletaddressparams)
-   (可选) **配置**数字 : [_Axios 请求配置_](https://axios-http.com/docs/req_config)

**回返** _承诺 <[ChangellValidateWallet 地址地址响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyvalidatewalletaddressresponse)\[ >\]_

### 类型

-   [千变万化的图像](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyfiatclientparams)
-   [Changelly 构建签名程序](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellybuildsignatureparams)
-   [Changelly 获取保护列表响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetproviderlistresponse)
-   [Changelly 获取当前列表](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcurrencylistparams)
-   [变化中获取紧急响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcurrencylistresponse)
-   [Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcountryavailabilityparams)
-   [Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcountryavailabilityresponse)
-   [Changelly Get Offers-Params (英语)](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetoffersparams)
-   [变化中获取任务响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetoffersresponse)
    -   [成功提议](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-successfull-offer)
    -   [失败的报价](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-fail-offer)
-   [变化中生成命令](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycreateorderparams)
-   [变化中生成命令响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycreateorderresponse)
-   [变化中ValideWallet AddressParams (英语)](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyvalidatewalletaddressparams)
-   [ChangellValidateWallet 地址地址响应](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyvalidatewalletaddressresponse)
-   [变化状态](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellystate)
-   [Changelly Payment MethodOffer 游戏](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethodoffer)
-   [变化中的错误细节](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyerrordetails)

### 千变万化的图像

```typescript
interface ChangellyFiatClientParams {
  publicKey: string;
  privateKey: string;
  callbackPublicKey?: string;
  baseUrl?: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>公钥</strong></p></td><td><p><em>字符串</em></p></td><td><p>Changelly Fiat API 公用钥匙.</p></td></tr><tr><td><p><strong>私钥</strong></p></td><td><p><em>字符串</em></p></td><td><p>Changelly Fiat API 私人密钥.</p></td></tr><tr><td><p><strong>回调公钥</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选) Changelly Fiat API召回公钥.</p></td></tr><tr><td><p><strong>基数Url</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选) 基 url of Changelly Fiat API. <code>https://fiat-api.changelly.com/v1</code> 默认.</p></td></tr></tbody></table>

### Changelly 构建签名程序

```typescript
interface ChangellyBuildSignatureParams {
  baseUrl?: string;
  pathname: ChangellyRequestUrl | string;
  params?:
    | ChangellyGetCurrencyListParams
    | ChangellyGetCountryAvailabilityParams
    | ChangellyGetOffersParams;
  data?: ChangellyCreateOrderParams | ChangellyValidateWalletAddressParams;
}
```

**属性**

<table><tbody><tr><td><p><strong>基数Url</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选) Base url. <code>https://fiat-api.changelly.com/v1</code> 默认.</p></td></tr><tr><td><p><strong>路径名称</strong></p></td><td><p><em><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyrequesturl" rel="nofollow noopener noreferrer">变化中请求 Url</a> qq 字符串</em></p></td><td><p>请求地址.</p></td></tr><tr><td><p><strong>段落</strong></p></td><td><p><em><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcurrencylistparams" rel="nofollow noopener noreferrer">Changelly 获取当前列表</a> | <a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetcountryavailabilityparams" rel="nofollow noopener noreferrer">Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器</a> | <a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellygetoffersparams" rel="nofollow noopener noreferrer">Changelly Get Offers-Params (英语)</a></em></p></td><td><p>(可选)请求查询参数.</p></td></tr><tr><td><p><strong>数据</strong></p></td><td><p><em><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycreateorderparams" rel="nofollow noopener noreferrer">变化中生成命令</a> | <a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyvalidatewalletaddressparams" rel="nofollow noopener noreferrer">变化中ValideWallet AddressParams (英语)</a></em></p></td><td><p>(可选)请求正文参数.</p></td></tr></tbody></table>

### Changelly 获取保护列表响应

```typescript
interface ChangellyGetProviderListResponse {
  code: ChangellyProvider;
  name: string;
  trustPilotRating: string;
  iconUrl: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>名称</strong></p></td><td><p><em>字符串</em></p></td><td><p>上兰普供应商名.</p></td></tr><tr><td><p><strong>信任页</strong></p></td><td><p><em>字符串</em></p></td><td><p>提供商对"信托飞行员"的评分.</p></td></tr><tr><td><p><strong>图标Url</strong></p></td><td><p><em>字符串</em></p></td><td><p>On-Ramp 提供者图标的 URL .</p></td></tr></tbody></table>

### Changelly 获取当前列表

```typescript
interface ChangellyGetCurrencyListParams {
  type?: ChangellyCurrency;
  providerCode?: ChangellyProvider;
}
```

**属性**

<table><tbody><tr><td><p><strong>类型</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycurrency" rel="nofollow noopener noreferrer"><em>变化中</em></a></p></td><td><p>(可选)货币类型. 如果不指定货币类型,则端点将同时还原无线货币和密码.</p></td></tr><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>(可选) 您想要查看的货币提供者 。 如果不指定 On-Ramp 提供者代码,端点将返回所有提供者的支持货币.</p></td></tr></tbody></table>

### 变化中获取紧急响应

```typescript
interface ChangellyGetCurrencyListResponse {
  ticker: string;
  name: string;
  type: ChangellyCurrency;
  extraIdName: string | null;
  iconUrl: string;
  precision: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>计数器</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写为货币计分符. 它是货币的独特标识.</p></td></tr><tr><td><p><strong>名称</strong></p></td><td><p><em>字符串</em></p></td><td><p>您可以在界面中指定货币名称.</p></td></tr><tr><td><p><strong>类型</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycurrency" rel="nofollow noopener noreferrer"><em>变化中</em></a></p></td><td><p>货币类型.</p></td></tr><tr><td><p><strong>额外标识Name</strong></p></td><td><p><em>字符串 qq 无效</em></p></td><td><p>密码货币的额外ID名称,例如"Memo". 要求使用下列货币:XRP、XLM、EOS、BNB。 对于没有额外ID的有线货币和密码,extraIdName等于无效. 如果货币有额外的身份证,你需要提供 <code>walletExtraId</code> 参数 <code>/v1/orders</code> 财务报告和审定财务报表 <code>/v1/validate-address</code> 结束点.</p></td></tr><tr><td><p><strong>图标Url</strong></p></td><td><p><em>字符串</em></p></td><td><p>货币图标的 URL.</p></td></tr><tr><td><p><strong>精确度</strong></p></td><td><p><em>字符串</em></p></td><td><p>货币精度. 对于菲亚特货币,它总是等于2.</p></td></tr></tbody></table>

### Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器

```typescript
interface ChangellyGetCountryAvailabilityParams {
  providerCode?: ChangellyProvider;
}
```

**属性**

<table><tbody><tr><td><p>(可选) <strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>(可选) 供养者,由你来观察 如果未指定 On-Ramp 提供者代码, 端点将返回所有提供者的支持国家 .</p></td></tr></tbody></table>

### Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答

```typescript
interface ChangellyGetCountryAvailabilityResponse {
  code: ChangellyProvider;
  name: string;
  states?: ChangellyState[];
}
```

**属性**

<table><tbody><tr><td><p><strong>代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>名称</strong></p></td><td><p><em>字符串</em></p></td><td><p>上兰普供应商名.</p></td></tr><tr><td><p><strong>状态</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellystate" rel="nofollow noopener noreferrer"><em>变化状态</em></a>[</p></td><td><p>(可选)美国州. 如果国家的代码是美国,则返回.</p></td></tr></tbody></table>

### Changelly Get Offers-Params (英语)

```typescript
interface ChangellyGetOffersParams {
  providerCode?: ChangellyProvider;
  externalUserId?: string;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state?: string;
  ip?: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>(可选)On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>外部用户</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)由您提供的用户ID .</p></td></tr><tr><td><p><strong>货币来源</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的车票.</p></td></tr><tr><td><p><strong>货币到</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的计票人.</p></td></tr><tr><td><p><strong>从</strong></p></td><td><p><em>字符串</em></p></td><td><p>用户将支付的货币数额.</p></td></tr><tr><td><p><strong>国家</strong></p></td><td><p><em>字符串</em></p></td><td><p>国家ISO 3166-1代码(Alpha-2).</p></td></tr><tr><td><p><strong>状态</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)国家ISO 3166-2代码. 如果提供的国家是美国,则需要这样做.</p></td></tr><tr><td><p><strong>页:1</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)用户的IP地址.</p></td></tr></tbody></table>

### 变化中获取任务响应

可以成功而失败.

#### 成功提议

```typescript
interface Offer {
  providerCode: ChangellyProvider;
  rate: string;
  invertedRate: string;
  fee: string;
  amountFrom: string;
  amountExpectedTo: string;
  paymentMethodOffers: ChangellyPaymentMethodOffer[];
}
```

**属性**

<table><tbody><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>费率</strong></p></td><td><p><em>字符串</em></p></td><td><p>所有支付方法中的最佳购买率。 费率包括所有费用.</p></td></tr><tr><td><p><strong>倒转</strong></p></td><td><p><em>字符串</em></p></td><td><p>倒置购买率.</p></td></tr><tr><td><p><strong>收费</strong></p></td><td><p><em>字符串</em></p></td><td><p>所有支付方法中购买费总额的最低值.</p></td></tr><tr><td><p><strong>从</strong></p></td><td><p><em>字符串</em></p></td><td><p>用户将支付的货币数额.</p></td></tr><tr><td><p><strong>数量预期到</strong></p></td><td><p><em>字符串</em></p></td><td><p>使用者在购买后预计获得的付款方法中资金数额最大.</p></td></tr><tr><td><p><strong>支付方法</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethodoffer" rel="nofollow noopener noreferrer"><em>Changelly Payment MethodOffer 游戏</em></a>[</p></td><td><p>每种付款类型的采购细节。 除"卡"外的支付方法将在后期提供.</p></td></tr></tbody></table>

#### 失败的报价

```typescript
interface Offer {
  providerCode: ChangellyProvider;
  errorType:
    | ChangellyErrorType.Timeout
    | ChangellyErrorType.Unavailable
    | ChangellyErrorType.Limits
    | ChangellyErrorType.Country
    | ChangellyErrorType.State
    | ChangellyErrorType.Currency
    | ChangellyErrorType.PaymentMethod
    | ChangellyErrorType.InvalidOffer;
  errorMessage: string;
  errorDetails: ChangellyErrorDetails[] | null;
}
```

**属性**

<table><tbody><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>错误类型</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyerrortype" rel="nofollow noopener noreferrer"><em>变化中的错误类型</em></a> <em>(超时、无可用、限制、国家、状态、货币、支付方法、无效操作)</em></p></td><td><p>错误类型 .</p></td></tr><tr><td><p><strong>错误</strong></p></td><td><p><em>字符串</em></p></td><td><p>错误消息 .</p></td></tr><tr><td><p><strong>细节</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyerrordetails" rel="nofollow noopener noreferrer"><em>变化中的错误细节</em></a>[ ] 无效</p></td><td><p>错误细节 。 如果错误没有包含细节, <code>errorDetails</code> 等于无效.</p></td></tr></tbody></table>

### 变化中生成命令

```typescript
type ChangellyCreateOrderParams = {
  externalOrderId: string;
  externalUserId: string;
  providerCode: ChangellyProvider;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state?: string;
  ip?: string;
  walletAddress: string;
  walletExtraId?: string;
  paymentMethod?: ChangellyPaymentMethod;
  userAgent?: string;
  metadata?: Record<string, unknown>;
};
```

**属性**

<table><tbody><tr><td><p><strong>外部命令</strong></p></td><td><p><em>字符串</em></p></td><td><p>你提供身份证.</p></td></tr><tr><td><p><strong>外部用户</strong></p></td><td><p><em>字符串</em></p></td><td><p>您提供的用户身份 .</p></td></tr><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>货币来源</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的车票.</p></td></tr><tr><td><p><strong>货币到</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的计票人.</p></td></tr><tr><td><p><strong>从</strong></p></td><td><p><em>字符串</em></p></td><td><p>用户将支付的货币数额.</p></td></tr><tr><td><p><strong>国家</strong></p></td><td><p><em>字符串</em></p></td><td><p>国家ISO 3166-1代码(Alpha-2).</p></td></tr><tr><td><p><strong>状态</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)国家ISO 3166-2代码. 如果提供的国家是美国,则需要这样做.</p></td></tr><tr><td><p><strong>页:1</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)用户的IP地址.</p></td></tr><tr><td><p><strong>钱包地址</strong></p></td><td><p><em>字符串</em></p></td><td><p>收件人钱包地址 。 以下是此参数的两个简单使用例:</p><ul><li>如果您想提供加密货币购买服务,您应当让用户指定钱包地址.</li><li>如果您想要将产品出售给fiat,并在钱包中接收加密货币,请指定自己的钱包地址.</li></ul></td></tr><tr><td><p><strong>钱包外出</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)使用额外ID进行交易处理的货币钱包地址所需的属性(XRP, XLM, EOS, BNB).</p></td></tr><tr><td><p><strong>支付方法</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethod" rel="nofollow noopener noreferrer"><em>千变万化支付方法</em></a></p></td><td><p>(可选) 支付方法代码.</p></td></tr><tr><td><p><strong>用户代理</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)用户代理.</p></td></tr><tr><td><p><strong>元数据</strong></p></td><td><p><em>记录 &lt; string, 未知 &gt;</em></p></td><td><p>(可选)元数据对象,可以包含您需要的任何参数.</p></td></tr></tbody></table>

### 变化中生成命令响应

```typescript
interface ChangellyCreateOrderResponse {
  redirectUrl: string;
  orderId: string;
  externalUserId: string;
  externalOrderId: string;
  providerCode: ChangellyProvider;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state: string | null;
  ip: string | null;
  walletAddress: string;
  walletExtraId: string | null;
  paymentMethod: ChangellyPaymentMethod | null;
  userAgent: string | null;
  metadata: Record<string, unknown> | null;
  createdAt: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>重定向 Url</strong></p></td><td><p><em>字符串</em></p></td><td><p>URL到提供者的购买页面.</p></td></tr><tr><td><p><strong>顺序</strong></p></td><td><p><em>字符串</em></p></td><td><p>菲亚特API提供的内部订单ID.</p></td></tr><tr><td><p><strong>外部用户</strong></p></td><td><p><em>字符串</em></p></td><td><p>您提供的用户身份 .</p></td></tr><tr><td><p><strong>外部命令</strong></p></td><td><p><em>字符串</em></p></td><td><p>你提供身份证.</p></td></tr><tr><td><p><strong>提供者代码</strong></p></td><td><p><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider" rel="nofollow noopener noreferrer"><em>变化中提供</em></a></p></td><td><p>On-Ramp供应商代码.</p></td></tr><tr><td><p><strong>货币来源</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的车票.</p></td></tr><tr><td><p><strong>货币到</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中支付货币的计票人.</p></td></tr><tr><td><p><strong>从</strong></p></td><td><p><em>字符串</em></p></td><td><p>用户将支付的货币数额.</p></td></tr><tr><td><p><strong>国家</strong></p></td><td><p><em>字符串</em></p></td><td><p>国家ISO 3166-1代码(Alpha-2).</p></td></tr><tr><td><p><strong>状态</strong></p></td><td><p><em>字符串 qq 无效</em></p></td><td><p>国家ISO 3166-2代码. 如果提供的国家不是美国,则无效.</p></td></tr><tr><td><p><strong>页:1</strong></p></td><td><p><em>字符串 qq 无效</em></p></td><td><p>用户IP地址.</p></td></tr><tr><td><p><strong>钱包地址</strong></p></td><td><p><em>字符串</em></p></td><td><p>收件人钱包地址 .</p></td></tr><tr><td><p><strong>钱包外出</strong></p></td><td><p><em>字符串 qq 无效</em></p></td><td><p>使用额外ID进行交易处理的货币(XRP,XLM,EOS,BNB)钱包地址所需的属性.</p></td></tr><tr><td><p><strong>支付方法</strong></p></td><td><p><em><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethod" rel="nofollow noopener noreferrer"><em>千变万化支付方法</em></a> 无效</em></p></td><td><p>支付方法代码.</p></td></tr><tr><td><p><strong>用户代理</strong></p></td><td><p><em>字符串 qq 无效</em></p></td><td><p>用户代理.</p></td></tr><tr><td><p><strong>元数据</strong></p></td><td><p><em>记录 &lt; string, 未知 &gt; 无效</em></p></td><td><p>元数据对象,可以包含您需要的任何参数 。 如果不在请求中提供元数据对象,则在响应中元数据会返回无效. 如果您在请求中指定了空对象,则在回复中会返回空对象.</p></td></tr><tr><td><p><strong>创建到</strong></p></td><td><p><em>字符串</em></p></td><td><p>时间为ISO 8601格式.</p></td></tr></tbody></table>

### 变化中ValideWallet AddressParams (英语)

```typescript
interface ChangellyValidateWalletAddressParams {
  currency: string;
  walletAddress: string;
  walletExtraId?: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>货币</strong></p></td><td><p><em>字符串</em></p></td><td><p>大写中的加密货币计数器.</p></td></tr><tr><td><p><strong>钱包地址</strong></p></td><td><p><em>字符串</em></p></td><td><p>收件人钱包地址 .</p></td></tr><tr><td><p><strong>钱包外出</strong></p></td><td><p><em>字符串</em></p></td><td><p>(可选)使用额外ID进行交易处理的货币钱包地址所需的属性(XRP, XLM, EOS, BNB).</p></td></tr></tbody></table>

### ChangellValidateWallet 地址地址响应

```typescript
interface ChangellyValidateWalletAddressResponse {
  result: boolean;
  cause: "walletAddress" | "walletExtraId" | null;
}
```

**属性**

<table><tbody><tr><td><p><strong>结果</strong></p></td><td><p><em>布尔</em></p></td><td><p>如果钱包地址或额外ID不正确, 则不正确 .</p></td></tr><tr><td><p><strong>原因</strong></p></td><td><p><em>"WalletAddress" "Wallet ExtraId" 无效</em></p></td><td><p>指定钱包地址或额外ID是否不正确。 如果结果属实,则造成等值无效.</p></td></tr></tbody></table>

### 变化状态

```typescript
interface ChangellyState {
  code: string;
  name: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>代码</strong></p></td><td><p><em>字符串</em></p></td><td><p>国家ISO 3166-2代码.</p></td></tr><tr><td><p><strong>名称</strong></p></td><td><p><em>字符串</em></p></td><td><p>国名.</p></td></tr></tbody></table>

### Changelly Payment MethodOffer 游戏

```typescript
interface ChangellyPaymentMethodOffer {
  amountExpectedTo: string;
  method: ChangellyPaymentMethod;
  methodName: string;
  invertedRate: string;
  fee: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>数量预期到</strong></p></td><td><p><em>字符串</em></p></td><td><p>购买后用户可望获得的资金数额.</p></td></tr><tr><td><p><strong>方法</strong></p></td><td><p><em><a href="https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethod" rel="nofollow noopener noreferrer"><em>千变万化支付方法</em></a></em></p></td><td><p>支付方法代码.</p></td></tr><tr><td><p><strong>方法Name</strong></p></td><td><p><em>字符串</em></p></td><td><p>支付法名.</p></td></tr><tr><td><p><strong>倒转</strong></p></td><td><p><em>字符串</em></p></td><td><p>目前的购买费率,包括所有费用.</p></td></tr><tr><td><p><strong>收费</strong></p></td><td><p><em>字符串</em></p></td><td><p>购买费用总额.</p></td></tr></tbody></table>

### 变化中的错误细节

```typescript
interface ChangellyErrorDetails {
  cause: string;
  value: string;
}
```

**属性**

<table><tbody><tr><td><p><strong>原因</strong></p></td><td><p><em>字符串</em></p></td><td><p>错误原因 。 例如,它可以等同验证错误类型的缺失请求参数.</p></td></tr><tr><td><p><strong>价值</strong></p></td><td><p><em>字符串</em></p></td><td><p>错误值 .</p></td></tr></tbody></table>

### 编号

-   [变化中请求 Url](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyrequesturl)
-   [变化中提供](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyprovider)
-   [变化中](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellycurrency)
-   [变化中的错误类型](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellyerrortype)
-   [千变万化支付方法](https://npmcn.com/package/%40changelly/fiat-api-sdk-node/#readme-changellypaymentmethod)

### 变化中请求 Url

```typescript
enum ChangellyRequestUrl {
  ProvderList = "/v1/providers",
  CurrencyList = "/v1/currencies",
  CountryAvailability = "/v1/available-countries",
  GetOffers = "/v1/offers",
  CreateOrder = "/v1/orders",
  ValidateWalletAddress = "/v1/validate-address",
}
```

**成员**

-   **演示列表**数字 : _“/v1/提供者”_
-   **货币列表**数字 : _"/v1/曲线"_
-   **脆弱性**数字 : _“/v1/可用国家”_
-   **获取输入**数字 : _"/v1/offers" (韩语)_
-   **创建命令**数字 : _"/v1/订单"_
-   **校验钱包地址**数字 : _"/v1/验证地址"_

### 变化中提供

```typescript
enum ChangellyProvider {
  Moonpay = "moonpay",
  Banxa = "banxa",
  Wert = "wert",
}
```

**成员**

-   **月薪**数字 : _"月薪"(月薪)_
-   **班克萨**数字 : _"班克萨"_
-   **脏**数字 : _"废物"_

### 变化中

```typescript
enum ChangellyCurrency {
  Crypto = "crypto",
  Fiat = "fiat",
}
```

**成员**

-   **密码**数字 : _催眠术_
-   **菲亚特**数字 : _"虚构"_

### 变化中的错误类型

```typescript
enum ChangellyErrorType {
  Validation = "validation",
  Timeout = "timeout",
  Unavailable = "unavailable",
  Limits = "limits",
  Country = "country",
  State = "state",
  Currency = "currency",
  PaymentMethod = "paymentMethod",
  InvalidOffer = "invalidOffer",
  Unauthorized = "unauthorized",
  TooManyRequests = "tooManyRequests",
  InternalServerError = "internalServerError",
}
```

**成员**

-   **验证**数字 : _"验证"_ ——验证错误.
-   **超时**数字 : _"超时"_ 向提供者提出的请求未在规定时间内完成.
-   **无法获取**数字 : _"没有"_ ——请求在提供者端失败.
-   **限制**数字 : _"限制"_ ——指定的实收金额低于或超过有色货币的最高价值.
-   **国家**数字 : _"国家"_ - 指定国家不由提供者支持.
-   **状态**数字 : _"状态"_ ——向美国索取报价,但没有提供州参数.
-   **货币**数字 : _"货币"_ ——指定货币对不由提供者支持.
-   **支付方法**数字 : _"支付方法"_ - 提供者不支持指定的支付方法.
-   **无效操作**数字 : _"无效的Offer"_ ——On-Ramp供应商退回无效报价.
-   **未经授权**数字 : _未经批准_ — 未经授权的错误
-   **太多请求**数字 : _"很多请求"_ — 太多请求出错
-   **内务人员错误**数字 : _"内部服务员"_ — 内部服务器出错

### 千变万化支付方法

```typescript
enum ChangellyPaymentMethod {
  Card = "card",
  Sepa = "sepa_bank_transfer",
}
```

**成员**

-   **纸牌**数字 : _"卡"(卡)_
-   **塞帕语Name**数字 : _"sepa bank transfer" (银行转让)_

## 常见问题

### @changelly/fiat-api-sdk-node 是什么？

Changelly Fiat API 的节点Js SDK

### 如何安装 @changelly/fiat-api-sdk-node？

在项目目录运行 npm install @changelly/fiat-api-sdk-node，或使用 pnpm add / yarn add / bun add。

### @changelly/fiat-api-sdk-node 支持 TypeScript 吗？

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

### @changelly/fiat-api-sdk-node 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @changelly/fiat-api-sdk-node 可以商用吗？

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

### @changelly/fiat-api-sdk-node 的下载量有多少？

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

### @changelly/fiat-api-sdk-node 还在维护吗？

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

