settlement_profile.add

settlement_profile.add "profile_id" "label" "chain" "address" "signer_ref" "preferred_asset" ( "fee_speed" ) Add or update an external settlement profile. Arguments: 1. profile_id (string, required) Unique profile identifier 2. label (string, required) Human-readable label 3. chain (string, required) External chain: btc|ethereum|tron 4. address (string, required) Settlement address on external chain 5. signer_ref (string, required) Signing reference (derived:auto or imported:<key-id>) 6. preferred_asset (string, required) Preferred asset (BTC|ETH|USDT) 7. fee_speed (string, optional) Fee speed: normal|fast|urgent (default: normal) Result: true|false (boolean) true if profile was saved Examples: > bitcoin-cli settlement_profile.add "btc-cold" "My BTC" "btc" "bc1q..." "derived:auto" "BTC" "normal"

Signature

settlement_profile.add(profile_id: string, label: string, chain: string, address: string, signer_ref: string, preferred_asset: string, fee_speed?: string) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"settlement_profile.add","params":["\"<profile_id>\"","\"<label>\"","\"<chain>\"","\"<address>\"","\"<signer_ref>\"","\"<preferred_asset>\"","\"<fee_speed>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli settlement_profile.add "btc-cold" "My BTC" "btc" "bc1q..." "derived:auto" "BTC" "normal"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "settlement_profile.add",
        "params": ["\"<profile_id>\"", "\"<label>\"", "\"<chain>\"", "\"<address>\"", "\"<signer_ref>\"", "\"<preferred_asset>\"", "\"<fee_speed>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "settlement_profile.add",
    params: ["\"<profile_id>\"","\"<label>\"","\"<chain>\"","\"<address>\"","\"<signer_ref>\"","\"<preferred_asset>\"","\"<fee_speed>\""],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
profile_id	`string`	yes	Unique profile identifier
label	`string`	yes	Human-readable label
chain	`string`	yes	External chain: btc\|ethereum\|tron
address	`string`	yes	Settlement address on external chain
signer_ref	`string`	yes	Signing reference (derived:auto or imported:<key-id>)
preferred_asset	`string`	yes	Preferred asset (BTC\|ETH\|USDT)
fee_speed	`string`	—	Fee speed: normal\|fast\|urgent (default: normal)

Result

Type: any

true|false (boolean) true if profile was saved

Source: services/core-node/bcore/src/wallet/rpc/contracts.cpp:18356

C++ symbol: settlement_profile_add

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"settlement_profile.add","params":["\"<profile_id>\"","\"<label>\"","\"<chain>\"","\"<address>\"","\"<signer_ref>\"","\"<preferred_asset>\"","\"<fee_speed>\""]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli settlement_profile.add "btc-cold" "My BTC" "btc" "bc1q..." "derived:auto" "BTC" "normal"

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "settlement_profile.add",
        "params": ["\"<profile_id>\"", "\"<label>\"", "\"<chain>\"", "\"<address>\"", "\"<signer_ref>\"", "\"<preferred_asset>\"", "\"<fee_speed>\""],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "settlement_profile.add",
    params: ["\"<profile_id>\"","\"<label>\"","\"<chain>\"","\"<address>\"","\"<signer_ref>\"","\"<preferred_asset>\"","\"<fee_speed>\""],
  }),
});
console.log(await res.json());