{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stark Bank Balance Tax Payment API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Digital-Signature",
      "value": "{{Digital-Signature}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Tax Payment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Tax Payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/tax-payment",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Filter entities created after this date."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Filter entities created before this date."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "String used to get the next batch of results. Our SDKs handle this for you."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "List of strings to get specific entities by ids."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results per cursor. Max = 100."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter tax payments by the specified status."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "Filter entities that contain the specified tags."
              }
            ]
          },
          "docs": "Get a list of non-deleted tax payments in chunks of at most 100. If you need smaller chunks, use the limit parameter."
        },
        {
          "info": {
            "name": "Create Tax Payments",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.starkbank.com/v2/tax-payment",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this route to pay taxes using the available balance in your Stark Bank account."
        },
        {
          "info": {
            "name": "Get a Tax Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/tax-payment/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the tax payment entity."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              }
            ]
          },
          "docs": "Get a single tax payment by its id."
        },
        {
          "info": {
            "name": "Delete a Tax Payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.starkbank.com/v2/tax-payment/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the tax payment entity."
              }
            ]
          },
          "docs": "Cancel a scheduled tax payment. You can only cancel tax payments before they start being processed.\nNOTE:Payments that have already been processed can be deleted, but not cancelled.\n"
        },
        {
          "info": {
            "name": "Get a Tax Payment PDF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/tax-payment/:id/pdf",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the tax payment entity"
              }
            ]
          },
          "docs": "Get a tax payment PDF receipt. You can only get a receipt for payments whose status are either success, processing or created."
        },
        {
          "info": {
            "name": "List Tax Payment Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/tax-payment/log",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Filter entities created after this date."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Filter entities created before this date."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "String used to get the next batch of results. Our SDKs handle this for you."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results per cursor. Max = 100."
              },
              {
                "name": "paymentIds",
                "value": "",
                "type": "query",
                "description": "Array of payment ids linked to the desired logs."
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Filters logs by log types."
              }
            ]
          },
          "docs": "Get a paged list of all tax payment logs. A log tracks a change in the payment entity according to its life cycle."
        },
        {
          "info": {
            "name": "Get a Tax Payment Log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/tax-payment/log/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the log entity"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              }
            ]
          },
          "docs": "Get a single tax payment log by its id."
        }
      ]
    }
  ],
  "bundled": true
}