{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stark Bank Balance Event API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Digital-Signature",
      "value": "{{Digital-Signature}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Event",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/event",
            "params": [
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Date filter for Events created only after a specific date. Example: \"2022-01-20\""
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Date filter for Events created only before a specific date. Example: \"2022-02-20\""
              },
              {
                "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": "isDelivered",
                "value": "",
                "type": "query",
                "description": "If false, only gets Events that haven't been delivered. If true, only gets Events that have already been delivered."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of Events to be retrieved. Max = 100."
              }
            ]
          },
          "docs": "Get a list of non-deleted events in chunks of at most 100. If you need smaller chunks, use the limit parameter."
        },
        {
          "info": {
            "name": "Get an Event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/event/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Unique id of the event entity."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              }
            ]
          },
          "docs": "Get a single Event by its id."
        },
        {
          "info": {
            "name": "Update an event",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.starkbank.com/v2/event/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the event entity. Example: \"5719405850615809\""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The only information you can update in an Event is the isDelivered property. This can be useful when, after experiencing server downtime on your side, you list all events with isDelivered=false, process them, and then set them as delivered to stabilize your operations."
        },
        {
          "info": {
            "name": "Delete an Event",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.starkbank.com/v2/event/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event entity to be canceled."
              }
            ]
          },
          "docs": "Delete a single Event from the event list.\nNote: This action cannot be undone.\n"
        }
      ]
    }
  ],
  "bundled": true
}