Keysend

Initiate a keysend payment from your wallet to a destination pubkey
post
PostWalletKeysend
https://api.lnpay.co/v1/wallet/:access_key/keysend
NOTE: This function has ASYNCHRONOUS capabilities! Pass in the "X-LNPAY-ASYNC: 1" http header to receive immediate response. the success / fail of the asynchronous job will not be able to be determined at this time.
Request
Response
Request
Path Parameters
wallet_access_key
optional
string
Access key with withdraw permission (e.g. waka_ or waki_)
Body Parameters
fee_limit_msat
optional
integer
max fee e.g. 1000 (1 sat) LNPay default is 5% of payment amount
passThru
optional
object
data to pass along with this invoice for webhooks (e.g. ticketId, etc)
dest_pubkey
required
string
Pubkey of destination node
num_satoshis
required
integer
satoshis
custom_records
optional
object
key:value pairs to be sent in the onion. key must be an integer greater than 65536. value must be a string, encoded binary data is not supported. Too many values here will break things.
Response
201: Created
Keysend Sent!
{
    "id": "wtx_s1xa5yZFlCegcgtXkaeo34",
    "created_at": 1595165573,
    "num_satoshis": -2,
    "user_label": "2 keysend to 033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500",
    "wal": {
        "id": "wal_czDztN5eJ4r5sJ",
        "created_at": 1582461859,
        "updated_at": 1595165573,
        "user_label": "My Postman Collection Wallet",
        "balance": 211,
        "statusType": {
            "type": "wallet",
            "name": "active",
            "display_name": "Active"
        }
    },
    "wtxType": {
        "layer": "ln",
        "name": "ln_withdrawal",
        "display_name": "LN Withdrawal"
    },
    "lnTx": {
        "id": "lntx_gTMCJKFywtc2ZMWFwge0vpcE",
        "created_at": 1595165573,
        "ln_node_id": "lnod_2s4yfYA",
        "dest_pubkey": "033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500",
        "payment_request": "033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500:2",
        "r_hash_decoded": "efa5d7a28c26566dbc854dce4b4c15c16afa4488e0130b393a88c2d255ae6599",
        "memo": "2 keysend to 033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500",
        "description_hash": null,
        "num_satoshis": 2,
        "expiry": 432000,
        "expires_at": null,
        "payment_preimage": "6e5a9be8db789bdd6c4d603b8a357561c0dd1be0fe278a4ecdbfd8e228a8fc11",
        "settled": 1,
        "settled_at": 1595165573,
        "is_keysend": 1,
        "custom_records": {
            "5482373484": "6e5a9be8db789bdd6c4d603b8a357561c0dd1be0fe278a4ecdbfd8e228a8fc11"
        }
    },
    "passThru": {
        "method": "api",
        "ticketId": "23"
    }
}
400: Bad Request
Some error
{
    "name": "Bad Request",
    "message": "Failure reason: FAILURE_REASON_NO_ROUTE",
    "code": 0,
    "status": 400
}
FAILURE_REASON_NO_ROUTE is a common error that means one of two things
There is no route because the fee_limit_msat is too low or the default 5% is too low (this is usually the issue)
There is no route because the lightning node cannot find a path (sometimes this happens with private nodes, or new nodes)
Check the QueryRoutes endpoint for help in determining what the issue is.
curl
curl
$ curl -u sak_XXXXXXX: \
-H "Content-Type: application/json" \
-X POST \
-d '{"dest_pubkey":"033868c219bdb51a33560d854d500fe7d3898a1ad9e05dd89d0007e11313588500","num_satoshis":2}' \
https://api.lnpay.co/v1/wallet/waka_XXXXXXX/keysend
​
# Note we are using the "admin" access_key as denoted by "wa_"
Wallet - Previous
Pay Invoice
Next - Wallet
Transfers Between Wallets
Last updated 2 weeks ago
Keysend

postPostWalletKeysend

post
PostWalletKeysend
