BSV blockchainBSV blockchain

createAction

POST/createAction

Creates a new Bitcoin transaction

Body application/json

descriptionstring
inputBEEFnumber[]
inputsobject[]
Show inputs properties
outpointstring
inputDescriptionstring
unlockingScriptstring
unlockingScriptLengthnumber
sequenceNumbernumber
outputsobject[]
Show outputs properties
lockingScriptstring
satoshisnumber
outputDescriptionstring
basketstring
customInstructionsstring
tagsstring[]
lockTimenumber
versionnumber
labelsstring[]
optionsobject
Show options properties
signAndProcessboolean
acceptDelayedBroadcastboolean
trustSelf"known"
knownTxidsstring[]
returnTXIDOnlyboolean
noSendboolean
noSendChangestring[]
sendWithstring[]
randomizeOutputsboolean

Response

The created transaction result

txidstring
txnumber[]
noSendChangestring[]
sendWithResultsobject[]
Show sendWithResults properties
txidstring
status"unproven" | "sending" | "failed"
signableTransactionobject
Show signableTransaction properties
txnumber[]
referencestring

Invalid input

Internal server error

Request
curl -X POST "http://localhost:3321/createAction" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "inputBEEF": [
    0
  ],
  "inputs": [
    {
      "outpoint": "string",
      "inputDescription": "string",
      "unlockingScript": "string",
      "unlockingScriptLength": 0,
      "sequenceNumber": 0
    }
  ],
  "outputs": [
    {
      "lockingScript": "string",
      "satoshis": 0,
      "outputDescription": "string",
      "basket": "string",
      "customInstructions": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "lockTime": 0,
  "version": 0,
  "labels": [
    "string"
  ],
  "options": {
    "signAndProcess": true,
    "acceptDelayedBroadcast": true,
    "trustSelf": "known",
    "knownTxids": [
      "string"
    ],
    "returnTXIDOnly": true,
    "noSend": true,
    "noSendChange": [
      "string"
    ],
    "sendWith": [
      "string"
    ],
    "randomizeOutputs": true
  }
}'
Response
{
  "txid": "string",
  "tx": [
    0
  ],
  "noSendChange": [
    "string"
  ],
  "sendWithResults": [
    {
      "txid": "string",
      "status": "unproven"
    }
  ],
  "signableTransaction": {
    "tx": [
      0
    ],
    "reference": "string"
  }
}