Skip to content
Bare BitcoinDevelopers

Search documentation

↑ ↓ Select · Enter Open · Escape Close

barebitcoin.no ↗
Menu
← Models

SendBitcoinRequest

object

View Markdown

Properties

destinationstring

The bitcoin destination to send funds to. Supported formats: - Bitcoin address (bech32, legacy-segwit, legacy) - Lightning invoice (bolt11) - Lightning address - Lightning LNURL

Example: "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

amountBtcnumber · double

The amount to send. This field is required for all destinations except Lightning invoices. If the destination is a Lightning invoice, the amount is derived from the invoice.

Example: 0.01

accountIdstring

The ID of the account to send from. If empty, the default account is used.

Example: "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC"

isPaymentboolean

Marks the transaction as a payment. This has consequences for how the transaction is exported for tax purposes. It has no effect on the bitcoin transaction itself.

Example: false

descriptionstring

Free-form text description of the withdrawal. Can be used to correlate with your own systems.

Example: "Til hardware-lommebok"

tfrInfoInfo

Information about the recipient under the travel rule. Call GetBitcoinWithdrawalRequirements to check whether it is needed for this destination. full_name and postal address are always required when supplied, including for an organisation.

Info
Show fields
fullNamestring

Full name of the person, or registered name of the organisation, on the other side of the transfer. Required for both people and organisations.

countrystring

Country of that person or organisation, as an ISO-3166-1 alpha-2 code.

addressstring

Postal address of that person or organisation. For a withdrawal, the bitcoin address or invoice goes in SendBitcoinRequest.destination instead.

ninstring

National identity number of the person, or 9-digit Norwegian organisasjonsnummer of the organisation. Supply it for self-custody withdrawals. It can be omitted for withdrawals to an exchange.

exchangestring

Name of the exchange holding the account. For withdrawals, choose a name from ListSupportedWithdrawalExchanges. Leave empty for self-custody.

selfCustodyboolean

True when the destination is a wallet held outside an exchange. Otherwise set this to false and provide exchange.

ownWalletboolean

True when the wallet or exchange account belongs to the Bare Bitcoin customer. False when it belongs to another person or organisation.

idempotencyKeystring

Optional, case-insensitive identifier of up to 128 characters for this withdrawal attempt. Unique per user across all accounts and API credentials. Omitted or empty disables duplicate protection. Use an opaque value such as a random UUID. Creating another withdrawal with a stored key returns HTTP 409 (AlreadyExists), even if the inputs differ. Validation errors can occur before duplicate detection. Keys do not expire and remain used if the withdrawal fails or is cancelled. A request that fails before storing a withdrawal does not consume its key. Retries still need a fresh API nonce and HMAC. The conflict message includes the existing withdrawal ID.

Maximum length: 128

Example: "0b943d76-3f66-4cb1-a088-95899d503402"

Used by

Initiate withdrawal · request