Expand description
Request, response, and command types for SDK operations. Lexe SDK API request and response types.
Structs§
- Analyze
Request - A request to analyze the contents of a Bitcoin or Lightning payment string.
Reveals all payment methods encoded in the string, and gives payment-related
details on each. See
PayableDetailsfor more info. - Analyze
Response - The response to a string analysis request.
- Cash
AppBuy Request - A request to buy Bitcoin with Cash App.
- Cash
AppBuy Response - The response to a
CashAppBuyRequest. - Channel
Details - Details about one of this node’s Lightning channels.
- Claimable
Details - Describes basic information for a claimable string.
- Client
Info - Information about a client that can authenticate with a Lexe node.
- Client
Info Response - A response containing information about a single client.
- Close
Channel Request - A request to close a Lightning channel between this node and Lexe’s LSP.
- Create
Client Request - A request to create a new client and client credentials that can authenticate with a Lexe node.
- Create
Client Response - The response to a request to create a new client.
- Create
Invoice Request - A request to create a BOLT 11 invoice.
- Create
Invoice Response - The response to a BOLT 11 invoice request.
- Create
Offer Request - A request to create a BOLT 12 offer to receive Lightning payments.
- Create
Offer Response - The response to a BOLT 12 offer creation request.
- GetHuman
Bitcoin Address Response - The user’s Human Bitcoin Address.
- GetPayment
Request - A request to get information about a payment by its index.
- GetPayment
Response - A response to a request to get information about a payment by its index.
- GetUpdated
Payments Request - Get a batch of payments in ascending
updated_atorder, starting from a givenupdated_atindex. - GetUpdated
Payments Response - A response to a
GetUpdatedPaymentsRequest. - List
Channels Response - The response to a request to list this node’s Lightning channels.
- List
Clients Response - The response to a request listing the active clients on a Lexe node.
- List
Payments Response - Response from listing payments.
- Node
Info - Information about a Lexe node.
- Open
Channel Request - A request to open a Lightning channel from this node to Lexe’s LSP.
- Open
Channel Response - The response to a request to open a channel to the LSP.
- PayInvoice
Request - A request to pay a BOLT 11 invoice.
- PayLnurl
Request - A request to pay to an LNURL-pay endpoint.
- PayOffer
Request - A request to pay a BOLT 12 offer over Lightning.
- PayRequest
- A catch-all request to pay a Bitcoin or Lightning payment string.
- Payable
Details - Describes basic information for a payable string.
- Payment
Sync Summary - Summary of changes from a payment sync operation.
- Revoke
Client Request - A request to permanently revoke a client, making its credentials invalid for authentication. This cannot be undone.
- Update
Client Request - A request to update the properties of an existing client.
- Update
Personal Note Request - A request to update the personal note on an existing payment.
Pass
Noneto clear the note. - Withdraw
Lnurl Request - A request to withdraw from an LNURL-withdraw endpoint.