mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2025-02-23 14:40:36 +01:00
148 lines
8.3 KiB
JSON
148 lines
8.3 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "BTCPay Greenfield API",
|
|
"version": "v1",
|
|
"description": "A full API to use your BTCPay Server",
|
|
"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"
|
|
]
|
|
},
|
|
"CheckoutType": {
|
|
"type": "string",
|
|
"description": "`\"V1\"`: The original checkout form \n`\"V2\"`: The new experimental checkout form",
|
|
"nullable": true,
|
|
"default": "V2",
|
|
"x-enumNames": [
|
|
"V1",
|
|
"V2"
|
|
],
|
|
"enum": [
|
|
"V1",
|
|
"V2"
|
|
]
|
|
},
|
|
"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 are a combination of crypto code and payment type. Available payment method IDs for Bitcoin are: \n- `\"BTC-OnChain\"` (with the equivalent of `\"BTC\"`) \n-`\"BTC-LightningLike\"`: Any supported LN-based payment method (Lightning or LNURL) \n- `\"BTC-LightningNetwork\"`: Lightning \n- `\"BTC-LNURLPAY\"`: LNURL \n \nNote: Separator can be either `-` or `_`."
|
|
}
|
|
},
|
|
"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.canviewcustodianaccounts`: View exchange accounts linked to your stores\n* `btcpay.store.canmanagecustodianaccounts`: Manage exchange accounts linked to your stores\n* `btcpay.store.candeposittocustodianaccount`: Deposit funds to exchange accounts linked to your stores\n* `btcpay.store.canwithdrawfromcustodianaccount`: Withdraw funds from exchange accounts to your store\n* `btcpay.store.cantradecustodianaccount`: Trade funds on your store's exchange accounts\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": []
|
|
}
|
|
]
|
|
}
|