> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List clearing positions > Lists the settlement institution's (IF Liquidante) clearing positions for the request tenant: the SLC0001 (clearing net-position notice) net position per participant by stage (PREVIEW/FINAL). This is the clearing PREVIEW/POSITION notice only — it carries NO deposit window or action. Filters: referenceDate (YYYY-MM-DD), cycle, stage. Offset/limit pagination WITHOUT a total count. RBAC: clearing:read; tenant is always derived from the validated request identity. ## OpenAPI ````yaml en/openapi/v3-current/slc.yaml get /v1/clearing/positions openapi: 3.1.0 info: description: >- API for Lerian SLC — the participant-side rail that connects the institution to Núclea's SLC deferred-net card settlement. It covers settlement-operation intake and lifecycle, clearing positions, the participant and arrangement registry, generated reports, embedded XSD schema introspection, transmission recovery and connectivity to Núclea, BYOK Model-A signing-key import, and tenant-scoped webhooks. title: Lerian SLC API version: 1.0.0 servers: - url: https://slc.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Settlement operation lifecycle — create, list, query, and control the NUliquid-tracked card operations (NUliquid = the 21-position id Núclea assigns each accepted operation) through the state machine. name: Operations - description: >- Participant catalog — the acquirers, sub-acquirers, IF Domicílio (bank where the merchant receives its sales), and settlement FIs (financial institutions) that take part in card settlement. name: Participants - description: >- Card arrangements (bandeira/scheme configurations, e.g. Visa/Master/Elo) attached to a participant. name: Arrangements - description: >- Regulated transport orchestration to Núclea/SILOC (the private card clearing house that operates the SILOC settlement system) — dispatch, recovery, retransmission, and connectivity testing over managed file-transfer, message-broker, and REST. name: Connectivity - description: >- Multilateral netting clearing positions — the net amount each participant settles per STR cycle (STR = Banco Central reserves-transfer system). name: Clearing - description: >- SaaS BYOK (Bring Your Own Key) signing-key provisioning — import parameters and register the client's ICP-Brasil A1 (Brazilian PKI server certificate, 1-year validity) certificate material used to sign ASLC files; the private key never leaves the client's HSM/KMS/Vault. name: SigningKey - description: >- ASLC file intake and status — passthrough submission and processing status of the official Núclea card-settlement XML files (ASLC = Arquivo do Sistema de Liquidação de Cartões). name: Files - description: >- Read-only introspection of the embedded Núclea ASLC/RSFN (National Financial System Network) XSD schemas used to validate outbound and inbound messages. name: XSD Schemas - description: Read-only regulatory, compliance, and operational settlement reports. name: Reports - description: >- Outbound business-event webhook subscriptions and delivery management for consumers (Midaz, client ledgers, Cabine — all optional). name: Webhooks - description: >- Administrative operations — hot-reloadable runtime configuration, dead-letter-queue inspection/replay, and outbox redispatch. name: Admin paths: /v1/clearing/positions: get: tags: - Clearing summary: List clearing positions description: >- Lists the settlement institution's (IF Liquidante) clearing positions for the request tenant: the SLC0001 (clearing net-position notice) net position per participant by stage (PREVIEW/FINAL). This is the clearing PREVIEW/POSITION notice only — it carries NO deposit window or action. Filters: referenceDate (YYYY-MM-DD), cycle, stage. Offset/limit pagination WITHOUT a total count. RBAC: clearing:read; tenant is always derived from the validated request identity. operationId: listClearingPositions parameters: - description: Filter by settlement date (YYYY-MM-DD). explode: false in: query name: referenceDate schema: description: Filter by settlement date (YYYY-MM-DD). examples: - '2026-06-15' type: string - description: Filter by settlement cycle. explode: false in: query name: cycle schema: description: Filter by settlement cycle. examples: - '07:50' type: string - description: Filter by clearing stage (PREVIEW or FINAL). explode: false in: query name: stage schema: description: Filter by clearing stage (PREVIEW or FINAL). examples: - FINAL type: string - description: >- Page size (default 50, max 500). A non-positive/non-numeric value is rejected with 400. explode: false in: query name: limit schema: description: >- Page size (default 50, max 500). A non-positive/non-numeric value is rejected with 400. examples: - '50' type: string - description: >- Row offset (default 0). A negative/non-numeric value is rejected with 400. explode: false in: query name: offset schema: description: >- Row offset (default 0). A negative/non-numeric value is rejected with 400. examples: - '0' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListClearingPositionsResponse' description: OK '501': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: >- Not Implemented: this capability is not part of this deployment. Operations are registered unconditionally so the published contract is identical across deploy shapes; when the capability behind one did not compose here (authentication disabled, no database, no outbound transport, or the feature switched off) it answers this coded SLC-0012 problem. It is definitive for this deployment: retrying does not help, and the `detail` is deliberately scrubbed (any status >= 500 is). default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: ListClearingPositionsResponse: additionalProperties: false properties: items: description: Clearing positions in this page. items: $ref: '#/components/schemas/ClearingPositionResponse' type: - array - 'null' pagination: $ref: '#/components/schemas/ClearingPaginationMeta' description: Pagination metadata for this page. required: - items - pagination type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object ClearingPositionResponse: additionalProperties: false properties: counterparties: description: Pre-netting bilateral counterparties of this position. items: $ref: '#/components/schemas/CounterpartyResponse' type: - array - 'null' currency: description: ISO-4217 currency code. examples: - BRL type: string cycle: description: Settlement cycle. examples: - '07:50' type: string participantIspb: description: Participant ISPB (8-digit identifier). examples: - '29011780' type: string positionCents: description: Net clearing position in centavos; negative means net debtor. examples: - 150000 format: int64 type: integer receivedAt: description: Timestamp the notice was stored (RFC3339 UTC); null until stored. examples: - '2026-06-15T07:50:00Z' type: - string - 'null' referenceDate: description: Settlement reference date (YYYY-MM-DD). examples: - '2026-06-15' type: string sourceMessageId: description: Id of the source SLC0001 message that produced this position. examples: - SLC0001-20260615-0001 type: string stage: description: Clearing stage (PREVIEW or FINAL). examples: - FINAL type: string required: - referenceDate - cycle - stage - participantIspb - positionCents - currency - receivedAt - counterparties type: object ClearingPaginationMeta: additionalProperties: false properties: hasNext: description: >- Whether another page likely exists (page-full heuristic; no total count). examples: - true type: boolean page: description: 1-based page number. examples: - 1 format: int64 type: integer perPage: description: Page size. examples: - 50 format: int64 type: integer required: - page - perPage - hasNext type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object CounterpartyResponse: additionalProperties: false properties: amountCents: description: >- Signed bilateral net amount in centavos toward this counterparty; positive means net creditor. examples: - 150000 format: int64 type: integer counterpartyIspb: description: Counterparty participant ISPB (8-digit identifier). examples: - '60746948' type: string direction: description: Direction relative to the participant (mirrors the amount sign). examples: - CREDIT type: string required: - counterpartyIspb - amountCents - direction type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````