wallet_sendBsv

Send BSV to one or more recipients by address or paymail. Supports BSV and USD amounts with automatic conversion.

Read as Markdown

Result

JSON text with status, transaction ID and recipient amounts in satoshis, or an error.

Permissions

Uses the payment wallet's transaction permissions. Guarded by the broadcasting setting.

Provide an address or paymail for each recipient. USD amounts are converted using the current BSV price.

Inputs and availability

Full catalog · Legacy local wallet; Legacy local identity; Local Vault · broadcasting disabled; Local Vault · all roles; Local Vault · payment role only; Project · payments scope; External BRC-100 wallet; Local Vault + sponsor

Field	Type / required	Description
recipients	array of object Required	Array of payment recipients
recipients[].address	string Optional	Destination P2PKH address
recipients[].paymail	string Optional	Destination paymail address
recipients[].amount	number Required	Amount to send; must be greater than zero exclusiveMinimum: 0
recipients[].currency	"BSV" \| "USD" Optional	Currency of amount (default: BSV) default: "BSV"

Nested fields are required only when their parent object or array item is supplied.

Full input schema

{
  "type": "object",
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "address": {
            "description": "Destination P2PKH address",
            "type": "string"
          },
          "paymail": {
            "description": "Destination paymail address",
            "type": "string"
          },
          "amount": {
            "type": "number",
            "exclusiveMinimum": 0,
            "description": "Amount to send; must be greater than zero"
          },
          "currency": {
            "default": "BSV",
            "description": "Currency of amount (default: BSV)",
            "type": "string",
            "enum": [
              "BSV",
              "USD"
            ]
          }
        },
        "required": [
          "amount"
        ]
      },
      "description": "Array of payment recipients"
    }
  },
  "required": [
    "recipients"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}