barkd REST API
Endpoints
- GETGet Ark address by index
- POSTGenerate Ark address
- GETGet Ark server info
- GETGet wallet balance
- GETCheck server connection
- POSTCreate a wallet
- GETGet wallet history
- POSTImport a VTXO
- GETList movements (deprecated)deprecated
- GETGet next round time
- POSTOffboard all VTXOs
- POSTOffboard specific VTXOs
- POSTRefresh all VTXOs
- POSTRefresh received VTXOs
- POSTRefresh specific VTXOs
- GETList round participations
- POSTSend a payment
- POSTSend on-chain from Ark balance
- POSTSync wallet
- GETList VTXOs
curl --request POST \
--url https://api.example.com/api/v1/wallet/send \
--header 'Content-Type: application/json' \
--data '
{
"destination": "<string>",
"amount_sat": 1,
"comment": "<string>"
}
'{
"message": "<string>"
}Send a payment
Sends an Ark or Lightning payment to the specified destination. Accepts an Ark address, BOLT11 invoice, BOLT12 offer, or Lightning address. Ark address payments are settled instantly via an out-of-round (arkoor) transaction. The amount_sat field is required for Ark addresses and Lightning addresses but optional for invoices and offers that already encode an amount. Comments are only supported for Lightning addresses. To send to an on-chain bitcoin address, use send-onchain instead.
curl --request POST \
--url https://api.example.com/api/v1/wallet/send \
--header 'Content-Type: application/json' \
--data '
{
"destination": "<string>",
"amount_sat": 1,
"comment": "<string>"
}
'{
"message": "<string>"
}Body
The destination can be an Ark address, a BOLT11-invoice, LNURL or a lightning address
The amount to send (in satoshis). Optional for bolt11 invoices
x >= 0An optional comment, only supported when paying to lightning addresses
Response
Payment sent successfully
Success message
Was this page helpful?