openapi.json

{
  "openapi": "3.1.1",
  "info": {
    "title": "Materialization.Core.LnBot | v1",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "tags": [
          "Materialization.Core.LnBot"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}": {
      "get": {
        "tags": [
          "Wallet"
        ],
        "summary": "Get wallet by ID",
        "description": "Returns the wallet if it belongs to the authenticated caller.",
        "operationId": "GetWallet",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      },
      "patch": {
        "tags": [
          "Wallet"
        ],
        "summary": "Update wallet",
        "description": "Updates the wallet name.",
        "operationId": "UpdateWallet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateWalletRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/events": {
      "get": {
        "tags": [
          "Events"
        ],
        "summary": "Real-time event stream for wallet activity",
        "description": "Opens a Server-Sent Events (SSE) stream that pushes real-time notifications for the authenticated wallet.\n\n**Events emitted:**\n- `invoice.created` — A new invoice was created\n- `invoice.settled` — An invoice was paid and settled\n- `payment.created` — An outgoing payment was initiated\n- `payment.settled` — An outgoing payment was settled successfully\n- `payment.failed` — An outgoing payment failed\n\n**Message format:**\nEach message is a JSON object with `event`, `created_at`, and `data` fields:\n```\ndata: {\"event\":\"invoice.settled\",\"created_at\":\"...\",\"data\":{...}}\n```\n\n**Keepalive:** A `:keepalive` comment is sent every 30 seconds to keep the connection alive.\n\n**Usage:** Connect with any SSE client (e.g. `EventSource` in browsers, `curl -N`). The stream stays open until the client disconnects. Only events that occur after the connection is opened are delivered.",
        "operationId": "EventStream",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/key": {
      "post": {
        "tags": [
          "Wallet Key"
        ],
        "summary": "Create wallet key",
        "description": "Creates the wallet key (wk_). Each wallet has at most one key. Returns the plaintext key once.",
        "operationId": "CreateWalletKey",
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletKeyResponse"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        }
      },
      "get": {
        "tags": [
          "Wallet Key"
        ],
        "summary": "Get wallet key info",
        "description": "Returns metadata for the wallet key.",
        "operationId": "GetWalletKey",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletKeyInfoResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      },
      "delete": {
        "tags": [
          "Wallet Key"
        ],
        "summary": "Delete wallet key",
        "description": "Revokes the wallet key.",
        "operationId": "DeleteWalletKey",
        "responses": {
          "204": {
            "description": "No Content"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/key/rotate": {
      "post": {
        "tags": [
          "Wallet Key"
        ],
        "summary": "Rotate wallet key",
        "description": "Generates a new secret for the wallet key. The old key is immediately invalidated.",
        "operationId": "RotateWalletKey",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletKeyResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/addresses": {
      "post": {
        "tags": [
          "Addresses"
        ],
        "summary": "Create an address",
        "description": "Creates a random address (if address is null) or claims a vanity address (if provided). Vanity addresses are charged based on length.",
        "operationId": "CreateAddress",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAddressRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddressResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      },
      "get": {
        "tags": [
          "Addresses"
        ],
        "summary": "List wallet addresses",
        "description": "Returns all addresses belonging to the authenticated wallet.",
        "operationId": "ListAddresses",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AddressResponse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/addresses/{address}": {
      "delete": {
        "tags": [
          "Addresses"
        ],
        "summary": "Delete an address",
        "description": "Deletes an address. No refund is given for vanity wallets.",
        "operationId": "DeleteAddress",
        "parameters": [
          {
            "name": "address",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/addresses/{address}/transfer": {
      "post": {
        "tags": [
          "Addresses"
        ],
        "summary": "Transfer address to another wallet",
        "description": "Transfers an address to another wallet. Caller proves source ownership via bearer token, destination ownership by providing its API key.",
        "operationId": "TransferAddress",
        "parameters": [
          {
            "name": "address",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TransferAddressRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TransferAddressResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/invoices": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "summary": "Create a Lightning invoice to receive sats",
        "description": "Creates a BOLT11 invoice for the authenticated wallet. The invoice is valid for 60 minutes. Optionally include a reference for your own tracking and a memo that gets embedded in the BOLT11 invoice.",
        "operationId": "CreateInvoice",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInvoiceRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      },
      "get": {
        "tags": [
          "Invoices"
        ],
        "summary": "List invoices",
        "description": "Returns invoices in reverse chronological order. Use 'after' to paginate by invoice number.",
        "operationId": "ListInvoices",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "after",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/InvoiceResponse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/invoices/{number}": {
      "get": {
        "tags": [
          "Invoices"
        ],
        "summary": "Get a specific invoice by number",
        "description": "Returns the invoice with the given number. Pending invoices past their expiry are reported as expired.",
        "operationId": "GetInvoice",
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/invoices/{paymentHash}": {
      "get": {
        "tags": [
          "Invoices"
        ],
        "summary": "Get a specific invoice by payment hash",
        "description": "Returns the invoice with the given payment hash. Pending invoices past their expiry are reported as expired.",
        "operationId": "GetInvoiceByHash",
        "parameters": [
          {
            "name": "paymentHash",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InvoiceResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/invoices/{number}/events": {
      "get": {
        "tags": [
          "Invoices"
        ],
        "summary": "SSE stream that emits when an invoice settles or expires",
        "description": "Opens a Server-Sent Events stream for a single invoice. Emits a 'settled' or 'expired' event when the invoice state changes, then closes. Use ?timeout= to control max wait (default 60s, max 300s). Sends keepalive comments every 30s.",
        "operationId": "WaitForInvoice",
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "timeout",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/invoices/{paymentHash}/events": {
      "get": {
        "tags": [
          "Invoices"
        ],
        "summary": "SSE stream that emits when an invoice settles or expires (by payment hash)",
        "description": "Opens a Server-Sent Events stream for a single invoice identified by payment hash. Emits a 'settled' or 'expired' event when the invoice state changes, then closes. Use ?timeout= to control max wait (default 60s, max 300s). Sends keepalive comments every 30s.",
        "operationId": "WaitForInvoiceByHash",
        "parameters": [
          {
            "name": "paymentHash",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "timeout",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments": {
      "post": {
        "tags": [
          "Payments"
        ],
        "summary": "Send sats to a Lightning address, LNURL, or BOLT11 invoice",
        "description": "Accepts a Lightning address (user@domain), LNURL (lnurl1...), or a BOLT11 invoice string in the 'target' field. For addresses and LNURLs, 'amount' is required. For BOLT11 invoices, 'amount' is optional (uses the invoice amount if omitted). The amount is placed on hold until settlement or failure. Provide an IdempotencyKey to safely retry without duplicate payments.",
        "operationId": "CreatePayment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreatePaymentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      },
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "List payments",
        "description": "Returns payments in reverse chronological order. Use 'after' to paginate by payment number.",
        "operationId": "ListPayments",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "after",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/PaymentResponse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments/resolve": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Inspect and price a payment target without creating a payment",
        "description": "Resolves a Lightning address, LNURL, or BOLT11 invoice and returns its type and amount constraints, plus what the payment would cost: the network fee quote, the service fee, the fee that would be reserved, and the total. Pass 'amount' to price a Lightning address or LNURL; without it, they return 'maxSendable', the most this wallet can send there now. Pricing a Lightning address or LNURL requests an invoice from the recipient's server. Nothing is sent or held.",
        "operationId": "ResolveTarget",
        "parameters": [
          {
            "name": "target",
            "in": "query",
            "description": "Payment target: Lightning address (user@domain), LNURL (lnurl1...), or BOLT11 invoice.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "amount",
            "in": "query",
            "description": "Amount in satoshis to price the payment for. Optional; for a BOLT11 invoice it must match the invoice amount.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResolveTargetResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments/{number}": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get a specific payment by number",
        "description": "Returns the payment with the given number, including current status and settlement details.",
        "operationId": "GetPayment",
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments/{paymentHash}": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "Get a specific payment by payment hash",
        "description": "Returns the payment with the given payment hash, including current status and settlement details.",
        "operationId": "GetPaymentByHash",
        "parameters": [
          {
            "name": "paymentHash",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaymentResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments/{number}/events": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "SSE stream that emits when a payment settles or fails",
        "description": "Opens a Server-Sent Events stream for a single payment. Emits a 'settled' or 'failed' event when the payment state changes, then closes. Use ?timeout= to control max wait (default 60s, max 300s). Sends keepalive comments every 30s.",
        "operationId": "WaitForPayment",
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "timeout",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/payments/{paymentHash}/events": {
      "get": {
        "tags": [
          "Payments"
        ],
        "summary": "SSE stream that emits when a payment settles or fails (by payment hash)",
        "description": "Opens a Server-Sent Events stream for a single payment identified by payment hash. Emits a 'settled' or 'failed' event when the payment state changes, then closes. Use ?timeout= to control max wait (default 60s, max 300s). Sends keepalive comments every 30s.",
        "operationId": "WaitForPaymentByHash",
        "parameters": [
          {
            "name": "paymentHash",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "timeout",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/transactions": {
      "get": {
        "tags": [
          "Transactions"
        ],
        "summary": "List transactions",
        "description": "Returns credit and debit transactions in reverse chronological order. Each transaction includes the balance after it was applied. Use 'after' to paginate by transaction number.",
        "operationId": "ListTransactions",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "after",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TransactionResponse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/webhooks": {
      "post": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Create a webhook endpoint",
        "description": "Registers a URL to receive event callbacks. The signing secret is returned only once. Maximum 10 endpoints per wallet.",
        "operationId": "CreateWebhook",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateWebhookRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateWebhookResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      },
      "get": {
        "tags": [
          "Webhooks"
        ],
        "summary": "List webhook endpoints",
        "description": "Returns all webhook endpoints for the authenticated wallet. Secrets are not included.",
        "operationId": "ListWebhooks",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WebhookResponse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/webhooks/{id}": {
      "delete": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Delete a webhook endpoint",
        "description": "Deletes a webhook endpoint by ID. Pending deliveries for this endpoint will be discarded.",
        "operationId": "DeleteWebhook",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets/{walletId}/l402/challenges": {
      "post": {
        "tags": [
          "L402"
        ],
        "summary": "Create an L402 challenge (invoice + macaroon)",
        "description": "Creates a Lightning invoice and mints a macaroon for the authenticated wallet. Returns the pre-formatted WWW-Authenticate header value for use in HTTP 402 responses.",
        "operationId": "CreateL402Challenge",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateChallengeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChallengeResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/l402/verify": {
      "post": {
        "tags": [
          "L402"
        ],
        "summary": "Verify an L402 authorization token",
        "description": "Stateless verification of an L402 token. Checks macaroon signature, preimage proof-of-payment, and caveat validity (e.g., expiry). No database lookup needed.",
        "operationId": "VerifyL402Token",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VerifyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerifyResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/{walletId}/l402/pay": {
      "post": {
        "tags": [
          "L402"
        ],
        "summary": "Pay an L402 challenge and get an Authorization header",
        "description": "Parses a WWW-Authenticate header, pays the embedded invoice, and returns a ready-to-use Authorization header. If wait=true (default), polls for settlement up to timeout seconds (default 60, max 120).",
        "operationId": "PayL402Challenge",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/register": {
      "post": {
        "tags": [
          "Account"
        ],
        "summary": "Create a new user",
        "description": "Creates a new user account with two API keys and a recovery phrase. No authentication required.",
        "operationId": "Register",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegisterResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/me": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Get current identity",
        "description": "Returns the user ID (for user keys) or wallet ID (for wallet keys) of the authenticated caller.",
        "operationId": "Me",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MeWalletResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/keys/{slot}/rotate": {
      "post": {
        "tags": [
          "Account"
        ],
        "summary": "Rotate a user API key",
        "description": "Generates a new secret for the specified key slot (0 = primary, 1 = secondary). The old key is immediately invalidated. Requires a user key (uk_).",
        "operationId": "RotateUserKey",
        "parameters": [
          {
            "name": "slot",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RotateKeyResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/wallets": {
      "post": {
        "tags": [
          "Wallet"
        ],
        "summary": "Create a new wallet",
        "description": "Creates a wallet under the authenticated user. Requires a user key (uk_). No wallet keys are created — use the wallet key endpoints to add them.",
        "operationId": "CreateWallet",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateWalletResponse"
                }
              }
            }
          }
        }
      },
      "get": {
        "tags": [
          "Wallet"
        ],
        "summary": "List wallets",
        "description": "Returns all wallets belonging to the authenticated user.",
        "operationId": "ListWallets",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/WalletListItem"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/wallets/current": {
      "get": {
        "tags": [
          "Wallet"
        ],
        "summary": "Get current wallet",
        "description": "Returns the wallet ID, name, and balance of the authenticated wallet. Requires a wallet key (wk_).",
        "operationId": "GetCurrentWallet",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      },
      "patch": {
        "tags": [
          "Wallet"
        ],
        "summary": "Update current wallet",
        "description": "Updates the wallet name. Requires a wallet key (wk_).",
        "operationId": "UpdateCurrentWallet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateWalletRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WalletResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/invoices/for-wallet": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "summary": "Create an invoice for a wallet",
        "description": "Creates a BOLT11 invoice for the given wallet ID (wal_xxx format). The invoice is not saved until payment settles. No authentication required. Rate limited by IP.",
        "operationId": "CreateInvoiceForWallet",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInvoiceForWalletRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddressInvoiceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/invoices/for-address": {
      "post": {
        "tags": [
          "Invoices"
        ],
        "summary": "Create an invoice for a Lightning address",
        "description": "Creates a BOLT11 invoice for the wallet that owns the given Lightning address. The invoice is not saved until payment settles. No authentication required. Rate limited by IP.",
        "operationId": "CreateInvoiceForAddress",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInvoiceForAddressRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddressInvoiceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/v1/status": {
      "get": {
        "tags": [
          "Status"
        ],
        "summary": "Service status",
        "description": "Public status of the service, refreshed every minute: overall and per part (sending, receiving, the node, webhooks), payments in progress by stage and the longest wait, payments sent and failed over the last hour and how long they took, incoming payments credited and waiting, and any notice from the operators. Status is operational, degraded or outage; unknown when it could not be measured for a few minutes. No login needed; cached for 15 seconds.",
        "operationId": "GetStatus",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/status/history": {
      "get": {
        "tags": [
          "Status"
        ],
        "summary": "Service status over time",
        "description": "The service over the last 24 hours (5-minute buckets), 7 days (hourly), 30 days (6-hourly) or 90 days (daily), for charts. Per bucket: how often each part was degraded or in an outage, payments sent and failed, settlement times, payments in progress and the longest wait, incoming payments credited, the node's response time, and the webhook backlog. For the whole range: uptime in percent, totals, settlement times and their distribution. Also the operators' notices. Query: range=24h (default), 7d, 30d or 90d. No login needed; cached for a minute.",
        "operationId": "GetStatusHistory",
        "parameters": [
          {
            "name": "range",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v1/backup/passkey/begin": {
      "post": {
        "tags": [
          "Backup"
        ],
        "summary": "Start passkey backup",
        "description": "Begins WebAuthn registration to back up user access with a passkey. Requires a user key (uk_).",
        "operationId": "BackupPasskeyBegin",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupPasskeyBeginRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BackupPasskeyBeginResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      }
    },
    "/v1/backup/passkey/complete": {
      "post": {
        "tags": [
          "Backup"
        ],
        "summary": "Complete passkey backup",
        "description": "Completes backup by verifying the attestation from the authenticator and linking a passkey to the user.",
        "operationId": "BackupPasskeyComplete",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BackupPasskeyCompleteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad Request"
          },
          "409": {
            "description": "Conflict"
          }
        }
      }
    },
    "/v1/backup/recovery": {
      "post": {
        "tags": [
          "Backup"
        ],
        "summary": "Generate recovery passphrase",
        "description": "Generates a 12-word BIP-39 recovery passphrase and stores an irreversible hash. Returns the passphrase for the user to write down.",
        "operationId": "BackupRecovery",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecoveryBackupResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/restore/passkey/begin": {
      "post": {
        "tags": [
          "Restore"
        ],
        "summary": "Start passkey restore",
        "description": "Begins WebAuthn authentication to restore user access using a passkey.",
        "operationId": "RestorePasskeyBegin",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestorePasskeyBeginRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestorePasskeyBeginResponse"
                }
              }
            }
          }
        }
      }
    },
    "/v1/restore/passkey/complete": {
      "post": {
        "tags": [
          "Restore"
        ],
        "summary": "Complete passkey restore",
        "description": "Completes restore by verifying the assertion. Revokes both user API keys and returns fresh ones.",
        "operationId": "RestorePasskeyComplete",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RestorePasskeyCompleteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RestorePasskeyCompleteResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        }
      }
    },
    "/v1/restore/recovery": {
      "post": {
        "tags": [
          "Restore"
        ],
        "summary": "Restore user with recovery passphrase",
        "description": "Restores user access by verifying the 12-word recovery passphrase. Revokes both user API keys and returns fresh ones.",
        "operationId": "RestoreRecovery",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RecoveryRestoreRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RecoveryRestoreResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AddressInvoiceResponse": {
        "required": [
          "bolt11",
          "amount",
          "expiresAt"
        ],
        "type": "object",
        "properties": {
          "bolt11": {
            "type": "string",
            "description": "BOLT11 Lightning invoice to be paid."
          },
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis.",
            "format": "int64"
          },
          "expiresAt": {
            "type": "string",
            "description": "When the Lightning invoice expires.",
            "format": "date-time"
          }
        }
      },
      "AddressResponse": {
        "required": [
          "address",
          "generated",
          "cost",
          "createdAt"
        ],
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "Lightning address in user@domain format."
          },
          "generated": {
            "type": "boolean",
            "description": "Whether this address was randomly generated (true) or a claimed vanity address (false)."
          },
          "cost": {
            "type": "integer",
            "description": "Cost charged in satoshis (0 for random, varies by length for vanity).",
            "format": "int64"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the address was created.",
            "format": "date-time"
          }
        }
      },
      "Algorithm": {
        "type": "integer"
      },
      "AssertionOptions": {
        "type": "object",
        "properties": {
          "challenge": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "timeout": {
            "type": "integer",
            "format": "uint64"
          },
          "rpId": {
            "type": [
              "null",
              "string"
            ]
          },
          "allowCredentials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublicKeyCredentialDescriptor"
            }
          },
          "userVerification": {
            "$ref": "#/components/schemas/NullableOfUserVerificationRequirement"
          },
          "hints": {
            "type": "array"
          },
          "extensions": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientInputs"
          }
        },
        "description": "WebAuthn assertion options to pass to navigator.credentials.get()."
      },
      "AssertionResponse": {
        "required": [
          "authenticatorData",
          "signature",
          "clientDataJSON"
        ],
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "authenticatorData": {
            "type": "string",
            "format": "byte"
          },
          "signature": {
            "type": "string",
            "format": "byte"
          },
          "clientDataJSON": {
            "type": "string",
            "format": "byte"
          },
          "userHandle": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          }
        }
      },
      "AttestationConveyancePreference": {},
      "AttestationResponse": {
        "required": [
          "attestationObject",
          "clientDataJSON",
          "transports"
        ],
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "attestationObject": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "clientDataJSON": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "transports": {
            "type": [
              "null",
              "array"
            ]
          }
        }
      },
      "AuthenticationExtensionsClientInputs": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "example.extension.bool": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "exts": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "uvm": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "credProps": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "prf": {
            "$ref": "#/components/schemas/AuthenticationExtensionsPRFInputs"
          },
          "largeBlob": {
            "$ref": "#/components/schemas/AuthenticationExtensionsLargeBlobInputs"
          },
          "credentialProtectionPolicy": {
            "$ref": "#/components/schemas/NullableOfCredentialProtectionPolicy"
          },
          "enforceCredentialProtectionPolicy": {
            "type": [
              "null",
              "boolean"
            ]
          }
        }
      },
      "AuthenticationExtensionsClientOutputs": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "example.extension.bool": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "appid": {
            "type": "boolean"
          },
          "exts": {},
          "uvm": {},
          "credProps": {},
          "prf": {},
          "largeBlob": {},
          "credProtect": {
            "$ref": "#/components/schemas/NullableOfCredentialProtectionPolicy"
          }
        }
      },
      "AuthenticationExtensionsLargeBlobInputs": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "support": {
            "$ref": "#/components/schemas/NullableOfLargeBlobSupport"
          },
          "read": {
            "type": "boolean"
          },
          "write": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          }
        }
      },
      "AuthenticationExtensionsPRFInputs": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "eval": {
            "$ref": "#/components/schemas/AuthenticationExtensionsPRFValues"
          },
          "evalByCredential": {
            "$ref": "#/components/schemas/NullableOfKeyValuePairOfstringAndAuthenticationExtensionsPRFValues"
          }
        }
      },
      "AuthenticationExtensionsPRFValues": {
        "required": [
          "first"
        ],
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "first": {
            "type": "string",
            "format": "byte"
          },
          "second": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          }
        }
      },
      "AuthenticatorAssertionRawResponse": {
        "required": [
          "id",
          "rawId",
          "type",
          "clientExtensionResults"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "null",
              "string"
            ]
          },
          "rawId": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "response": {
            "$ref": "#/components/schemas/AssertionResponse"
          },
          "type": {
            "$ref": "#/components/schemas/PublicKeyCredentialType"
          },
          "extensions": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientOutputs"
          },
          "clientExtensionResults": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientOutputs"
          }
        },
        "description": "Assertion response from navigator.credentials.get()."
      },
      "AuthenticatorAttestationRawResponse": {
        "required": [
          "id",
          "rawId",
          "type",
          "response",
          "clientExtensionResults"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": [
              "null",
              "string"
            ]
          },
          "rawId": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "type": {
            "$ref": "#/components/schemas/PublicKeyCredentialType"
          },
          "response": {
            "$ref": "#/components/schemas/AttestationResponse"
          },
          "extensions": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientOutputs"
          },
          "clientExtensionResults": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientOutputs"
          }
        },
        "description": "Attestation response from navigator.credentials.create()."
      },
      "AuthenticatorSelection": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "authenticatorAttachment": {
            "$ref": "#/components/schemas/NullableOfAuthenticatorAttachment"
          },
          "residentKey": {
            "$ref": "#/components/schemas/ResidentKeyRequirement"
          },
          "requireResidentKey": {
            "type": "boolean"
          },
          "userVerification": {
            "$ref": "#/components/schemas/UserVerificationRequirement"
          }
        }
      },
      "BackupPasskeyBeginRequest": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "rpId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Custom relying party domain. Omit to use the default."
          }
        }
      },
      "BackupPasskeyBeginResponse": {
        "required": [
          "sessionId",
          "options"
        ],
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Session ID to pass to the complete endpoint."
          },
          "options": {
            "$ref": "#/components/schemas/CredentialCreateOptions"
          }
        }
      },
      "BackupPasskeyCompleteRequest": {
        "required": [
          "sessionId",
          "attestation"
        ],
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Session ID from the begin response."
          },
          "attestation": {
            "$ref": "#/components/schemas/AuthenticatorAttestationRawResponse"
          }
        }
      },
      "ChallengeResponse": {
        "required": [
          "macaroon",
          "invoice",
          "paymentHash",
          "expiresAt",
          "wwwAuthenticate"
        ],
        "type": "object",
        "properties": {
          "macaroon": {
            "type": "string",
            "description": "Base64-encoded macaroon token."
          },
          "invoice": {
            "type": "string",
            "description": "BOLT11 Lightning invoice to be paid."
          },
          "paymentHash": {
            "type": "string",
            "description": "Hex-encoded SHA-256 payment hash of the invoice."
          },
          "expiresAt": {
            "type": "string",
            "description": "When the Lightning invoice expires.",
            "format": "date-time"
          },
          "wwwAuthenticate": {
            "type": "string",
            "description": "Pre-formatted WWW-Authenticate header value: L402 macaroon=\"<base64>\", invoice=\"<bolt11>\"."
          }
        }
      },
      "CreateAddressRequest": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "address": {
            "type": [
              "null",
              "string"
            ],
            "description": "Vanity address to claim (3-36 chars, alphanumeric + hyphens). Omit for a random address."
          }
        }
      },
      "CreateChallengeRequest": {
        "required": [
          "amount",
          "description",
          "expirySeconds",
          "caveats"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis (1 to 1,000,000,000).",
            "format": "int64"
          },
          "description": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional description embedded in the Lightning invoice (max 256 chars)."
          },
          "expirySeconds": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Optional token expiry in seconds (1 to 31,536,000). Adds an expiry= caveat to the macaroon.",
            "format": "int32"
          },
          "caveats": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "type": "string"
            },
            "description": "Optional custom caveats to embed in the macaroon (max 10, each max 256 chars). Format: key=value."
          }
        }
      },
      "CreateInvoiceForAddressRequest": {
        "required": [
          "address",
          "amount",
          "tag",
          "comment"
        ],
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "Lightning address in user@domain format."
          },
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis (1 to 1,000,000,000).",
            "format": "int64"
          },
          "tag": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional tag for categorizing the payment (max 256 chars)."
          },
          "comment": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional comment from the payer (max 256 chars)."
          }
        }
      },
      "CreateInvoiceForWalletRequest": {
        "required": [
          "walletId",
          "amount",
          "reference",
          "comment"
        ],
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID in wal_xxx format."
          },
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis (1 to 1,000,000,000).",
            "format": "int64"
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional reference string stored with the invoice (max 256 chars)."
          },
          "comment": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional comment from the payer (max 256 chars)."
          }
        }
      },
      "CreateInvoiceRequest": {
        "required": [
          "amount",
          "reference",
          "memo"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis (1 to 1,000,000,000).",
            "format": "int64"
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional reference string stored with the invoice for your own tracking (max 256 chars)."
          },
          "memo": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional memo embedded in the BOLT11 invoice (max 256 chars). Visible to the payer."
          }
        }
      },
      "CreatePaymentRequest": {
        "required": [
          "amount",
          "target",
          "idempotencyKey",
          "maxFee",
          "reference"
        ],
        "type": "object",
        "properties": {
          "amount": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Amount in satoshis. Required for Lightning addresses and LNURLs. Optional for BOLT11 invoices (uses invoice amount if omitted).",
            "format": "int64"
          },
          "target": {
            "type": "string",
            "description": "Payment destination: a Lightning address (user@domain), LNURL (lnurl1...), or BOLT11 invoice string."
          },
          "idempotencyKey": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional idempotency key (UUID recommended). Prevents duplicate payments on retry."
          },
          "maxFee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Maximum network fee in satoshis: the Lightning routing, on top of the 0.25% service fee. Defaults to 1% of the amount, minimum 20 sats. The fee is quoted when the payment is created: a quote above this cap rejects the payment, and only the quote plus a small buffer is held. Ignored for internal transfers.",
            "format": "int64"
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional reference string stored with the payment for your own tracking."
          }
        }
      },
      "CreateWalletResponse": {
        "required": [
          "walletId",
          "name",
          "address"
        ],
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID in wal_xxx format."
          },
          "name": {
            "type": "string",
            "description": "Wallet display name."
          },
          "address": {
            "type": "string",
            "description": "Lightning address assigned to this wallet (user@domain format)."
          }
        }
      },
      "CreateWebhookRequest": {
        "required": [
          "url"
        ],
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Absolute HTTPS URL to receive webhook callbacks (max 2048 chars)."
          }
        }
      },
      "CreateWebhookResponse": {
        "required": [
          "id",
          "url",
          "secret",
          "createdAt"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Webhook endpoint ID (deterministic hash of the URL)."
          },
          "url": {
            "type": "string",
            "description": "Registered webhook URL."
          },
          "secret": {
            "type": "string",
            "description": "HMAC signing secret (hex-encoded, 32 bytes). Store securely — it cannot be retrieved again."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the webhook endpoint was created.",
            "format": "date-time"
          }
        }
      },
      "CredentialCreateOptions": {
        "required": [
          "rp",
          "user",
          "challenge",
          "pubKeyCredParams"
        ],
        "type": "object",
        "properties": {
          "rp": {
            "$ref": "#/components/schemas/PublicKeyCredentialRpEntity"
          },
          "user": {
            "$ref": "#/components/schemas/Fido2User"
          },
          "challenge": {
            "type": "string",
            "format": "byte"
          },
          "pubKeyCredParams": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PubKeyCredParam"
            }
          },
          "timeout": {
            "type": "integer",
            "format": "uint64"
          },
          "attestation": {
            "$ref": "#/components/schemas/AttestationConveyancePreference"
          },
          "attestationFormats": {
            "type": "array"
          },
          "authenticatorSelection": {
            "$ref": "#/components/schemas/AuthenticatorSelection"
          },
          "hints": {
            "type": "array"
          },
          "excludeCredentials": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublicKeyCredentialDescriptor"
            }
          },
          "extensions": {
            "$ref": "#/components/schemas/AuthenticationExtensionsClientInputs"
          }
        },
        "description": "WebAuthn credential creation options to pass to navigator.credentials.create()."
      },
      "ErrorResponse": {
        "required": [
          "error"
        ],
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Error message describing what went wrong."
          }
        }
      },
      "Fido2User": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "null",
              "string"
            ]
          },
          "id": {
            "type": [
              "null",
              "string"
            ],
            "format": "byte"
          },
          "displayName": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "InvoiceResponse": {
        "required": [
          "number",
          "status",
          "amount",
          "bolt11",
          "reference",
          "memo",
          "preimage",
          "txNumber",
          "createdAt",
          "settledAt",
          "expiresAt"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "integer",
            "description": "Sequential invoice number within this wallet.",
            "format": "int32"
          },
          "status": {
            "$ref": "#/components/schemas/InvoiceStatus"
          },
          "amount": {
            "type": "integer",
            "description": "Invoice amount in satoshis.",
            "format": "int64"
          },
          "bolt11": {
            "type": "string",
            "description": "BOLT11 Lightning invoice string."
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference string provided when creating the invoice."
          },
          "memo": {
            "type": [
              "null",
              "string"
            ],
            "description": "Memo embedded in the BOLT11 invoice."
          },
          "preimage": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded preimage revealed on settlement. Null if not yet settled."
          },
          "txNumber": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Transaction number in the wallet ledger. Null if not yet settled.",
            "format": "int32"
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the invoice was created.",
            "format": "date-time"
          },
          "settledAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the invoice was paid. Null if not yet settled.",
            "format": "date-time"
          },
          "expiresAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the invoice expires. Pending invoices past this time are treated as expired.",
            "format": "date-time"
          }
        }
      },
      "InvoiceStatus": {
        "enum": [
          "pending",
          "settled",
          "expired"
        ],
        "description": "Current invoice status."
      },
      "L402PaymentStatus": {
        "enum": [
          "pending",
          "processing",
          "settled",
          "failed"
        ],
        "description": "Current payment status."
      },
      "MeWalletResponse": {
        "required": [
          "walletId"
        ],
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID in wal_xxx format."
          }
        }
      },
      "NullableOfAuthenticatorAttachment": {},
      "NullableOfCredentialProtectionPolicy": {},
      "NullableOfKeyValuePairOfstringAndAuthenticationExtensionsPRFValues": {
        "required": [
          "key",
          "value"
        ],
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "key": {
            "type": [
              "null",
              "string"
            ]
          },
          "value": {
            "$ref": "#/components/schemas/AuthenticationExtensionsPRFValues"
          }
        }
      },
      "NullableOfLargeBlobSupport": {},
      "NullableOfUserVerificationRequirement": {},
      "PaymentResponse": {
        "required": [
          "number",
          "status",
          "amount",
          "maxFee",
          "serviceFee",
          "actualFee",
          "address",
          "reference",
          "preimage",
          "txNumber",
          "failureReason",
          "createdAt",
          "settledAt",
          "stage",
          "statusDetail",
          "retryUntil"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "integer",
            "description": "Sequential payment number within this wallet.",
            "format": "int32"
          },
          "status": {
            "$ref": "#/components/schemas/PaymentStatus"
          },
          "amount": {
            "type": "integer",
            "description": "Payment amount in satoshis.",
            "format": "int64"
          },
          "maxFee": {
            "type": "integer",
            "description": "Network fee reserved in satoshis: the network fee quote plus a small buffer, or the cap when no quote was available. The unused part is released at settlement.",
            "format": "int64"
          },
          "serviceFee": {
            "type": "integer",
            "description": "Service fee charged in satoshis: 0.25%, minimum 1 sat. 0 for internal transfers.",
            "format": "int64"
          },
          "actualFee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Network fee charged in satoshis: the Lightning routing the send actually cost, on top of the service fee. Null if not yet settled.",
            "format": "int64"
          },
          "address": {
            "type": "string",
            "description": "Resolved payment destination (Lightning address, LNURL, or BOLT11)."
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference string provided when creating the payment."
          },
          "preimage": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded preimage (proof of payment). Null if not yet settled."
          },
          "txNumber": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Transaction number in the wallet ledger. Null if not yet settled.",
            "format": "int32"
          },
          "failureReason": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reason the payment failed. Null if not failed."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the payment was created.",
            "format": "date-time"
          },
          "settledAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the payment settled. Null if not yet settled.",
            "format": "date-time"
          },
          "stage": {
            "$ref": "#/components/schemas/PaymentStage"
          },
          "statusDetail": {
            "type": [
              "null",
              "string"
            ],
            "description": "What is happening with the payment, in words to show the user. The failure reason once failed; null once settled."
          },
          "retryUntil": {
            "type": [
              "null",
              "string"
            ],
            "description": "While retrying: until when it is retried. If it still can't be sent by then, it fails and the funds are released. Null otherwise.",
            "format": "date-time"
          }
        }
      },
      "PaymentStage": {
        "enum": [
          "queued",
          "sending",
          "retrying",
          "in_flight",
          "confirming",
          "on_hold",
          "settled",
          "failed"
        ],
        "description": "Where the payment is, finer than status: queued, sending, retrying (not sent yet; retried for a few minutes, then failed with the funds released), in_flight (sent; the Lightning network is completing it), confirming (checking with the network whether it went out), on_hold (interrupted by an older version; under review), settled or failed."
      },
      "PaymentStatus": {
        "enum": [
          "pending",
          "processing",
          "settled",
          "failed"
        ],
        "description": "Current payment status."
      },
      "PayRequest": {
        "required": [
          "wwwAuthenticate",
          "maxFee",
          "reference",
          "wait",
          "timeout"
        ],
        "type": "object",
        "properties": {
          "wwwAuthenticate": {
            "type": "string",
            "description": "WWW-Authenticate header value from an HTTP 402 response. Format: L402 macaroon=\"<base64>\", invoice=\"<bolt11>\"."
          },
          "maxFee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Maximum network fee in satoshis: the Lightning routing, on top of the 0.25% service fee. Defaults to 1% of the amount, minimum 20 sats.",
            "format": "int64"
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Optional reference string stored with the payment for tracking."
          },
          "wait": {
            "type": [
              "null",
              "boolean"
            ],
            "description": "If true (default), polls for settlement up to timeout seconds before returning."
          },
          "timeout": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Max seconds to wait for settlement (1-120, default 60). Only used when wait=true.",
            "format": "int32"
          }
        }
      },
      "PayResponse": {
        "required": [
          "authorization",
          "paymentHash",
          "preimage",
          "amount",
          "fee",
          "paymentNumber",
          "status"
        ],
        "type": "object",
        "properties": {
          "authorization": {
            "type": [
              "null",
              "string"
            ],
            "description": "Ready-to-use authorization token: L402 <base64_macaroon>:<hex_preimage>. Null if payment hasn't settled yet."
          },
          "paymentHash": {
            "type": "string",
            "description": "Hex-encoded SHA-256 payment hash."
          },
          "preimage": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded preimage (proof of payment). Null if not yet settled."
          },
          "amount": {
            "type": "integer",
            "description": "Payment amount in satoshis.",
            "format": "int64"
          },
          "fee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Network fee charged in satoshis: the Lightning routing, not counting the 0.25% service fee. Null if not yet settled.",
            "format": "int64"
          },
          "paymentNumber": {
            "type": "integer",
            "description": "Payment number for this wallet. Can be used to poll payment status.",
            "format": "int32"
          },
          "status": {
            "$ref": "#/components/schemas/L402PaymentStatus"
          }
        }
      },
      "PubKeyCredParam": {
        "required": [
          "alg"
        ],
        "type": "object",
        "properties": {
          "type": {
            "default": "public-key"
          },
          "alg": {
            "$ref": "#/components/schemas/Algorithm"
          }
        }
      },
      "PublicKeyCredentialDescriptor": {
        "required": [
          "type",
          "id"
        ],
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/PublicKeyCredentialType"
          },
          "id": {
            "type": "string",
            "format": "byte"
          },
          "transports": {
            "type": [
              "null",
              "array"
            ]
          }
        }
      },
      "PublicKeyCredentialRpEntity": {
        "required": [
          "id",
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "icon": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "PublicKeyCredentialType": {},
      "RecoveryBackupResponse": {
        "required": [
          "passphrase"
        ],
        "type": "object",
        "properties": {
          "passphrase": {
            "type": "string",
            "description": "12-word BIP-39 recovery passphrase. Store securely — it cannot be retrieved again."
          }
        }
      },
      "RecoveryRestoreRequest": {
        "required": [
          "passphrase"
        ],
        "type": "object",
        "properties": {
          "passphrase": {
            "type": "string",
            "description": "12-word BIP-39 recovery passphrase."
          }
        }
      },
      "RecoveryRestoreResponse": {
        "required": [
          "userId",
          "primaryKey",
          "secondaryKey"
        ],
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "User ID in usr_xxx format."
          },
          "primaryKey": {
            "type": "string",
            "description": "New primary API key. Store securely — it cannot be retrieved again."
          },
          "secondaryKey": {
            "type": "string",
            "description": "New secondary API key. Store securely — it cannot be retrieved again."
          }
        }
      },
      "RegisterResponse": {
        "required": [
          "userId",
          "primaryKey",
          "secondaryKey",
          "recoveryPassphrase"
        ],
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "User ID in usr_xxx format."
          },
          "primaryKey": {
            "type": "string",
            "description": "Primary API key. Store securely — it cannot be retrieved again."
          },
          "secondaryKey": {
            "type": "string",
            "description": "Secondary API key. Store securely — it cannot be retrieved again."
          },
          "recoveryPassphrase": {
            "type": "string",
            "description": "12-word BIP-39 recovery passphrase. Store securely — it cannot be retrieved again."
          }
        }
      },
      "ResidentKeyRequirement": {},
      "ResolveTargetResponse": {
        "required": [
          "type",
          "min",
          "max",
          "fixed",
          "amount",
          "internal",
          "networkFeeEstimate",
          "serviceFee",
          "maxFee",
          "total",
          "maxSendable",
          "feeWarning"
        ],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Target type: \"lightning_address\", \"lnurl\", or \"bolt11\"."
          },
          "min": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Minimum accepted amount in satoshis. Null for BOLT11 invoices.",
            "format": "int64"
          },
          "max": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Maximum accepted amount in satoshis. Null for BOLT11 invoices.",
            "format": "int64"
          },
          "fixed": {
            "type": "boolean",
            "description": "True if the recipient expects a fixed amount (min == max, or BOLT11 with amount)."
          },
          "amount": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The amount priced: the invoice amount for a BOLT11 invoice, or the requested amount. Null when no amount was given.",
            "format": "int64"
          },
          "internal": {
            "type": "boolean",
            "description": "True when the target is a wallet on this service: an internal transfer with no network or service fee."
          },
          "networkFeeEstimate": {
            "type": [
              "null",
              "integer"
            ],
            "description": "The network fee quote in satoshis for Amount: the Lightning routing, on top of the service fee. Null without an amount, or when no quote is available. 0 for internal transfers.",
            "format": "int64"
          },
          "serviceFee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Service fee in satoshis for Amount: 0.25%, minimum 1 sat. 0 for internal transfers. Null without an amount.",
            "format": "int64"
          },
          "maxFee": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Network fee that would be reserved with the default maxFee: the quote plus a small buffer, or the default limit when no quote is available. The unused part is released at settlement. Null without an amount, or when the quote is above the default limit (see FeeWarning).",
            "format": "int64"
          },
          "total": {
            "type": [
              "null",
              "integer"
            ],
            "description": "Expected total cost in satoshis: Amount plus the network fee estimate and the service fee. Uses the reserved limit when no quote is available. Null without an amount.",
            "format": "int64"
          },
          "maxSendable": {
            "type": [
              "null",
              "integer"
            ],
            "description": "For a Lightning address or LNURL asked without an amount: the most this wallet can send there now with the default maxFee, after fees (0 if it can't cover the recipient's minimum). Null otherwise.",
            "format": "int64"
          },
          "feeWarning": {
            "type": [
              "null",
              "string"
            ],
            "description": "Set when creating this payment with the default maxFee would be rejected, for example because the fee quote is above the default limit."
          }
        }
      },
      "RestorePasskeyBeginRequest": {
        "type": [
          "null",
          "object"
        ],
        "properties": {
          "rpId": {
            "type": [
              "null",
              "string"
            ],
            "description": "Custom relying party domain. Must match the domain used during backup."
          }
        }
      },
      "RestorePasskeyBeginResponse": {
        "required": [
          "sessionId",
          "options"
        ],
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Session ID to pass to the complete endpoint."
          },
          "options": {
            "$ref": "#/components/schemas/AssertionOptions"
          }
        }
      },
      "RestorePasskeyCompleteRequest": {
        "required": [
          "sessionId",
          "assertion"
        ],
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Session ID from the begin response."
          },
          "assertion": {
            "$ref": "#/components/schemas/AuthenticatorAssertionRawResponse"
          }
        }
      },
      "RestorePasskeyCompleteResponse": {
        "required": [
          "userId",
          "primaryKey",
          "secondaryKey"
        ],
        "type": "object",
        "properties": {
          "userId": {
            "type": "string",
            "description": "User ID in usr_xxx format."
          },
          "primaryKey": {
            "type": "string",
            "description": "New primary API key. Store securely — it cannot be retrieved again."
          },
          "secondaryKey": {
            "type": "string",
            "description": "New secondary API key. Store securely — it cannot be retrieved again."
          }
        }
      },
      "RotateKeyResponse": {
        "required": [
          "key",
          "name"
        ],
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The new plaintext API key. Store securely — it cannot be retrieved again."
          },
          "name": {
            "type": "string",
            "description": "Key name: Primary or Secondary."
          }
        }
      },
      "TransactionResponse": {
        "required": [
          "number",
          "type",
          "amount",
          "balanceAfter",
          "networkFee",
          "serviceFee",
          "paymentHash",
          "preimage",
          "reference",
          "note",
          "createdAt"
        ],
        "type": "object",
        "properties": {
          "number": {
            "type": "integer",
            "description": "Sequential transaction number within this wallet.",
            "format": "int32"
          },
          "type": {
            "$ref": "#/components/schemas/TransactionType"
          },
          "amount": {
            "type": "integer",
            "description": "Transaction amount in satoshis. For debits, includes fees.",
            "format": "int64"
          },
          "balanceAfter": {
            "type": "integer",
            "description": "Wallet balance in satoshis after this transaction was applied.",
            "format": "int64"
          },
          "networkFee": {
            "type": "integer",
            "description": "Lightning network routing fee in satoshis (debit only).",
            "format": "int64"
          },
          "serviceFee": {
            "type": "integer",
            "description": "Service fee in satoshis (debit only).",
            "format": "int64"
          },
          "paymentHash": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded SHA-256 payment hash. Null for non-Lightning transactions."
          },
          "preimage": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded preimage (proof of payment). Null for non-Lightning transactions."
          },
          "reference": {
            "type": [
              "null",
              "string"
            ],
            "description": "Reference string from the associated invoice or payment."
          },
          "note": {
            "type": [
              "null",
              "string"
            ],
            "description": "Human-readable note (e.g. 'Transfer from Alice', 'Vanity address: cool')."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the transaction was created.",
            "format": "date-time"
          }
        }
      },
      "TransactionType": {
        "enum": [
          "credit",
          "debit"
        ],
        "description": "Transaction type: credit (incoming) or debit (outgoing)."
      },
      "TransferAddressRequest": {
        "required": [
          "targetWalletKey"
        ],
        "type": "object",
        "properties": {
          "targetWalletKey": {
            "type": "string",
            "description": "API key of the destination wallet. Proves ownership of the target wallet."
          }
        }
      },
      "TransferAddressResponse": {
        "required": [
          "address",
          "transferredTo"
        ],
        "type": "object",
        "properties": {
          "address": {
            "type": "string",
            "description": "Lightning address that was transferred."
          },
          "transferredTo": {
            "type": "string",
            "description": "Wallet ID (wal_xxx) the address was transferred to."
          }
        }
      },
      "UpdateWalletRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "New wallet name (1-50 chars)."
          }
        }
      },
      "UserVerificationRequirement": {},
      "VerifyRequest": {
        "required": [
          "authorization"
        ],
        "type": "object",
        "properties": {
          "authorization": {
            "type": "string",
            "description": "L402 authorization token in format: L402 <base64_macaroon>:<hex_preimage>."
          }
        }
      },
      "VerifyResponse": {
        "required": [
          "valid",
          "paymentHash",
          "caveats",
          "error"
        ],
        "type": "object",
        "properties": {
          "valid": {
            "type": "boolean",
            "description": "Whether the token is valid (signature, preimage, and caveats all pass)."
          },
          "paymentHash": {
            "type": [
              "null",
              "string"
            ],
            "description": "Hex-encoded payment hash extracted from the macaroon, if parseable."
          },
          "caveats": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "type": "string"
            },
            "description": "Caveats extracted from the macaroon, if parseable."
          },
          "error": {
            "type": [
              "null",
              "string"
            ],
            "description": "Error message if validation failed. Null when valid."
          }
        }
      },
      "WalletKeyInfoResponse": {
        "required": [
          "hint",
          "createdAt",
          "lastUsedAt"
        ],
        "type": "object",
        "properties": {
          "hint": {
            "type": "string",
            "description": "Display hint showing first and last characters of the key."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the key was created.",
            "format": "date-time"
          },
          "lastUsedAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the key was last used.",
            "format": "date-time"
          }
        }
      },
      "WalletKeyResponse": {
        "required": [
          "key",
          "hint"
        ],
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The new plaintext wallet API key. Store securely — it cannot be retrieved again."
          },
          "hint": {
            "type": "string",
            "description": "Display hint showing first and last characters of the key."
          }
        }
      },
      "WalletListItem": {
        "required": [
          "walletId",
          "name",
          "createdAt"
        ],
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID in wal_xxx format."
          },
          "name": {
            "type": "string",
            "description": "Wallet display name."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the wallet was created.",
            "format": "date-time"
          }
        }
      },
      "WalletResponse": {
        "required": [
          "walletId",
          "name",
          "balance",
          "onHold",
          "available"
        ],
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID in wal_xxx format."
          },
          "name": {
            "type": "string",
            "description": "Wallet display name."
          },
          "balance": {
            "type": "integer",
            "description": "Total balance in satoshis.",
            "format": "int64"
          },
          "onHold": {
            "type": "integer",
            "description": "Amount reserved for pending payments in satoshis.",
            "format": "int64"
          },
          "available": {
            "type": "integer",
            "description": "Balance minus on-hold amount in satoshis. This is what can be spent.",
            "format": "int64"
          }
        }
      },
      "WebhookResponse": {
        "required": [
          "id",
          "url",
          "active",
          "createdAt"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Webhook endpoint ID."
          },
          "url": {
            "type": "string",
            "description": "Registered webhook URL."
          },
          "active": {
            "type": "boolean",
            "description": "Whether this endpoint is active and receiving events."
          },
          "createdAt": {
            "type": [
              "null",
              "string"
            ],
            "description": "When the webhook endpoint was created.",
            "format": "date-time"
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Materialization.Core.LnBot"
    },
    {
      "name": "Wallet"
    },
    {
      "name": "Events"
    },
    {
      "name": "Wallet Key"
    },
    {
      "name": "Addresses"
    },
    {
      "name": "Invoices"
    },
    {
      "name": "Payments"
    },
    {
      "name": "Transactions"
    },
    {
      "name": "Webhooks"
    },
    {
      "name": "L402"
    },
    {
      "name": "Account"
    },
    {
      "name": "Status"
    },
    {
      "name": "Backup"
    },
    {
      "name": "Restore"
    }
  ]
}