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

仮想通貨トランザクション一覧を取得する

プロファイルの仮想通貨トランザクション履歴を新しい順で返します。結果はカーソルページネーションを使用します。レスポンスに pagination.next_cursor がnull以外で含まれている場合、それを cursor クエリパラメータとして渡すことで次のページを取得できます。

Query parameters

currency_codestring

履歴を単一の仮想通貨コードでフィルタリングします。

cursorstring

前のレスポンスで pagination.next_cursor として返された不透明なページネーションカーソル。最初のページを取得する場合は省略してください。

limitinteger

1ページあたりに返すトランザクションの最大数。デフォルトは50です。

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

プロファイルの仮想通貨トランザクション履歴のページネーションリスト。

dataarray of objectrequired
transaction_idstringrequired

トランザクションの一意なID。

transaction_typestringrequired

トランザクションのソース。store_purchase、subscription_renewal、trial_start、api_transaction、dashboard_transaction、refund、またはexpiryのいずれか。

itemsarray of objectrequired

このトランザクションに記録された通貨ごとの残高変更。

currency_codestringrequired

バーチャル通貨コード。

amountintegerrequired

残高に適用された符号付き変化量。正の値はクレジット、負の値はデビットを表します。

balance_afterintegerrequired

このトランザクション適用後の通貨残高。

metadataobject

トランザクションに保存されたキーと値のペア(存在する場合)。

operationstringrequired

トランザクションの意味。Adaptyは自身が作成するトランザクションに対して自動的に設定します。store_purchase、subscription_renewal、trial_startにはtop_upが、refundにはrefundが、expiryにはexpiryが設定されます。dashboard_transactionの場合は、チームメンバーがAdapty ダッシュボードで残高を調整した際に選択した操作が設定されます。api_transactionの場合は、送信した値、または送信しなかった場合はnullが設定されます。

One of: "top_up", "refund", "spend", "spend_reversal", "reward", "reward_reversal", "exchange", "expiry", "migration", "adjustment"

featurestringrequired

コインが消費された目的または付与された理由(送信した値)。Adaptyが作成したトランザクションではnull。

customer_placement_idstringrequired

アプリ側のスクリーンまたはプレースメントID(送信した値)。Adaptyが作成したトランザクションではnull。

reference_idstringrequired

自社システム内の関連オブジェクトのID(送信した値)。Adaptyが作成したトランザクションではnull。

is_sandboxbooleanrequired

テスト用トランザクションかどうか。Adaptyが作成したトランザクションの場合、ストア購入の環境に従います。api_transactionの場合は送信した値が使用され、デフォルトはfalseです。

storestringrequired

関連する購入のストア。ストアイベント(購入、更新、トライアル、返金)からAdaptyが作成したトランザクション、および購入参照とともに送信されたapi_transactionに設定されます。

store_transaction_idstringrequired

関連する購入のストアトランザクションID。storeと同じトランザクションに設定されます。

created_atstringrequired

トランザクションが記録された日時。

paginationobjectrequired
next_cursorstringrequired

次のページのための不透明なカーソルです。さらに結果を取得するには、cursor クエリパラメータとして渡してください。これ以上ページがない場合は null になります。

Example
{
  "data": [
    {
      "transaction_id": "0190e8a4-1c2b-7def-8abc-2c1a4b6d8e90",
      "transaction_type": "api_transaction",
      "items": [
        {
          "currency_code": "COINS",
          "amount": 500,
          "balance_after": 12950
        }
      ],
      "metadata": null,
      "operation": "reward",
      "feature": "daily_bonus",
      "customer_placement_id": "home-screen",
      "reference_id": null,
      "is_sandbox": false,
      "store": null,
      "store_transaction_id": null,
      "created_at": "2026-05-23T10:30:00Z"
    },
    {
      "transaction_id": "0190e7b2-9a44-7c10-bb31-7d2e9f0a1c55",
      "transaction_type": "store_purchase",
      "items": [
        {
          "currency_code": "COINS",
          "amount": 1000,
          "balance_after": 12450
        }
      ],
      "metadata": null,
      "operation": "top_up",
      "feature": null,
      "customer_placement_id": null,
      "reference_id": null,
      "is_sandbox": false,
      "store": "app_store",
      "store_transaction_id": "2000001218103228",
      "created_at": "2026-05-22T18:05:12Z"
    },
    {
      "transaction_id": "0190e5c0-3f18-7b9a-9e6d-44a1c8b27e03",
      "transaction_type": "subscription_renewal",
      "items": [
        {
          "currency_code": "GEMS",
          "amount": 200,
          "balance_after": 3280
        }
      ],
      "metadata": null,
      "operation": "top_up",
      "feature": null,
      "customer_placement_id": null,
      "reference_id": null,
      "is_sandbox": false,
      "store": "play_store",
      "store_transaction_id": "GPA.3345-1234-5678-90123",
      "created_at": "2026-05-20T09:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "MjAyNi0wNS0yMFQwOTowMDowMFowMTkwZTVjMC0zZjE4LTdiOWEtOWU2ZC00NGExYzhiMjdlMDM="
  }
}

不正なリクエスト。error_code フィールドで原因を特定できます:

  • validation_error — limit が1〜100の範囲外、または adapty-profile-id および adapty-customer-user-id のいずれも送信されていません。
  • invalid_cursor — cursor の値を解析できません。
Schema
errorsarray of objectrequired
sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

認証エラー。APIキーが欠落しているか無効です(error_code は not_authenticated)。

Schema
errorsarray of objectrequired
sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

プロファイルが見つかりません(error_code は profile_does_not_exist)。

Schema
errorsarray of objectrequired
sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短い名称

status_codeintegerrequired

HTTPステータスコード

内部サーバーエラー