List fund wallets. (admin access required)

Lists active fund wallets with their distribution configuration and low-balance summary. Filter by payment source id to get every treasury serving that source, or by id for one wallet. An unconfigured source returns an empty FundWallets array.

get/fund-wallet

Request

Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
URL: ./../api/v1/fund-wallet
Auth: API key in header token

Query parameters

idstring

Fund wallet id

paymentSourceIdstring

Payment source id

Response

Fund wallets

status'success' required

Example response

{
  "status": "success",
  "data": {
    "FundWallets": [
      {
        "id": "cuid_v2_auto_generated",
        "walletAddress": "addr_test1...",
        "walletVkey": "a1b2c3d4e5f6...",
        "note": "Treasury for preprod V2",
        "paymentSourceId": "cuid_v2_auto_generated",
        "lockedAt": null,
        "LowBalanceSummary": {
          "isLow": false,
          "lowRuleCount": 0,
          "lastCheckedAt": "2024-01-01T00:00:00.000Z"
        },
        "FundDistributionConfig": {
          "id": "cuid_v2_auto_generated",
          "enabled": true,
          "batchWindowMs": 300000
        },
        "pendingRequestCount": 0
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.