# List check settlement operations

Retrieve a paginated list of settlement operations for a specific check.

**NOTES**:
- Requires an account token (access token encoded with a Pismo account ID). Tokens may expire quickly, resulting in a `401 Unauthorized` response.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Banking - Transaction banking",
    "version": "0.9.0",
    "description": "Transaction banking API",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "Sandbox API server for testing"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Check posting",
      "description": "Check posting endpoints"
    }
  ],
  "components": {
    "parameters": {
      "CheckIDPath": {
        "name": "checkId",
        "in": "path",
        "description": "Check ID",
        "schema": {
          "type": "string"
        },
        "required": true,
        "example": "c462b2f3-55cc-42b4-ae9a-7614df3e8e72"
      }
    },
    "schemas": {
      "ErrorCode": {
        "description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 12,
        "example": "WPMT0017"
      },
      "ErrorMessage": {
        "description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
        "type": "string",
        "minLength": 1,
        "maxLength": 1000,
        "example": "Invalid JSON payload received: Error unmarshalling request"
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "message": {
            "$ref": "#/components/schemas/ErrorMessage"
          }
        }
      },
      "GetSettlementOperationsResponse": {
        "type": "object",
        "description": "Paginated list of settlement operations for a check.",
        "properties": {
          "operations": {
            "type": "array",
            "description": "List of check settlement operations",
            "items": {
              "$ref": "#/components/schemas/CheckSettlementOperation"
            }
          },
          "limit": {
            "type": "integer",
            "format": "int32",
            "description": "Maximum number of items returned."
          },
          "offset": {
            "type": "integer",
            "format": "int32",
            "description": "Offset of the first item in the result set"
          },
          "has_next": {
            "type": "boolean",
            "description": "Indicates whether there are more items available after this page."
          }
        },
        "required": [
          "operations",
          "limit",
          "offset",
          "has_next"
        ]
      },
      "CheckSettlementOperation": {
        "type": "object",
        "description": "Check settlement details",
        "properties": {
          "amount": {
            "type": "number",
            "format": "float",
            "description": "Check settlement amount"
          },
          "business_date": {
            "type": "string",
            "format": "date",
            "description": "Check settlement business date (yyyy-mm-dd)"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp indicating when the operation was created (RFC3339)"
          },
          "settlement_id": {
            "type": "string",
            "description": "Check settlement ID"
          },
          "tracking_id": {
            "type": "string",
            "description": "ID used to track check settlement operation"
          },
          "type": {
            "type": "string",
            "description": "Settlement operation type"
          }
        },
        "required": [
          "settlement_id",
          "tracking_id",
          "type",
          "amount",
          "business_date",
          "created_at"
        ]
      }
    },
    "responses": {
      "401Unauthorized": {
        "description": "Access token is missing or invalid"
      },
      "403Forbidden": {
        "description": "The request has been lost"
      },
      "500InternalServer": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Generic internal error": {
                "value": {
                  "code": "ECMN9999",
                  "message": "Internal error"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "paths": {
    "/corporate/v1/checks/{checkId}/settlement-operations": {
      "get": {
        "summary": "List check settlement operations",
        "description": "Retrieve a paginated list of settlement operations for a specific check.\n\n**NOTES**:\n- Requires an account token (access token encoded with a Pismo account ID). Tokens may expire quickly, resulting in a `401 Unauthorized` response.",
        "operationId": "corporate-get-v1-check-settlement-operations",
        "tags": [
          "Check posting"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/CheckIDPath"
          },
          {
            "name": "settlementId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Filter by settlement ID."
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 100
            },
            "description": "Maximum number of items to return."
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            },
            "description": "Number of items to skip before starting to collect the result set."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with a list of settlement operations.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetSettlementOperationsResponse"
                },
                "example": {
                  "operations": [
                    {
                      "settlement_id": "abc123",
                      "tracking_id": "track-001",
                      "amount": 1000,
                      "type": "BEGINNING",
                      "business_date": "2025-01-05",
                      "created_at": "2025-01-05T10:00:00Z"
                    }
                  ],
                  "limit": 10,
                  "offset": 0,
                  "has_next": false
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "code": "WCPT0002",
                  "message": "Invalid request parameters"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "description": "Check posting not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "code": "WCPT0003",
                  "message": "Check posting not found"
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/500InternalServer"
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  }
}
```