> ## 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 câmara bilateral settlement balances

> The bilateral settlement balances the PAG câmara stated (PAG0200 — saldos bilaterais para liquidação de movimento de Prestador de Serviços de Compensação e de Liquidação), keyset-paged newest announced first. Every amount is the wire string the câmara sent: the stated multilateral amount, the stated payment and receipt totals, and the per-counterparty legs behind each. Read-only, and nothing here is computed — Lerian SILOC holds no position, nets no balance and does not reconcile the câmara's totals against its own legs. Acting on a statement is the client's ledger's business.



## OpenAPI

````yaml /pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/bilateral-balances
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 surface for Lerian SILOC, the participant-side rail connecting
    the institution to Núclea's SILOC deferred-net interbank settlement.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: https://siloc.sandbox.lerian.net
security: []
paths:
  /api/v1/siloc/bilateral-balances:
    get:
      tags:
        - Bilateral
      summary: List câmara bilateral settlement balances
      description: >-
        The bilateral settlement balances the PAG câmara stated (PAG0200 —
        saldos bilaterais para liquidação de movimento de Prestador de Serviços
        de Compensação e de Liquidação), keyset-paged newest announced first.
        Every amount is the wire string the câmara sent: the stated multilateral
        amount, the stated payment and receipt totals, and the per-counterparty
        legs behind each. Read-only, and nothing here is computed — Lerian SILOC
        holds no position, nets no balance and does not reconcile the câmara's
        totals against its own legs. Acting on a statement is the client's
        ledger's business.
      operationId: listBilateralBalances
      parameters:
        - description: Opaque pagination cursor.
          explode: false
          in: query
          name: cursor
          schema:
            description: Opaque pagination cursor.
            type: string
        - description: Page size (default 50, max 200).
          explode: false
          in: query
          name: limit
          schema:
            default: 50
            description: Page size (default 50, max 200).
            format: int64
            maximum: 200
            minimum: 1
            type: integer
        - description: >-
            Narrow the feed to one settlement day (DtMovto), YYYY-MM-DD. An
            unparsable value is refused, never silently dropped: answering a
            question about one day with every day is not an answer.
          explode: false
          in: query
          name: movementDate
          schema:
            description: >-
              Narrow the feed to one settlement day (DtMovto), YYYY-MM-DD. An
              unparsable value is refused, never silently dropped: answering a
              question about one day with every day is not an answer.
            format: date
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceListResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    BalanceListResponse:
      additionalProperties: false
      properties:
        hasMore:
          description: Whether more statements exist beyond this page.
          type: boolean
        items:
          description: The page of statements (never null; empty when none).
          items:
            $ref: '#/components/schemas/BalanceResponse'
          type: array
        nextCursor:
          description: Opaque cursor for the next page; omitted when the feed is exhausted.
          type: string
      required:
        - items
        - hasMore
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    BalanceResponse:
      additionalProperties: false
      properties:
        announcedAt:
          description: The câmara's OWN announced instant (DtHrPAG), verbatim.
          format: date-time
          type: string
        codIdentdTransf:
          description: >-
            Free transfer-identification field. RSTR0027 leaves both its
            existence and its content to be agreed between the câmara and this
            institution, so it is surfaced exactly as sent and interpreted by
            nobody here.
          type: string
        codMsg:
          description: >-
            Always PAG0200 — câmara informa saldos bilaterais para liquidação de
            movimento de Prestador de Serviços.
          type: string
        id:
          description: Statement id.
          format: uuid
          type: string
        ispbIF:
          description: This institution's ISPB, as the câmara addressed it.
          pattern: ^[0-9A-Z]{8}$
          type: string
        movementDate:
          description: Movement date (DtMovto), YYYY-MM-DD.
          format: date
          type: string
        multilateralAmount:
          description: >-
            Valor Multilateral Banco — the câmara's stated net amount for this
            institution, verbatim.
          type: string
        numCtrlPAG:
          description: The câmara's own control number for this statement.
          type: string
        nuop:
          description: >-
            BCMSG unique operation number of the frame this row was projected
            from.
          type: string
        paymentLegs:
          description: >-
            The credited counterparties and their amounts, in the order the
            câmara sent them (never null; empty when the statement carried
            none).
          items:
            $ref: '#/components/schemas/LegResponse'
          type: array
        receiptLegs:
          description: >-
            The debited counterparties and their amounts, in the order the
            câmara sent them (never null; empty when the statement carried
            none).
          items:
            $ref: '#/components/schemas/LegResponse'
          type: array
        receivedAt:
          description: When this rail stored the statement.
          format: date-time
          type: string
        side:
          description: >-
            Tipo Débito ou Crédito — which side the multilateral amount falls
            on, as sent.
          type: string
        totalPaid:
          description: >-
            Valor Total Pagamento Banco, exactly as the câmara stated it. NOT
            derived from paymentLegs.
          type: string
        totalReceived:
          description: >-
            Valor Total Recebimento Banco, exactly as the câmara stated it. NOT
            derived from receiptLegs.
          type: string
      required:
        - id
        - codMsg
        - numCtrlPAG
        - ispbIF
        - codIdentdTransf
        - multilateralAmount
        - side
        - totalPaid
        - totalReceived
        - paymentLegs
        - receiptLegs
        - announcedAt
        - movementDate
        - nuop
        - receivedAt
      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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
    LegResponse:
      additionalProperties: false
      properties:
        amount:
          description: >-
            The amount the câmara attributed to this counterparty, as the wire
            string it sent (never parsed into a number).
          type: string
        ispb:
          description: >-
            The counterparty institution's ISPB: credited on a payment leg,
            debited on a receipt leg.
          pattern: ^[0-9A-Z]{8}$
          type: string
      required:
        - ispb
        - amount
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````