wallet

Create a wallet low-balance rule. (admin access required)

Creates a wallet low-balance monitoring rule

post/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

Request body

walletIdstring required

Hot wallet id to attach the rule to

assetUnitstring required

Raw on-chain asset unit, for example lovelace or a policy+asset identifier

thresholdAmountstring required

Threshold in raw on-chain units. Example: 5000000 for 5 ADA

enabledboolean

Whether the rule should start enabled

topupEnabledboolean

Whether crossing the threshold also auto-tops-up this wallet

topupAmountstring

Amount to top up per trigger, in raw on-chain units. Required when topupEnabled is true; ADA requires at least 5000000 lovelace

Example request

{
  "walletId": "unique_cuid_v2_of_wallet",
  "assetUnit": "lovelace",
  "thresholdAmount": "5000000",
  "enabled": true
}

Response

Wallet low-balance rule created

status'success' required

Example response

{
  "status": "success",
  "data": {
    "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.