Skip to main content
POST
Send a payment

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
destination
string
required

The destination can be an Ark address, a BOLT11 invoice, a BOLT12 offer, a lightning address, LNURL, a bitcoin address or a BIP 321 URI

amount_sat
integer<int64> | null

The amount to send (in satoshis). Optional when the destination carries an amount, such as a BOLT11 invoice or a BIP 321 URI with an amount. Depending on the destination, the wallet must contain this amount plus any fees configured by the server in FeeSchedule [blocked].

Required range: x >= 0
comment
string | null

An optional comment, only supported when paying to lightning addresses

method
enum<string> | null

For a destination with several payment methods, such as a BIP 321 URI, the kind of method to pay with. When empty, the wallet picks Ark, then Lightning, then on-chain.

Available options:
ark,
lightning,
onchain
retry_for_secs
integer<int64> | null

For lightning destinations, how many seconds the Ark server should keep trying to pay, capped to the server's maximum. The server picks its default when empty.

Required range: x >= 0

Response

Payment sent successfully

message
string
required

Success message

payment_hash
string | null

The payment hash, when the destination resolved to a lightning payment. Can be used to poll the payment status.