wallet

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

Updates a wallet low-balance monitoring rule

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

ruleIdstring required

Low-balance rule id to update

thresholdAmountstring

Updated threshold in raw on-chain units

enabledboolean

Updated enabled state

topupEnabledboolean

Enable or disable auto top-up on this rule

topupAmountstring nullable

Updated top-up amount in raw on-chain units, or null to clear it while auto top-up is disabled. ADA requires at least 5000000 lovelace

Example request

{
  "ruleId": "low_balance_rule_id",
  "thresholdAmount": "7000000",
  "enabled": true
}

Response

Wallet low-balance rule updated

status'success' required

Example response

{
  "status": "success",
  "data": {
    "id": "low_balance_rule_id",
    "assetUnit": "lovelace",
    "thresholdAmount": "7000000",
    "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.