request_invoice
Generate and send payment requests via Lightning Network by specifying recipient address, amount in sats, and optional description or payer metadata.
Instructions
Request an invoice from a lightning address
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | amount in sats | |
| description | No | note, memo or description describing the invoice | |
| lightning_address | Yes | the recipient's lightning address | |
| payer_data | No | metadata to include with the payment such as the payer's name |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"amount": {
"description": "amount in sats",
"type": "number"
},
"description": {
"description": "note, memo or description describing the invoice",
"type": [
"string",
"null"
]
},
"lightning_address": {
"description": "the recipient's lightning address",
"type": "string"
},
"payer_data": {
"anyOf": [
{
"additionalProperties": true,
"description": "metadata to include with the payment such as the payer's name",
"properties": {},
"type": "object"
},
{
"type": "null"
}
],
"description": "metadata to include with the payment such as the payer's name"
}
},
"required": [
"lightning_address",
"amount"
],
"type": "object"
}