diff options
| author | Adam Soltys <[email protected]> | 2025-07-09 12:09:08 -0700 |
|---|---|---|
| committer | Adam Soltys <[email protected]> | 2025-07-09 12:09:08 -0700 |
| commit | ee8e20ce1dbcc0476ec698dd8c9d0ff99e260db7 (patch) | |
| tree | 40f458d46cf6d097a150d5adeb7ab274a30f3690 /src | |
| parent | 3d924ed5aa1475124426e6cbbeae34647f1f82f2 (diff) | |
| download | coinos-ui-ee8e20ce1dbcc0476ec698dd8c9d0ff99e260db7.tar.gz coinos-ui-ee8e20ce1dbcc0476ec698dd8c9d0ff99e260db7.zip | |
update docs
Diffstat (limited to 'src')
| -rw-r--r-- | src/routes/(static)/docs/+page.svelte | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/src/routes/(static)/docs/+page.svelte b/src/routes/(static)/docs/+page.svelte index 7ac6e013..f53787e5 100644 --- a/src/routes/(static)/docs/+page.svelte +++ b/src/routes/(static)/docs/+page.svelte @@ -105,16 +105,18 @@ <div class="text-secondary"> <div>Request params</div> <div class="grid grid-cols-3 ml-2"> - <div class="font-bold">type</div> + <div class="font-bold">type (string, default: lightning)</div> <div class="col-span-2">bitcoin or lightning</div> - <div class="font-bold">amount</div> - <div class="col-span-2">amount in satoshis</div> - <div class="font-bold">webhook</div> + <div class="font-bold">fiat (boolean, default: false)</div> + <div class="col-span-2">whether the amount is denominated in satoshis or local currency</div> + <div class="font-bold">amount (numeric)</div> + <div class="col-span-2">amount to be paid</div> + <div class="font-bold">webhook (string, optional)</div> <div class="col-span-2"> - (optional) endpoint to hit when the invoice is paid + remote endpoint to call when the invoice is paid </div> - <div class="font-bold">secret</div> - <div class="col-span-2">a secret for the webhook to check</div> + <div class="font-bold">secret (string, optional)</div> + <div class="col-span-2">a secret value passed to the webhook to authenticate the request</div> </div> </div> |