GET /api/v2/server-side-api/vc/balances/

列出虚拟货币余额

返回某个用户画像所有虚拟货币的当前余额。如果应用没有虚拟货币,data 为空数组。

Header parameters

adapty-customer-user-idstring

您系统中客户的唯一 ID。adapty-customer-user-idadapty-profile-id 二者必填其一。

adapty-profile-idstring

您系统中用户画像的唯一 ID。如果您使用匿名用户画像,此字段为最佳选择。adapty-customer-user-idadapty-profile-id 二者必填其一。

Responses

余额返回成功

Schema

用户画像所有虚拟货币的当前余额。

response_created_atintegerrequired

响应生成的时间,以毫秒为单位的 Unix 时间戳。

dataarray of objectrequired
codestringrequired

应用内唯一的虚拟货币代码。由 ASCII 字母、数字和下划线组成。

namestringrequired

虚拟货币的显示名称。

balanceintegerrequired

总余额,包含当前被冻结的金额。

heldintegerrequired

所有有效冻结金额的总和(已预留金额)。当前始终为 0。

availableintegerrequired

可用于消费的余额,计算方式为 balance - held

Example
{
  "response_created_at": 1779791400000,
  "data": [
    {
      "code": "COINS",
      "name": "Gold Coins",
      "balance": 12450,
      "held": 0,
      "available": 12450
    },
    {
      "code": "GEMS",
      "name": "Gems",
      "balance": 3280,
      "held": 0,
      "available": 3280
    },
    {
      "code": "ENERGY",
      "name": "Energy",
      "balance": 840,
      "held": 0,
      "available": 840
    }
  ]
}

请求错误。

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

未授权。API 密钥缺失或无效。

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

禁止访问。此应用未启用虚拟货币服务端 API。

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

用户画像未找到。

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

服务器内部错误