{
  "opencollection": "1.0.0",
  "info": {
    "name": "BTCPay Greenfield API Keys Pull payments (Management) API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Pull payments (Management)",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get store's pull payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{btcpay-host}/api/v1/stores/:storeId/pull-payments",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The store ID"
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query",
                "description": "Whether this should list archived pull payments"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get the pull payments of a store"
        },
        {
          "info": {
            "name": "Create a new pull payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{btcpay-host}/api/v1/stores/:storeId/pull-payments",
            "params": [
              {
                "name": "storeId",
                "value": "",
                "type": "path",
                "description": "The store ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "A pull payment allows its receiver to ask for payouts up to `amount` of `currency` every `period`."
        },
        {
          "info": {
            "name": "Archive a pull payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{btcpay-host}/api/v1/pull-payments/:pullPaymentId",
            "params": [
              {
                "name": "pullPaymentId",
                "value": "",
                "type": "path",
                "description": "The ID of the pull payment"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Archive this pull payment (Will cancel all payouts awaiting for payment). The store is resolved automatically from the pull payment."
        }
      ]
    }
  ],
  "bundled": true
}