Ctrl+K

Send a lightning payment

post/api/v2/wallet/{walletId}/lightning/payment

Send a lightning payment that pays a provided payment request using the wallet's custodial lightning balance.

Path Parameters

  • walletIdstringRequired
    Example: "59cd72485007a239fb00282ed480da1f"
    Pattern: ^[0-9a-f]{32}$

Request Body

One of
amount number
A specific amount of satoshis to pay for this request. This is used to pay more than the amount requested by the invoice, such as for zero value invoices that will accept any size payment. Must be greater than or equal to any amount specified by the invoice.
comment string
An optional memo for the transaction.
Max length: <= 256 characters
feeLimit number
The maximum number of satoshis that may be paid as a fee for the payment. Only one of feeLimit or feeLimitRatio should be specified, if neither is specified then the greater of 25 satoshis or 5% of the invoice amount is used for the fee limit.
Example: 200
feeLimitRatio number
The maximum fee in proportion to the payment amount that may be paid as a fee for the payment. This number is multiplied by the value of the invoice to determine the fee limit. Only one of feeLimit or feeLimitRatio should be specified, if neither is specified then the greater of 25 satoshis or 5% of the invoice amount is used for the fee limit.
Example: 0.03
invoice string required
The BOLT \#11 encoded invoice to pay
Example: lnbc500n1p3zv5vkpp5x0thcaz8wep54clc2xt5895azjdzmthyskzzh9yslggy74qtvl6sdpdg3hkuct5d9hkugrxdaezqjn0dphk2fmnypkk2mtsdahkccqzpgxqyz5vqsp5v80q4vq4pwakq2l0hcqgtelgajsymv4ud4jdcrqtnzhvet55qlus9qyyssquqh2wl2m866qs5n72c5vg6wmqx9vzwhs5ypualq4mcu76h2tdkcq3jtjwtggfff7xwtdqxlnwqk8cxpzryjghrmmq3syraswp9vjr7cqry9l96
sequenceId string
Your own unique ID

200 Response

transfer object required
baseValue number
The value (in base units) sent by this transfer, excluding network fees. BitGo is deprecating this field in the future.
baseValueString string
The value (in base units) sent by this transfer, excluding network fees represented as a string. BitGo is deprecating this field in the future.
Example: 2000000
Match pattern: ^-?\d+$
coin string required
A cryptocurrency symbol or token ticker symbol
Example: btc
comment
string or null
A comment from the user
date string <date-time>required
The date this Transfer was last updated
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
organization string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
bitgoOrg string
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Singapore BitGo Sister Trust 1 BitGo Inc
entries array[object] required
An array of objects describing the change in address balances made as a result of this Transfer
history array[object] required
An audit log of events that have happened to the Transfer during its lifecycle
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
pendingApproval string
state string required
Allowed values: initialized pendingApproval rejected signed unconfirmed confirmed removed failed replaced deleted
stakingParams object
txid string
The on-chain transaction id
Example: b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26
type string required
Defines whether or not this Transfer was sent or received by the user
Allowed values: send receive
usd number
The amount of USD of this Transfer (will be negative if it's a send)
usdRate number
The USD rate at the time this Transfer was created
value number
The total value (in base units) sent by this Transfer (may be approximate for ETH and other coins where amounts in base units can exceed 2^53 - 1)
valueString string required
The total value (in base units) sent by this Transfer represented as a String
Example: 2000000
Match pattern: ^-?\d+$
wallet string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
replaces array[string]
Transaction IDs that this transfer replaces.
replacedBy array[string]
Transaction IDs that replace this transfer.
status string required
Allowed values: initialized pendingApproval rejected signed unconfirmed confirmed removed failed replaced deleted
paymentHash string required
The unique payment hash used for this payment.
Example: 63d9ce82e09d16761a85116ed8b65407db4fb22f85d03573de09c480f2c6d175

400 Response

One of
name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id