mirrors/btcpayserver
1
0
Fork 0
mirror of https://github.com/btcpayserver/btcpayserver.git synced 2025-01-18 21:32:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Swagger: Fix errors, warnings and formatting (#6410)

Browse Source 
* Fix linting errors

* Fix linting warnings

* Fix inconsistend indentation and unify formatting

* Extract StoreId schemas

* Extract CryptoCode parameter

* Extract AppId parameter

* More StoreId parameter references

* Extract WebhookId and DeliveryId parameters

* Extract InvoiceId parameter

* Formatting
This commit is contained in:
d11n 2024-11-20 14:46:55 +01:00 committed by GitHub
parent 4279ee1962
commit 7db510b5ca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
25 changed files with 706 additions and 1292 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
BTCPayServer/wwwroot/swagger/v1/swagger.template.api-keys.json
View File

@ -14,7 +14,9 @@
"in": "path",
"required": true,
"description": "The API Key to revoke",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"responses": {
@ -27,7 +29,9 @@
},
"security": [
{
"API_Key": [ "unrestricted" ],
"API_Key": [
"unrestricted"
],
"Basic": []
}
]
@ -47,14 +51,18 @@
"in": "path",
"required": true,
"description": "The target user's id or email",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
},
{
"name": "apikey",
"in": "path",
"required": true,
"description": "The API Key to revoke",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"responses": {
@ -67,7 +75,9 @@
},
"security": [
{
"API_Key": [ "unrestricted" ],
"API_Key": [
"unrestricted"
],
"Basic": []
}
]
@ -105,7 +115,9 @@
},
"security": [
{
"API_Key": [ "btcpay.server.canmanageusers" ],
"API_Key": [
"btcpay.server.canmanageusers"
],
"Basic": []
}
]
@ -214,7 +226,9 @@
},
"security": [
{
"API_Key": [ "unrestricted" ],
"API_Key": [
"unrestricted"
],
"Basic": []
}
]
@ -234,7 +248,9 @@
"in": "path",
"required": true,
"description": "The target user's id or email",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"responses": {
@ -297,7 +313,9 @@
},
"security": [
{
"API_Key": [ "btcpay.server.canmanageusers" ],
"API_Key": [
"btcpay.server.canmanageusers"
],
"Basic": []
}
]
@ -312,7 +330,7 @@
"properties": {
"apiKey": {
"type": "string",
"description": "The API Key to use for API Key Authentication",
"description": "The API Key to use for API Key Authentication",
"nullable": false
},
"label": {
@ -327,7 +345,10 @@
"items": {
"type": "string"
},
"example": [ "btcpay.server.canmanageusers", "btcpay.server.canmanageusers:2KxSpc9V5zDWfUbvgYiZuAfka4wUhGF96F75Ao8y4zHP" ]
"example": [
"btcpay.server.canmanageusers",
"btcpay.server.canmanageusers:2KxSpc9V5zDWfUbvgYiZuAfka4wUhGF96F75Ao8y4zHP"
]
}
}
}

257
BTCPayServer/wwwroot/swagger/v1/swagger.template.apps.json
View File

