aljaz/btcpayserver
1
0
Fork 0
mirror of https://github.com/aljazceru/btcpayserver.git synced 2026-01-03 14:14:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix swagger docs for pull payments (#2105)

Browse Source 
* Fix swagger docs for pull payments

fixes #2097

* Update BTCPayServer/wwwroot/swagger/v1/swagger.template.pull-payments.json

Co-authored-by: Dennis Reimann <mail@dennisreimann.de>

Co-authored-by: Dennis Reimann <mail@dennisreimann.de>
This commit is contained in:
Andrew Camilleri
2020-12-04 12:03:27 +01:00
committed by GitHub
parent ba027de3f7
commit c7209df7e2
1 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -11,6 +11,7 @@
}
],
"get": {
"operationId": "PullPayments_GetPullPayments",
"summary": "Get store's pull payments",
"parameters": [
{
@@ -48,6 +49,7 @@
]
},
"post": {
"operationId": "PullPayments_CreatePullPayment",
"summary": "Create a new pull payment",
"description": "A pull payment allows its receiver to ask for payouts up to `amount` of `currency` every `period`.",
"requestBody": {
@@ -148,6 +150,8 @@
}
],
"get": {
"summary": "Get Pull Payment",
"operationId": "PullPayments_GetPullPayment",
"description": "Get a pull payment",
"responses": {
"200": {
@@ -186,6 +190,7 @@
}
],
"delete": {
"operationId": "PullPayments_ArchivePullPayment",
"summary": "Archive a pull payment",
"description": "Archive this pull payment (Will cancel all payouts awaiting for payment)",
"responses": {
@@ -218,6 +223,8 @@
}
],
"get": {
"summary": "Get Payouts",
"operationId": "PullPayments_GetPayouts",
"description": "Get payouts",
"parameters": [
{
@@ -250,7 +257,21 @@
"security": []
},
"post": {
"summary": "Create Payout",
"description": "Create a new payout",
"operationId": "PullPayments_CreatePayout",
"requestBody": {
"x-name": "request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePayoutRequest"
}
}
},
"required": true,
"x-position": 1
},
"responses": {
"200": {
"description": "A new payout has been created",
@@ -308,6 +329,9 @@
}
],
"post": {
"summary": "Approve Payout",
"operationId": "PullPayments_ApprovePayout",
"description": "Approve a payout",
"requestBody": {
"content": {
@@ -376,7 +400,9 @@
]
},
"delete": {
"summary": "Cancel Payout",
"description": "Cancel the payout",
"operationId": "PullPayments_CancelPayout",
"responses": {
"200": {
"description": "The payout has been cancelled"
@@ -411,6 +437,27 @@
"$ref": "#/components/schemas/PayoutData"
}
},
"CreatePayoutRequest": {
"type": "object",
"properties":{
"destination": {
"type": "string",
"example": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
"description": "The destination of the payout (can be an address or a BIP21 url)"
},
"amount": {
"type": "string",
"format": "decimal",
"example": "10399.18",
"description": "The amount of the payout in the currency of the pull payment (eg. USD)."
},
"paymentMethod": {
"type": "string",
"example": "BTC",
"description": "The payment method of the payout"
}
}
},
"PayoutData": {
"type": "object",
"properties": {