管理支持的货币

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

简介

在初始获利设置过程中,Apigee Edge 配置团队 配置贵组织支持的币种和默认币种。

您可以查看贵组织支持的货币、添加支持的货币或 删除支持的货币(如果开发者或费率方案未使用这些货币)。

使用界面管理支持的货币

在“税费和币种”部分管理支持的币种并设置默认币种 “组织资料”页面中的“设置”部分。请参阅管理 使用界面查看组织资料以了解详情。

使用 API 管理支持的货币

使用 API 管理支持的货币,如以下部分所述。

使用 API 查看支持的货币

查看贵组织支持的个别币种或所有币种 提供支持的服务。

如需查看贵组织支持的单个币种,请向以下地址发出 GET 请求: /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId},其中 {supportedCurrency_id} 是受支持的货币的标识 查看。例如:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

要查看您组织支持的所有币种,请向以下地址发出 GET 请求: /mint/organizations/{org_name}/supported-currencies。例如:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

以下提供了一个响应示例:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

使用 API 设置默认货币

currency 值设置为支持的 ISO 4217 币种,从而为组织设置默认币种 修改组织资料时所需的代码,如管理组织 配置文件

使用 API 修改支持的货币

要修改支持的货币,请向以下用户发出 PUT 请求: /mint/organizations/{org_name}/{supportedCurrencyId},其中 {supportedCurrency_id} 是受支持的货币的标识 已更新。您需要在请求正文中指定更新后的属性 以及支持的货币 ID。例如,以下 API 调用 修改受支持货币的说明和显示名称(更新后的属性 ):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

使用 API 删除支持的货币

通过向以下对象发出 DELETE 请求来删除支持的货币: /mint/organizations/{org_name}/supported-currencies/{currency_id},其中 {currency_id} 是要删除的受支持货币的标识。例如:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

API 的货币配置属性

下表总结了可以使用该 API 设置的配置属性。

名称 说明 默认 是否必需?
creditLimit

此属性仅适用于后付费开发者。 支持的货币。

不适用
说明

所支持货币的说明。

不适用
displayName

以支持的货币显示的名称。

不适用
minimumTopupAmount

此属性仅适用于预付费开发者。开发者可为预付款账号充值的最低金额(使用指定币种)。

不适用
name

应用的 ISO 4217 代码 例如 USD 代表美元。

不适用
组织

所支持币种对应的组织。

不适用
状态

所支持货币的状态。有效值包括:

  • 有效:可以使用支持的货币。
  • INACTIVE:不支持使用支持的货币。
不适用
virtualCurrency

指明支持的货币是否为虚拟货币。有效值包括:

  • true:支持的货币是虚拟货币。
  • false:支持的货币不是虚拟货币。
不适用