@ -3,13 +3,7 @@
"/api/v1/stores/{storeId}/apps/pos": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"post": {
@ -66,13 +60,7 @@
"/api/v1/apps/pos/{appId}": {
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "App ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
}
],
"put": {
@ -161,13 +149,7 @@
"/api/v1/apps/crowdfund/{appId}": {
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "Crowdfund app ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
}
],
"get": {
@ -206,13 +188,7 @@
"/api/v1/stores/{storeId}/apps/crowdfund": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"post": {
@ -276,13 +252,7 @@
"description": "Returns basic app data shared between all types of apps",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "The app ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
}
],
"responses": {
@ -318,13 +288,7 @@
"description": "Deletes apps with specified ID",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "The app ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
}
],
"responses": {
@ -352,6 +316,11 @@
],
"summary": "Uploads an image for a app item",
"description": "Uploads an image for a app item",
"parameters": [
{
"$ref": "#/components/parameters/AppId"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
@ -403,6 +372,20 @@
"summary": "Deletes the app item image",
"description": "Deletes the app item image",
"operationId": "App_DeleteAppItemImage",
"parameters": [
{
"$ref": "#/components/parameters/AppId"
},
{
"name": "fileId",
"in": "path",
"required": true,
"description": "The file ID",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "App item image deleted successfully"
@ -431,13 +414,7 @@
"description": "Returns sales statistics for the app",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "The app ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
},
{
"name": "numberOfDays",
@ -486,13 +463,7 @@
"description": "Returns top items statistics for the app",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"description": "The app ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/AppId"
},
{
"name": "count",
@ -548,82 +519,93 @@
"/api/v1/stores/{storeId}/apps": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"get": {
"tags": [
"Apps"
],
"operationId": "Apps_GetAllAppsForStore",
"summary": "Get basic app data for all apps for a store",
"description": "Returns basic app data for all apps for a store",
"responses": {
"200": {
"description": "Array of basic app data object",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppBaseData"
}
}
"tags": [
"Apps"
],
"operationId": "Apps_GetAllAppsForStore",
"summary": "Get basic app data for all apps for a store",
"description": "Returns basic app data for all apps for a store",
"responses": {
"200": {
"description": "Array of basic app data object",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppBaseData"
}
}
}
}
}
}
},
"security": [
{
"API_Key": [
"btcpay.store.canmodifystoresettings"
],
"Basic": []
}
]
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
}
},
"security": [
{
"API_Key": [
"btcpay.store.canmodifystoresettings"
],
"Basic": []
}
]
}
},
"/api/v1/apps": {
"get": {
"tags": [
"Apps"
],
"operationId": "Apps_GetAllApps",
"summary": "Get basic app data for all apps for all stores for a user",
"description": "Returns basic app data for all apps for all stores",
"responses": {
"200": {
"description": "Array of basic app data object",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppBaseData"
"get": {
"tags": [
"Apps"
],
"operationId": "Apps_GetAllApps",
"summary": "Get basic app data for all apps for all stores for a user",
"description": "Returns basic app data for all apps for all stores",
"responses": {
"200": {
"description": "Array of basic app data object",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppBaseData"
}
}
}
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
}
}
},
"security": [
{
"API_Key": [
"btcpay.store.canmodifystoresettings"
],
"Basic": []
}
]
}
}
},
"security": [
{
"API_Key": [
"btcpay.store.canmodifystoresettings"
],
"Basic": []
}
]
}
}
},
"components": {
"parameters": {
"AppId": {
"name": "appId",
"in": "path",
"required": true,
"description": "App ID",
"schema": {
"type": "string"
}
}
},
"schemas": {
"AppBaseData": {
"type": "object",
@ -639,9 +621,12 @@
"example": "my test app"
},
"storeId": {
"type": "string",
"description": "Id of the store to which the app belongs",
"example": "9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776"
"allOf": [
{
"$ref": "#/components/schemas/StoreId"
}
]
},
"created": {
"type": "integer",
@ -770,7 +755,11 @@
"items": {
"type": "number"
},
"default": [15,18,20],
"default": [
15,
18,
20
],
"nullable": true
},
"notificationUrl": {
@ -894,14 +883,22 @@
"startDate": {
"type": "number",
"description": "UNIX timestamp for crowdfund start time (https://www.unixtimestamp.com/)",
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}],
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
],
"example": 768658369,
"nullable": true
},
"endDate": {
"type": "number",
"description": "UNIX timestamp for crowdfund end time (https://www.unixtimestamp.com/)",
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}],
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
],
"example": 771336769,
"nullable": true
},
@ -985,7 +982,9 @@
"items": {
"type": "string"
},
"example": ["https://github.com/ClaudiuHKS/AdvancedQuakeSounds/raw/master/sound/AQS/doublekill.wav"],
"example": [
"https://github.com/ClaudiuHKS/AdvancedQuakeSounds/raw/master/sound/AQS/doublekill.wav"
],
"nullable": true
},
"animationColors": {
@ -994,7 +993,11 @@
"items": {
"type": "string"
},
"example": ["#FF0000", "#00FF00", "#0000FF"],
"example": [
"#FF0000",
"#00FF00",
"#0000FF"
],
"nullable": true
},
"formId": {

1
BTCPayServer/wwwroot/swagger/v1/swagger.template.files.json
View File

@ -202,6 +202,7 @@
"nullable": true
},
"created": {
"type": "number",
"nullable": true,
"description": "The creation date of the file as a unix timestamp",
"allOf": [

3
BTCPayServer/wwwroot/swagger/v1/swagger.template.health.json
View File

@ -19,6 +19,9 @@
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
},
"default": {
"description": "Unexpected error",
"content": {

159
BTCPayServer/wwwroot/swagger/v1/swagger.template.invoices.json
View File

@ -8,13 +8,7 @@
"summary": "Get invoices",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "orderId",
@ -136,13 +130,7 @@
"summary": "Create a new invoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Create a new invoice",
@ -200,22 +188,10 @@
"summary": "Get invoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"description": "View information about the specified invoice",
@ -256,22 +232,10 @@
"operationId": "Invoices_ArchiveInvoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store the invoice belongs to",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to remove",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"responses": {
@ -313,22 +277,10 @@
"operationId": "Invoices_UpdateInvoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store the invoice belongs to",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"responses": {
@ -387,22 +339,10 @@
"summary": "Get invoice payment methods",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
},
{
"name": "onlyAccountedPayments",
@ -467,22 +407,10 @@
"summary": "Mark invoice status",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"description": "Mark an invoice as invalid or settled.",
@ -540,22 +468,10 @@
"summary": "Unarchive invoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"description": "Unarchive an invoice",
@ -603,22 +519,10 @@
"summary": "Activate Payment Method",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -662,22 +566,10 @@
"summary": "Refund invoice",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice to refund",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
}
],
"description": "Refund invoice",
@ -790,6 +682,7 @@
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"nullable": false,
"description": "Mark an invoice as completed or invalid.",
"allOf": [
@ -856,6 +749,7 @@
"$ref": "#/components/schemas/InvoiceMetadata"
},
"checkout": {
"type": "object",
"nullable": true,
"description": "Additional settings to customize the checkout flow",
"allOf": [
@ -865,6 +759,7 @@
]
},
"receipt": {
"type": "object",
"nullable": true,
"description": "Additional settings to customize the public receipt",
"allOf": [
@ -889,8 +784,12 @@
"description": "The identifier of the invoice"
},
"storeId": {
"type": "string",
"description": "The store identifier that the invoice belongs to"
"description": "The store identifier that the invoice belongs to",
"allOf": [
{
"$ref": "#/components/schemas/StoreId"
}
]
},
"amount": {
"type": "string",
@ -1119,6 +1018,7 @@
"title": "Receipt information",
"properties": {
"receiptData": {
"type": "object",
"description": "A custom JSON object that represents information displayed on the receipt page of an invoice.",
"nullable": true
}
@ -1174,6 +1074,7 @@
"additionalProperties": false,
"properties": {
"speedPolicy": {
"type": "string",
"nullable": true,
"allOf": [
{
@ -1195,6 +1096,7 @@
"$ref": "#/components/schemas/PaymentMethodId"
}
],
"type": "string",
"nullable": true,
"description": "Default payment type for the invoice (e.g., BTC, BTC-LightningNetwork). Default payment method set for the store is used if this parameter is not specified."
},
@ -1204,6 +1106,7 @@
"description": "If true, payment methods are enabled individually upon user interaction in the invoice. Default to store's settings'"
},
"expirationMinutes": {
"type": "number",
"nullable": true,
"description": "The number of minutes after which an invoice becomes expired. Defaults to the store's settings. (The default store settings is 15)",
"allOf": [

371
BTCPayServer/wwwroot/swagger/v1/swagger.template.json
View File

@ -1,183 +1,208 @@
{
"openapi": "3.0.0",
"info": {
"title": "BTCPay Greenfield API",
"version": "v1",
"description": "# Introduction\n\nThe BTCPay Server Greenfield API is a REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Authentication\n\nYou can authenticate either via Basic Auth or an API key. It's recommended to use an API key for better security. You can create an API key in the BTCPay Server UI under `Account` -> `Manage Account` -> `API keys`. You can restrict the API key for one or multiple stores and for specific permissions. For testing purposes, you can give it the 'Unrestricted access' permission. On production you should limit the permissions to the actual endpoints you use, you can see the required permission on the API docs at the top of each endpoint under `AUTHORIZATIONS`.\n\nIf you want to simplify the process of creating API keys for your users, you can use the [Authorization endpoint](https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Authorization) to predefine permissions and redirect your users to the BTCPay Server Authorization UI. You can find more information about this on the [API Authorization Flow docs](https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/) page.\n\n# Usage examples\n\nUse **Basic Auth** to read store information with cURL:\n```bash\nBTCPAY_INSTANCE=\"https://mainnet.demo.btcpayserver.org\"\nUSER=\"MyTestUser@gmail.com\"\nPASSWORD=\"notverysecurepassword\"\nPERMISSION=\"btcpay.store.canmodifystoresettings\"\nBODY=\"$(echo \"{}\" | jq --arg \"a\" \"$PERMISSION\" '. + {permissions:[$a]}')\"\n\nAPI_KEY=\"$(curl -s \\\n -H \"Content-Type: application/json\" \\\n --user \"$USER:$PASSWORD\" \\\n -X POST \\\n -d \"$BODY\" \\\n \"$BTCPAY_INSTANCE/api/v1/api-keys\" | jq -r .apiKey)\"\n```\n\n\nUse an **API key** to read store information with cURL:\n```bash\nSTORE_ID=\"yourStoreId\"\n\ncurl -s \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: token $API_KEY\" \\\n -X GET \\\n \"$BTCPAY_INSTANCE/api/v1/stores/$STORE_ID\"\n```\n\nYou can find more examples on our docs for different programming languages:\n- [cURL](https://docs.btcpayserver.org/Development/GreenFieldExample/)\n- [Javascript/Node.Js](https://docs.btcpayserver.org/Development/GreenFieldExample-NodeJS/)\n- [PHP](https://docs.btcpayserver.org/Development/GreenFieldExample-PHP/)\n\n",
"contact": {
"name": "BTCPay Server",
"url": "https://btcpayserver.org"
},
"license": {
"name": "MIT",
"url": "https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE"
}
},
"servers": [
{
"url": "/",
"description": "BTCPay Server Greenfield API"
}
],
"externalDocs": {
"description": "Check out our examples on how to use the API",
"url": "https://docs.btcpayserver.org/Development/GreenFieldExample/"
},
"components": {
"schemas": {
"ValidationProblemDetails": {
"type": "array",
"description": "An array of validation errors of the request",
"items": {
"type": "object",
"description": "A specific validation error on a json property",
"properties": {
"path": {
"type": "string",
"nullable": false,
"description": "The json path of the property which failed validation"
},
"message": {
"type": "string",
"nullable": false,
"description": "User friendly error message about the validation"
}
}
}
},
"ProblemDetails": {
"type": "object",
"description": "Description of an error happening during processing of the request",
"properties": {
"code": {
"type": "string",
"nullable": false,
"description": "An error code describing the error"
},
"message": {
"type": "string",
"nullable": false,
"description": "User friendly error message about the error"
}
}
},
"UnixTimestamp": {
"type": "number",
"format": "int32",
"example": 1592312018,
"description": "A unix timestamp in seconds"
},
"SpeedPolicy": {
"type": "string",
"description": "This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transaction made by the consumer on the selected cryptocurrency.\n`\"HighSpeed\"`: 0 confirmations (1 confirmation if RBF enabled in transaction) \n`\"MediumSpeed\"`: 1 confirmation \n`\"LowMediumSpeed\"`: 2 confirmations \n`\"LowSpeed\"`: 6 confirmations\n",
"x-enumNames": [
"HighSpeed",
"MediumSpeed",
"LowSpeed",
"LowMediumSpeed"
],
"enum": [
"HighSpeed",
"MediumSpeed",
"LowSpeed",
"LowMediumSpeed"
]
},
"TimeSpan": {
"type": "number",
"format": "int32",
"example": 90
},
"TimeSpanSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/TimeSpan"
}
],
"format": "seconds",
"description": "A span of times in seconds"
},
"TimeSpanMinutes": {
"allOf": [
{
"$ref": "#/components/schemas/TimeSpan"
}
],
"format": "minutes",
"description": "A span of times in minutes"
},
"PaymentMethodId": {
"type": "string",
"description": "Payment method IDs. Available payment method IDs for Bitcoin are: \n- `\"BTC-CHAIN\"`: Onchain \n-`\"BTC-LN\"`: Lightning \n- `\"BTC-LNURL\"`: LNURL",
"example": "BTC-CHAIN"
},
"PayoutMethodId": {
"type": "string",
"description": "Payout method IDs. Available payment method IDs for Bitcoin are: \n- `\"BTC-CHAIN\"`: Onchain \n-`\"BTC-LN\"`: Lightning",
"example": "BTC-LN"
"openapi": "3.0.0",
"info": {
"title": "BTCPay Greenfield API",
"version": "v1",
"description": "# Introduction\n\nThe BTCPay Server Greenfield API is a REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Authentication\n\nYou can authenticate either via Basic Auth or an API key. It's recommended to use an API key for better security. You can create an API key in the BTCPay Server UI under `Account` -> `Manage Account` -> `API keys`. You can restrict the API key for one or multiple stores and for specific permissions. For testing purposes, you can give it the 'Unrestricted access' permission. On production you should limit the permissions to the actual endpoints you use, you can see the required permission on the API docs at the top of each endpoint under `AUTHORIZATIONS`.\n\nIf you want to simplify the process of creating API keys for your users, you can use the [Authorization endpoint](https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Authorization) to predefine permissions and redirect your users to the BTCPay Server Authorization UI. You can find more information about this on the [API Authorization Flow docs](https://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/) page.\n\n# Usage examples\n\nUse **Basic Auth** to read store information with cURL:\n```bash\nBTCPAY_INSTANCE=\"https://mainnet.demo.btcpayserver.org\"\nUSER=\"MyTestUser@gmail.com\"\nPASSWORD=\"notverysecurepassword\"\nPERMISSION=\"btcpay.store.canmodifystoresettings\"\nBODY=\"$(echo \"{}\" | jq --arg \"a\" \"$PERMISSION\" '. + {permissions:[$a]}')\"\n\nAPI_KEY=\"$(curl -s \\\n -H \"Content-Type: application/json\" \\\n --user \"$USER:$PASSWORD\" \\\n -X POST \\\n -d \"$BODY\" \\\n \"$BTCPAY_INSTANCE/api/v1/api-keys\" | jq -r .apiKey)\"\n```\n\n\nUse an **API key** to read store information with cURL:\n```bash\nSTORE_ID=\"yourStoreId\"\n\ncurl -s \\\n -H \"Content-Type: application/json\" \\\n -H \"Authorization: token $API_KEY\" \\\n -X GET \\\n \"$BTCPAY_INSTANCE/api/v1/stores/$STORE_ID\"\n```\n\nYou can find more examples on our docs for different programming languages:\n- [cURL](https://docs.btcpayserver.org/Development/GreenFieldExample/)\n- [Javascript/Node.Js](https://docs.btcpayserver.org/Development/GreenFieldExample-NodeJS/)\n- [PHP](https://docs.btcpayserver.org/Development/GreenFieldExample-PHP/)\n\n",
"contact": {
"name": "BTCPay Server",
"url": "https://btcpayserver.org"
},
"HistogramData": {
"type": "object",
"description": "Histogram data for wallet balances over time",
"properties": {
"type": {
"type": "string",
"description": "The timespan of the histogram data",
"x-enumNames": [
"Week",
"Month",
"Year"
],
"enum": [
"Week",
"Month",
"Year"
],
"default": "Week"
},
"balance": {
"type": "string",
"format": "decimal",
"description": "The current wallet balance"
},
"series": {
"type": "array",
"description": "An array of historic balances of the wallet",
"items": {
"license": {
"name": "MIT",
"url": "https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE"
}
},
"servers": [
{
"url": "/",
"description": "BTCPay Server Greenfield API"
}
],
"externalDocs": {
"description": "Check out our examples on how to use the API",
"url": "https://docs.btcpayserver.org/Development/GreenFieldExample/"
},
"components": {
"parameters": {
"StoreId": {
"name": "storeId",
"in": "path",
"required": true,
"description": "The store ID",
"schema": {
"$ref": "#/components/schemas/StoreId"
}
},
"InvoiceId": {
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice ID",
"schema": {
"type": "string"
}
}
},
"schemas": {
"ValidationProblemDetails": {
"type": "array",
"description": "An array of validation errors of the request",
"items": {
"type": "object",
"description": "A specific validation error on a json property",
"properties": {
"path": {
"type": "string",
"nullable": false,
"description": "The json path of the property which failed validation"
},
"message": {
"type": "string",
"nullable": false,
"description": "User friendly error message about the validation"
}
}
}
},
"ProblemDetails": {
"type": "object",
"description": "Description of an error happening during processing of the request",
"properties": {
"code": {
"type": "string",
"nullable": false,
"description": "An error code describing the error"
},
"message": {
"type": "string",
"nullable": false,
"description": "User friendly error message about the error"
}
}
},
"UnixTimestamp": {
"type": "number",
"format": "int32",
"example": 1592312018,
"description": "A unix timestamp in seconds"
},
"SpeedPolicy": {
"type": "string",
"description": "This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transaction made by the consumer on the selected cryptocurrency.\n`\"HighSpeed\"`: 0 confirmations (1 confirmation if RBF enabled in transaction) \n`\"MediumSpeed\"`: 1 confirmation \n`\"LowMediumSpeed\"`: 2 confirmations \n`\"LowSpeed\"`: 6 confirmations\n",
"x-enumNames": [
"HighSpeed",
"MediumSpeed",
"LowSpeed",
"LowMediumSpeed"
],
"enum": [
"HighSpeed",
"MediumSpeed",
"LowSpeed",
"LowMediumSpeed"
]
},
"TimeSpan": {
"type": "number",
"format": "int32",
"example": 90
},
"TimeSpanSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/TimeSpan"
}
],
"format": "seconds",
"description": "A span of times in seconds"
},
"TimeSpanMinutes": {
"allOf": [
{
"$ref": "#/components/schemas/TimeSpan"
}
],
"format": "minutes",
"description": "A span of times in minutes"
},
"StoreId": {
"type": "string",
"description": "Store ID of the item",
"example": "9CiNzKoANXxmk5ayZngSXrHTiVvvgCrwrpFQd4m2K776"
},
"PaymentMethodId": {
"type": "string",
"description": "Payment method IDs. Available payment method IDs for Bitcoin are: \n- `\"BTC-CHAIN\"`: Onchain \n-`\"BTC-LN\"`: Lightning \n- `\"BTC-LNURL\"`: LNURL",
"example": "BTC-CHAIN"
},
"PayoutMethodId": {
"type": "string",
"description": "Payout method IDs. Available payment method IDs for Bitcoin are: \n- `\"BTC-CHAIN\"`: Onchain \n-`\"BTC-LN\"`: Lightning",
"example": "BTC-LN"
},
"HistogramData": {
"type": "object",
"description": "Histogram data for wallet balances over time",
"properties": {
"type": {
"type": "string",
"description": "The timespan of the histogram data",
"x-enumNames": [
"Week",
"Month",
"Year"
],
"enum": [
"Week",
"Month",
"Year"
],
"default": "Week"
},
"balance": {
"type": "string",
"format": "decimal",
"description": "The balance of the wallet at a specific time"
}
},
"labels": {
"type": "array",
"description": "An array of timestamps associated with the series data",
"items": {
"type": "integer",
"description": "UNIX timestamp of the balance snapshot"
"description": "The current wallet balance"
},
"series": {
"type": "array",
"description": "An array of historic balances of the wallet",
"items": {
"type": "string",
"format": "decimal",
"description": "The balance of the wallet at a specific time"
}
},
"labels": {
"type": "array",
"description": "An array of timestamps associated with the series data",
"items": {
"type": "integer",
"description": "UNIX timestamp of the balance snapshot"
}
}
}
}
},
"securitySchemes": {
"API_Key": {
"type": "apiKey",
"description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `unrestricted`: Unrestricted access\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canviewprofile`: View your profile\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.canviewusers`: View users\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.canviewreports`: View your reports\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canviewpullpayments`: View your pull payments\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.canmanagepayouts`: Manage payouts\n* `btcpay.store.canviewpayouts`: View payouts\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n",
"name": "Authorization",
"in": "header"
},
"Basic": {
"type": "http",
"description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission",
"scheme": "Basic"
}
}
},
"securitySchemes": {
"API_Key": {
"type": "apiKey",
"description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `unrestricted`: Unrestricted access\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canviewprofile`: View your profile\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.canviewusers`: View users\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.canviewreports`: View your reports\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canviewpullpayments`: View your pull payments\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.canmanagepayouts`: Manage payouts\n* `btcpay.store.canviewpayouts`: View payouts\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n",
"name": "Authorization",
"in": "header"
},
"Basic": {
"type": "http",
"description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission",
"scheme": "Basic"
}
}
},
"security": [
{
"API_Key": [],
"Basic": []
}
]
"security": [
{
"API_Key": [],
"Basic": []
}
]
}

41
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.common.json
View File

@ -1,5 +1,17 @@
{
"components": {
"parameters": {
"CryptoCode": {
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
}
},
"schemas": {
"ConnectToNodeRequest": {
"type": "object",
@ -33,7 +45,11 @@
},
"expiry": {
"description": "Expiration time in seconds",
"allOf": [ {"$ref": "#/components/schemas/TimeSpanSeconds"}]
"allOf": [
{
"$ref": "#/components/schemas/TimeSpanSeconds"
}
]
},
"privateRouteHints": {
"type": "boolean",
@ -102,9 +118,14 @@
"description": "The payment preimage (available when status is complete)"
},
"createdAt": {
"type": "number",
"description": "The unix timestamp when the payment got created",
"nullable": true,
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"totalAmount": {
"type": "string",
@ -133,13 +154,22 @@
"nullable": false
},
"paidAt": {
"type": "number",
"description": "The unix timestamp when the invoice got paid",
"nullable": true,
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"expiresAt": {
"description": "The unix timestamp when the invoice expires",
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"amount": {
"type": "string",
@ -250,6 +280,7 @@
"type": "object",
"properties": {
"onchain": {
"type": "object",
"description": "On-chain balance of the Lightning node",
"nullable": true,
"allOf": [
@ -259,6 +290,7 @@
]
},
"offchain": {
"type": "object",
"description": "Off-chain balance of the Lightning node",
"nullable": true,
"allOf": [
@ -340,6 +372,7 @@
"example": "21"
},
"sendTimeout": {
"type": "number",
"nullable": true,
"example": 30,
"default": 30,

117
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.internal.json
View File

@ -8,14 +8,7 @@
"summary": "Get node information",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "View information about the lightning node",
@ -56,14 +49,7 @@
"summary": "Get node balance",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "View balance of the lightning node",
@ -104,14 +90,7 @@
"summary": "Get node balance histogram",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "View balance histogram of the lightning node",
@ -152,14 +131,7 @@
"summary": "Connect to lightning node",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "Connect to another lightning node.",
@ -223,14 +195,7 @@
"summary": "Get channels",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "View information about the current channels of the lightning node",
@ -269,14 +234,7 @@
"summary": "Open channel",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "Open a channel with another lightning node. You should connect to that node first.",
@ -337,14 +295,7 @@
"summary": "Get deposit address",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "Get an on-chain deposit address for the lightning node ",
@ -387,14 +338,7 @@
"summary": "Get payment",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "paymentHash",
@ -445,14 +389,7 @@
"summary": "Get invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "id",
@ -503,14 +440,7 @@
"summary": "Pay Lightning Invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "Pay a lightning invoice. In case the payment response times out, the status will be reported as pending and the final status can be resolved using the [Get payment](#operation/InternalLightningNodeApi_GetPayment) endpoint. The default wait time for payment responses is 30 seconds — it might take longer if multiple routes are tried or a hold invoice is getting paid.",
@ -592,14 +522,7 @@
"summary": "Get invoices",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "pendingOnly",
@ -680,14 +603,7 @@
"summary": "Create lightning invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
}
],
"description": "Create a lightning invoice.",
@ -748,14 +664,7 @@
"summary": "Get payments",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "includePending",

214
BTCPayServer/wwwroot/swagger/v1/swagger.template.lightning.store.json
View File

@ -8,23 +8,10 @@
"summary": "Get node information",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View information about the lightning node",
@ -65,23 +52,10 @@
"summary": "Get node balance",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View balance of the lightning node",
@ -122,23 +96,10 @@
"summary": "Get node balance histogram",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View balance histogram of the lightning node",
@ -179,23 +140,10 @@
"summary": "Connect to lightning node",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Connect to another lightning node.",
@ -259,23 +207,10 @@
"summary": "Get channels",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View information about the current channels of the lightning node",
@ -314,23 +249,10 @@
"summary": "Open channel",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Open a channel with another lightning node. You should connect to that node first.",
@ -405,13 +327,7 @@
"example": "BTC"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Get an on-chain deposit address for the lightning node ",
@ -444,7 +360,6 @@
]
}
},
"/api/v1/stores/{storeId}/lightning/{cryptoCode}/payments/{paymentHash}": {
"get": {
"tags": [
@ -453,23 +368,10 @@
"summary": "Get payment",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentHash",
@ -511,7 +413,6 @@
]
}
},
"/api/v1/stores/{storeId}/lightning/{cryptoCode}/invoices/{id}": {
"get": {
"tags": [
@ -520,23 +421,10 @@
"summary": "Get invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "id",
@ -586,23 +474,10 @@
"summary": "Pay Lightning Invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Pay a lightning invoice. In case the payment response times out, the status will be reported as pending and the final status can be resolved using the [Get payment](#operation/StoreLightningNodeApi_GetPayment) endpoint. The default wait time for payment responses is 30 seconds — it might take longer if multiple routes are tried or a hold invoice is getting paid.",
@ -683,23 +558,10 @@
"summary": "Get invoices",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "pendingOnly",
@ -780,23 +642,10 @@
"summary": "Create lightning invoice",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Create a lightning invoice.",
@ -857,23 +706,10 @@
"summary": "Get payments",
"parameters": [
{
"name": "cryptoCode",
"in": "path",
"required": true,
"description": "The cryptoCode of the lightning-node to query",
"schema": {
"type": "string"
},
"example": "BTC"
"$ref": "#/components/parameters/CryptoCode"
},
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id with the lightning-node configuration to query",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "includePending",

20
BTCPayServer/wwwroot/swagger/v1/swagger.template.misc.json
View File

@ -33,6 +33,9 @@
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
},
"default": {
"description": "Unexpected error",
"content": {
@ -84,6 +87,9 @@
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
},
"default": {
"description": "Unexpected error",
"content": {
@ -132,6 +138,9 @@
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
},
"default": {
"description": "Unexpected error",
"content": {
@ -149,13 +158,7 @@
"/i/{invoiceId}": {
"parameters": [
{
"name": "invoiceId",
"in": "path",
"required": true,
"description": "The invoice id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/InvoiceId"
},
{
"name": "lang",
@ -182,6 +185,9 @@
"example": "The HTML checkout page of the invoice"
}
}
},
"404": {
"description": "The invoice could not be found"
}
},
"security": []

23
BTCPayServer/wwwroot/swagger/v1/swagger.template.notifications.json
View File

@ -63,6 +63,9 @@
}
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
}
},
"security": [
@ -255,7 +258,7 @@
],
"summary": "Update notification settings",
"description": "Updates the current user's notification settings",
"operationId": "Notifications_UpdateNotification",
"operationId": "Notifications_UpdateNotificationSettings",
"responses": {
"200": {
"description": "The current user's notification settings",
@ -327,6 +330,11 @@
"description": "The html body of the notifications"
},
"storeId": {
"allOf": [
{
"$ref": "#/components/schemas/StoreId"
}
],
"type": "string",
"nullable": true,
"description": "If related to a store, the store id of the notification"
@ -338,8 +346,12 @@
"description": "The link of the notification"
},
"createdTime": {
"description": "The creation time of the notification",
"allOf": [ {"$ref": "#/components/schemas/UnixTimestamp"}]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
],
"description": "The creation time of the notification"
},
"seen": {
"type": "boolean",
@ -357,7 +369,10 @@
"type": "string"
},
"description": "List of the notification type identifiers, which should be disabled. Can also be a single item 'all'.",
"example": ["newversion", "pluginupdate"],
"example": [
"newversion",
"pluginupdate"
],
"nullable": false
}
}

86
BTCPayServer/wwwroot/swagger/v1/swagger.template.payment-requests.json
View File

@ -8,11 +8,7 @@
"summary": "Get payment requests",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View information about the existing payment requests",
@ -55,11 +51,7 @@
"summary": "Create a new payment request",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Create a new payment request",
@ -117,18 +109,16 @@
"summary": "Get payment request",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentRequestId",
"in": "path",
"required": true,
"description": "The payment request to fetch",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"description": "View information about the specified payment request",
@ -169,18 +159,16 @@
"operationId": "PaymentRequests_ArchivePaymentRequest",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store the payment request belongs to",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentRequestId",
"in": "path",
"required": true,
"description": "The payment request to remove",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"responses": {
@ -206,7 +194,9 @@
},
"security": [
{
"API_Key": [ "btcpay.store.canmodifypaymentrequests" ],
"API_Key": [
"btcpay.store.canmodifypaymentrequests"
],
"Basic": []
}
]
@ -218,18 +208,16 @@
"summary": "Update payment request",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to query",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentRequestId",
"in": "path",
"required": true,
"description": "The payment request to update",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"description": "Update a payment request",
@ -287,18 +275,16 @@
"summary": "Create a new invoice for the payment request",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": { "type": "string" }
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentRequestId",
"in": "path",
"required": true,
"description": "The payment request to create",
"schema": { "type": "string" }
"schema": {
"type": "string"
}
}
],
"operationId": "PaymentRequests_Pay",
@ -324,7 +310,7 @@
"type": "boolean",
"nullable": true,
"default": false,
"description": "If `true`, this endpoint will not necessarily create a new invoice, and instead attempt to give back a pending one for this payment request."
"description": "If `true`, this endpoint will not necessarily create a new invoice, and instead attempt to give back a pending one for this payment request."
}
}
}
@ -397,17 +383,32 @@
},
"storeId": {
"type": "string",
"description": "The store identifier that the payment request belongs to"
"nullable": false,
"description": "The store identifier that the payment request belongs to",
"allOf": [
{
"$ref": "#/components/schemas/StoreId"
}
]
},
"status": {
"type": "string",
"enum": [ "Pending", "Completed", "Expired" ],
"enum": [
"Pending",
"Completed",
"Expired"
],
"description": "The status of the payment request",
"nullable": false
},
"createdTime": {
"type": "number",
"description": "The creation date of the payment request",
"allOf": [ { "$ref": "#/components/schemas/UnixTimestamp" } ],
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
],
"nullable": false
}
}
@ -450,9 +451,14 @@
"format": "html"
},
"expiryDate": {
"type": "number",
"description": "The expiry date of the payment request",
"nullable": true,
"allOf": [ { "$ref": "#/components/schemas/UnixTimestamp" } ]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"allowCustomPaymentAmounts": {
"type": "boolean",

77
BTCPayServer/wwwroot/swagger/v1/swagger.template.payout-processors.json
View File

@ -8,13 +8,7 @@
"summary": "Get store configured payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Get store configured payout processors",
@ -58,13 +52,7 @@
"summary": "Remove store configured payout processor",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "processor",
@ -123,6 +111,9 @@
}
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
}
},
"security": [
@ -141,13 +132,7 @@
"summary": "Get configured store onchain automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -192,13 +177,7 @@
"summary": "Update configured store onchain automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -254,13 +233,7 @@
"summary": "Get configured store Lightning automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PayoutMethodId"
@ -305,16 +278,10 @@
"summary": "Update configured store Lightning automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
"$ref": "#/components/parameters/PayoutMethodId"
}
],
"description": "Update configured store Lightning automated payout processors",
@ -367,13 +334,7 @@
"summary": "Get configured store onchain automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Get configured store onchain automated payout processors",
@ -415,13 +376,7 @@
"summary": "Update configured store onchain automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Update configured store onchain automated payout processors",
@ -474,13 +429,7 @@
"summary": "Get configured store Lightning automated payout processors",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Get configured store Lightning automated payout processors",

56
BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json
View File

@ -20,7 +20,9 @@
"content": {
"application/json": {
"schema": {
"required": [ "UID" ],
"required": [
"UID"
],
"type": "object",
"properties": {
"UID": {
@ -89,7 +91,6 @@
"description": "The public key K4 of the boltcard",
"example": "02a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b"
}
}
}
}
@ -115,13 +116,7 @@
"/api/v1/stores/{storeId}/pull-payments": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store ID",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"get": {
@ -150,6 +145,9 @@
}
}
}
},
"403": {
"description": "If you are authenticated but forbidden to get the data"
}
},
"tags": [
@ -313,13 +311,7 @@
"/api/v1/stores/{storeId}/pull-payments/{pullPaymentId}": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "pullPaymentId",
@ -551,13 +543,7 @@
"/api/v1/stores/{storeId}/payouts": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"post": {
@ -664,13 +650,7 @@
"/api/v1/stores/{storeId}/payouts/{payoutId}": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "payoutId",
@ -813,13 +793,7 @@
"/api/v1/stores/{storeId}/payouts/{payoutId}/mark-paid": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "payoutId",
@ -879,13 +853,7 @@
"/api/v1/stores/{storeId}/payouts/{payoutId}/mark": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The ID of the store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "payoutId",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-email.json
View File

@ -8,13 +8,7 @@
"summary": "Get store email settings",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View email settings of the specified store",
@ -53,13 +47,7 @@
"summary": "Update store email settings",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Update a store's email settings",
@ -121,13 +109,7 @@
"description": "Send an email using the store's SMTP server",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to send the email from",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"requestBody": {

32
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-lightning-addresses.json
View File

@ -8,13 +8,7 @@
"summary": "Get store configured lightning addresses",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Get store configured lightning addresses",
@ -58,13 +52,7 @@
"summary": "Get store configured lightning address",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "username",
@ -112,13 +100,7 @@
"summary": "Add or update store configured lightning address",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "username",
@ -178,13 +160,7 @@
"summary": "Remove configured lightning address",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "username",

34
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-payment-methods.json
View File

@ -10,13 +10,7 @@
"operationId": "StorePaymentMethods_GetStorePaymentMethods",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "onlyEnabled",
@ -92,13 +86,7 @@
"operationId": "StorePaymentMethods_GetStorePaymentMethod",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "includeConfig",
@ -163,13 +151,7 @@
"operationId": "StorePaymentMethods_UpdateStorePaymentMethod",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -234,13 +216,7 @@
"operationId": "StorePaymentMethods_DeleteStorePaymentMethod",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -295,7 +271,7 @@
"example": "BTC-CHAIN"
},
"PayoutMethodId": {
"name": "paymentMethodId",
"name": "payoutMethodId",
"in": "path",
"required": true,
"description": "The payout method id",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-rates-config.json
View File

@ -8,13 +8,7 @@
"summary": "Get store rate settings",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View rate settings of the specified store",
@ -52,13 +46,7 @@
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"summary": "Update store rate settings",
@ -118,13 +106,7 @@
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "currencyPair",

14
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-rates.json
View File

@ -7,18 +7,15 @@
],
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "currencyPair",
"description": "The currency pairs to fetch rates for",
"example": [ "BTC_USD", "BTC_EUR" ],
"example": [
"BTC_USD",
"BTC_EUR"
],
"in": "query",
"style": "form",
"explode": true,
@ -35,7 +32,6 @@
"summary": "Get rates",
"description": "Get rates on the store",
"operationId": "Stores_GetStoreRates",
"responses": {
"200": {
"description": "The settings were executed and a preview was returned",

24
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-users.json
View File

@ -8,13 +8,7 @@
"summary": "Get store users",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View users of the specified store",
@ -55,13 +49,7 @@
"operationId": "Stores_AddStoreUser",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"requestBody": {
@ -124,13 +112,7 @@
"description": "Removes the specified store user. If there is no other owner, this endpoint will fail.",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "idOrEmail",

116
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.json
View File

@ -8,13 +8,7 @@
"summary": "Get store on-chain wallet overview",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -58,13 +52,7 @@
"summary": "Get store on-chain wallet balance histogram",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -108,13 +96,7 @@
"summary": "Get store on-chain wallet fee rate",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -168,13 +150,7 @@
"summary": "Get store on-chain wallet address",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -226,13 +202,7 @@
"summary": "UnReserve last store on-chain wallet address",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -269,13 +239,7 @@
"summary": "Get store on-chain wallet transactions",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -363,13 +327,7 @@
"summary": "Create store on-chain wallet transaction",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -431,13 +389,7 @@
"summary": "Get store on-chain wallet transaction",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -488,13 +440,7 @@
"summary": "Patch store on-chain wallet transaction info",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -566,13 +512,7 @@
"summary": "Get store on-chain wallet UTXOS",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -619,13 +559,7 @@
"summary": "Generate store on-chain wallet",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -706,13 +640,7 @@
"summary": "Preview store on-chain payment method addresses",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "paymentMethodId",
@ -779,13 +707,7 @@
"summary": "Preview proposed store on-chain payment method addresses",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -1119,7 +1041,11 @@
},
"timestamp": {
"description": "The time of the transaction",
"allOf": [ { "$ref": "#/components/schemas/UnixTimestamp" } ]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"status": {
"allOf": [
@ -1163,7 +1089,11 @@
},
"timestamp": {
"description": "The time of the utxo",
"allOf": [ { "$ref": "#/components/schemas/UnixTimestamp" } ]
"allOf": [
{
"$ref": "#/components/schemas/UnixTimestamp"
}
]
},
"keyPath": {
"type": "string",

56
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores-wallet.on-chain.objects.json
View File

@ -8,13 +8,7 @@
"summary": "Get store on-chain wallet objects",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -24,7 +18,9 @@
"in": "query",
"required": false,
"description": "The type of object to fetch",
"schema": { "type": "string" },
"schema": {
"type": "string"
},
"example": "tx"
},
{
@ -34,7 +30,9 @@
"description": "The ids of objects to fetch, if used, type should be specified",
"schema": {
"type": "array",
"items": { "type": "string" }
"items": {
"type": "string"
}
},
"example": "03abcde..."
},
@ -88,13 +86,7 @@
"summary": "Add/Update store on-chain wallet objects",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -148,13 +140,7 @@
"summary": "Get store on-chain wallet object",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -226,13 +212,7 @@
"summary": "Remove store on-chain wallet objects",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -289,13 +269,7 @@
"summary": "Add/Update store on-chain wallet object link",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"
@ -362,13 +336,7 @@
"summary": "Remove store on-chain wallet object links",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"$ref": "#/components/parameters/PaymentMethodId"

64
BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json
View File

@ -101,13 +101,7 @@
"summary": "Get store",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View information about the specified store",
@ -146,13 +140,7 @@
"summary": "Update store",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to update",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "Update the specified store",
@ -215,13 +203,7 @@
"description": "Removes the specified store. If there is another user with access, only your access will be removed.",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to remove",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"responses": {
@ -262,6 +244,11 @@
],
"summary": "Uploads a logo for the store",
"description": "Uploads a logo for the store",
"parameters": [
{
"$ref": "#/components/parameters/StoreId"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
@ -311,6 +298,11 @@
"summary": "Deletes the store logo",
"description": "Delete the store's logo",
"operationId": "Stores_DeleteStoreLogo",
"parameters": [
{
"$ref": "#/components/parameters/StoreId"
}
],
"responses": {
"200": {
"description": "Store logo deleted successfully"
@ -337,13 +329,7 @@
"summary": "Get store's roles",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store to fetch",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"description": "View information about the specified store's roles",
@ -438,6 +424,7 @@
"type": "object",
"properties": {
"paymentMethodId": {
"type": "string",
"allOf": [
{
"$ref": "#/components/schemas/PaymentMethodId"
@ -525,21 +512,33 @@
"minimum": 60,
"maximum": 2073600,
"description": "The time after which an invoice is considered expired if not paid. The value will be rounded down to a minute.",
"allOf": [ { "$ref": "#/components/schemas/TimeSpanSeconds" } ]
"allOf": [
{
"$ref": "#/components/schemas/TimeSpanSeconds"
}
]
},
"displayExpirationTimer": {
"default": 300,
"minimum": 60,
"maximum": 2073600,
"description": "The time left that will trigger the countdown timer on the checkout page to be shown. The value will be rounded down to a minute.",
"allOf": [ { "$ref": "#/components/schemas/TimeSpanSeconds" } ]
"allOf": [
{
"$ref": "#/components/schemas/TimeSpanSeconds"
}
]
},
"monitoringExpiration": {
"default": 3600,
"minimum": 600,
"maximum": 2073600,
"description": "The time after which an invoice which has been paid but not confirmed will be considered invalid. The value will be rounded down to a minute.",
"allOf": [ { "$ref": "#/components/schemas/TimeSpanSeconds" } ]
"allOf": [
{
"$ref": "#/components/schemas/TimeSpanSeconds"
}
]
},
"speedPolicy": {
"$ref": "#/components/schemas/SpeedPolicy"
@ -568,6 +567,7 @@
"description": "If true, then no authentication is needed to create invoices on this store."
},
"receipt": {
"type": "object",
"nullable": true,
"description": "Additional settings to customize the public receipt",
"allOf": [
@ -658,7 +658,7 @@
"$ref": "#/components/schemas/PaymentMethodId"
},
"paymentMethodCriteria": {
"type": "array",
"type": "object",
"nullable": true,
"items": {
"$ref": "#/components/schemas/PaymentMethodCriteriaData"

1
BTCPayServer/wwwroot/swagger/v1/swagger.template.users.json
View File

@ -561,6 +561,7 @@
"description": "True if the instance requires approval to log in"
},
"created": {
"type": "number",
"nullable": true,
"description": "The creation date of the user as a unix timestamp. Null if created before v1.0.5.6",
"allOf": [

141
BTCPayServer/wwwroot/swagger/v1/swagger.template.webhooks.json
View File

@ -3,13 +3,7 @@
"/api/v1/stores/{storeId}/webhooks": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
}
],
"get": {
@ -97,22 +91,10 @@
"/api/v1/stores/{storeId}/webhooks/{webhookId}": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/WebhookId"
}
],
"get": {
@ -223,22 +205,10 @@
"/api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/WebhookId"
}
],
"get": {
@ -287,31 +257,13 @@
"/api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/WebhookId"
},
{
"name": "deliveryId",
"in": "path",
"required": true,
"description": "The id of the delivery",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/DeliveryId"
}
],
"get": {
@ -349,31 +301,13 @@
"/api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}/request": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/WebhookId"
},
{
"name": "deliveryId",
"in": "path",
"required": true,
"description": "The id of the delivery",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/DeliveryId"
}
],
"get": {
@ -415,31 +349,13 @@
"/api/v1/stores/{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver": {
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"description": "The store id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/StoreId"
},
{
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/WebhookId"
},
{
"name": "deliveryId",
"in": "path",
"required": true,
"description": "The id of the delivery",
"schema": {
"type": "string"
}
"$ref": "#/components/parameters/DeliveryId"
}
],
"post": {
@ -479,6 +395,26 @@
}
},
"components": {
"parameters": {
"WebhookId": {
"name": "webhookId",
"in": "path",
"required": true,
"description": "The webhook id",
"schema": {
"type": "string"
}
},
"DeliveryId": {
"name": "deliveryId",
"in": "path",
"required": true,
"description": "The id of the delivery",
"schema": {
"type": "string"
}
}
},
"schemas": {
"WebhookDeliveryList": {
"type": "array",
@ -495,6 +431,7 @@
"nullable": false
},
"timestamp": {
"type": "number",
"nullable": false,
"description": "Timestamp of when the delivery got broadcasted",
"allOf": [
@ -685,7 +622,12 @@
"storeId": {
"type": "string",
"description": "The store id of the invoice's event",
"nullable": false
"nullable": false,
"allOf": [
{
"$ref": "#/components/schemas/StoreId"
}
]
},
"invoiceId": {
"type": "string",
@ -785,6 +727,7 @@
"$ref": "#/components/schemas/PaymentMethodId"
}
],
"type": "string",
"description": "What payment method was used for this payment",
"nullable": false
},