{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stark Bank Balance Deposit API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Digital-Signature",
      "value": "{{Digital-Signature}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Deposit",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Deposits",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/deposit",
            "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": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order considered in the response. Options are: \"created\", \"-created\"."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter deposits by the specified status."
              },
              {
                "name": "tags",
                "value": "",
                "type": "query",
                "description": "Filter entities that contain the specified tags."
              }
            ]
          },
          "docs": "Here you can list and filter all deposits you have received. We return it paged."
        },
        {
          "info": {
            "name": "Get a Deposit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/deposit/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the deposit. Example: '5656565656565656'."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              }
            ]
          },
          "docs": "Get a single Deposit by its id."
        },
        {
          "info": {
            "name": "Update a Deposit",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.starkbank.com/v2/deposit/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the deposit. Example: '5155165527080960'."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the Deposit by passing its id to be partially or fully reversed."
        },
        {
          "info": {
            "name": "List Deposit Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/deposit/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": "depositIds",
                "value": "",
                "type": "query",
                "description": "Array of deposit ids that are linked to the logs you desire."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of strings to filter response JSON keys. Not available in the SDKs."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results per cursor. Max = 100."
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Filters logs by log types."
              }
            ]
          },
          "docs": "Get a paged list of all deposit logs. A log tracks a change in the deposit entity according to its life cycle."
        },
        {
          "info": {
            "name": "Get a Deposit Log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/deposit/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 deposit log by its id."
        },
        {
          "info": {
            "name": "Get a reversed Deposit Log PDF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.starkbank.com/v2/deposit/log/:id/pdf",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the log Deposit entity."
              }
            ]
          },
          "docs": "Whenever a Deposit is successfully reversed, a reversed log will be created. To retrieve a specific reversal receipt, you can request the corresponding log PDF."
        }
      ]
    }
  ],
  "bundled": true
}