wallet

List wallet low-balance rules. (admin access required)

Lists low-balance monitoring rules for wallets

get/wallet/low-balance

Request

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

Query parameters

walletIdstring

Optional: filter rules by wallet id

paymentSourceIdstring

Optional: filter rules by payment source id

onlyLowstring

Whether to return only rules currently in low state

includeDisabledstring

Whether to include disabled rules

Response

Wallet low-balance rules

status'success' required

Example response

{
  "status": "success",
  "data": {
    "Rules": [
      {
        "id": "low_balance_rule_id",
        "assetUnit": "lovelace",
        "thresholdAmount": "5000000",
        "enabled": true,
        "topupEnabled": true,
        "topupAmount": "10000000",
        "status": "Low",
        "lastKnownAmount": "4200000",
        "lastCheckedAt": "1970-01-20T20:00:36.260Z",
        "lastAlertedAt": "1970-01-20T20:00:36.260Z",
        "walletId": "unique_cuid_v2_of_wallet",
        "walletVkey": "wallet_vkey",
        "walletAddress": "wallet_address",
        "walletType": "Purchasing",
        "paymentSourceId": "payment_source_id",
        "network": "Preprod"
      }
    ]
  }
}

Changes

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