|
|
@ -7,27 +7,60 @@ |
|
|
|
<q-expansion-item group="api" dense expand-separator label="List withdraw links"> |
|
|
|
<q-card> |
|
|
|
<q-card-section> |
|
|
|
|
|
|
|
<code><span class="text-light-blue">GET</span> /withdraw/api/v1/links</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Headers</h5> |
|
|
|
<code>{"X-Api-Key": <invoice_key>}</code><br /> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Returns 201 CREATED (application/json)</h5> |
|
|
|
<code>{"lnurl": <string>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> |
|
|
|
<code>curl -X GET http://127.0.0.1:5000/withdraw/api/v1/links -H "X-Api-Key: <invoice_key>" </code> |
|
|
|
</q-card-section> |
|
|
|
</q-card> |
|
|
|
</q-expansion-item> |
|
|
|
<q-expansion-item group="api" dense expand-separator label="Create a withdraw link"> |
|
|
|
<q-card> |
|
|
|
<q-card-section> |
|
|
|
|
|
|
|
<code><span class="text-light-green">POST</span> /withdraw/api/v1/links</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Headers</h5> |
|
|
|
<code>{"X-Api-Key": <admin_key>}</code><br /> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5> |
|
|
|
<code>{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Returns 201 CREATED (application/json)</h5> |
|
|
|
<code>{"lnurl": <string>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> |
|
|
|
<code>curl -X POST http://127.0.0.1:5000/withdraw/api/v1/links -d '{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}' -H "Content-type: application/json" -H "X-Api-Key: <admin_key>" |
|
|
|
</code> |
|
|
|
</q-card-section> |
|
|
|
</q-card> |
|
|
|
</q-expansion-item> |
|
|
|
<q-expansion-item group="api" dense expand-separator label="Update a withdraw link"> |
|
|
|
<q-card> |
|
|
|
<q-card-section> |
|
|
|
|
|
|
|
<code><span class="text-light-blue">PUT</span> /withdraw/api/v1/links/<withdraw_id></code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Headers</h5> |
|
|
|
<code>{"X-Api-Key": <admin_key>}</code><br /> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Body (application/json)</h5> |
|
|
|
<code>{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Returns 201 CREATED (application/json)</h5> |
|
|
|
<code>{"lnurl": <string>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> |
|
|
|
<code>curl -X PUT http://127.0.0.1:5000/withdraw/api/v1/links/<withdraw_id> -d '{"title": <string>, "min_withdrawable": <integer>, "max_withdrawable": <integer>, "uses": <integer>, "wait_time": <integer>, "is_unique": <boolean>}' -H "Content-type: application/json" -H "X-Api-Key: <admin_key>" |
|
|
|
</code> |
|
|
|
</q-card-section> |
|
|
|
</q-card> |
|
|
|
</q-expansion-item> |
|
|
|
<q-expansion-item group="api" dense expand-separator label="Delete a withdraw link" class="q-pb-md"> |
|
|
|
<q-card> |
|
|
|
<q-card-section> |
|
|
|
<code><span class="text-light-green">DELETE</span> /withdraw/api/v1/links/<withdraw_id></code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Headers</h5> |
|
|
|
<code>{"X-Api-Key": <admin_key>}</code><br /> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Returns 201 NO_CONTENT</h5> |
|
|
|
<code>{"lnurl": <string>}</code> |
|
|
|
<h5 class="text-caption q-mt-sm q-mb-none">Curl example</h5> |
|
|
|
<code>curl -X DELETE http://127.0.0.1:5000/withdraw/api/v1/links/<withdraw_id> -H "X-Api-Key: <admin_key>" |
|
|
|
</code> |
|
|
|
|
|
|
|
</q-card-section> |
|
|
|
</q-card> |
|
|
|