Create a fund wallet for a payment source. (admin access required)

Creates an enabled fund wallet for a payment source from an existing mnemonic. A source may have several fund wallets; dispatch uses the first one with enough funds. Auto-top-up thresholds and amounts are configured on each target wallet low-balance rule, not on the treasury. Fund the returned address before distribution can run. A mnemonic can back only one active wallet at a time; deleting that wallet frees it for re-registration.

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

Request body

paymentSourceIdstring required

Payment source to associate the fund wallet with

walletMnemonicstring required

BIP-39 mnemonic phrase for the fund wallet (12-24 words)

batchWindowMsinteger

Batch window in milliseconds (default 5 min, max 24 h)

notestring

Optional note for this fund wallet

Example request

{
  "paymentSourceId": "cuid_v2_auto_generated",
  "walletMnemonic": "word1 word2 word3 ... word24",
  "batchWindowMs": 300000,
  "note": "Treasury for preprod V2"
}

Response

Fund wallet created

status'success' required

Example response

{
  "status": "success",
  "data": {
    "id": "cuid_v2_auto_generated",
    "walletAddress": "addr_test1...",
    "walletVkey": "a1b2c3d4e5f6...",
    "paymentSourceId": "cuid_v2_auto_generated",
    "FundDistributionConfig": {
      "id": "cuid_v2_auto_generated",
      "enabled": true,
      "batchWindowMs": 300000
    }
  }
}

Changes

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