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

仮想通貨残高の一覧取得

プロファイルのすべての仮想通貨の現在の残高を返します。アプリに仮想通貨が存在しない場合、data は空の配列になります。

Header parameters

adapty-customer-user-idstring

お客様のシステムにおけるカスタマーの一意のID。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。

adapty-profile-idstring

お客様のシステムにおけるプロファイルの一意のID。匿名プロファイルを扱う場合に最適な選択肢です。adapty-customer-user-id または adapty-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ステータスコード

アクセス拒否。このアプリでは仮想通貨向けのServer 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ステータスコード

内部サーバーエラー