> ## 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 the credits ceded to one fund the caller administers

> Returns the credits a fund you administer actually OWNS.

Ownership is keyed on the cessão registration and on nothing else: a credit merely ATTRIBUTED to the fund (allocated to it, but with no cessão registered) is INVISIBLE here, exactly as it is on the fund's own route.

This operation is for the BANCARIZADOR, which administers many funds and carries none on its credential, so it names the fund it means. The fence is the tenant plus that fund: the tenant is derived from the validated identity and is never read from the request, and the path id must resolve to a fund registered under THAT tenant. An id belonging to another tenant answers 404, identically to one that never existed. The reference the credit query runs on is the resolved fund row's own, so nothing else in the request narrows or widens it.

A fund reading its own credits uses GET /v1/consignado/fundo/creditos instead, where the fund comes from the credential and there is no fund parameter at all.



## OpenAPI

````yaml /en/openapi/v3-current/consignado.yaml get /v1/consignado/fundos/{id}/creditos
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant
    credentials and rail configuration, worker margin, loan auctions and bids,
    contract registration and lifecycle, disbursement confirmation, portability,
    refinancing, renegotiation, FGTS guarantees, reconciliation, funds,
    assignments, usage, throughput, and event subscriptions. Secret material is
    written to the tenant secret store and is never returned by any operation.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://br-consignado-gw.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Per-tenant Dataprev credential custody and public rail configuration
      (upload, status, rotation, revoke, requester code, and worker portal base
      URL)
    name: Credentials
  - description: >-
      Tenant-scoped consignado gateway usage: priced billable-unit aggregation
      per competência
    name: Consignado Usage
  - description: >-
      Per-tenant streaming-hub subscription control-plane (list, create, get,
      rotate, revoke, and test delivery)
    name: Subscriptions
  - description: >-
      Dataprev payroll-rail surface: FGTS balance and authorization reads, the
      FGTS guarantee execution, contract suspension, reactivation and term
      changes, the rail's own contract documents, and the on-demand reads of
      leilão solicitações, escriturações, repasses and employment terminations
    name: Consignado Rail
  - description: >-
      Synchronous rail command surface: the operations a bancarizador without
      the lender drives over HTTP. Each shares its command implementation with
      the equivalent lender event trigger.
    name: Consignado Rail Commands
  - description: >-
      Gateway-owned disbursement confirmation: a client bank recording money it
      has ALREADY paid to a worker. It crosses no government boundary and
      proxies no Dataprev operation.
    name: Consignado Disbursement
  - description: >-
      Per-tenant self-service outbound Dataprev rail throughput: read and set
      this tenant's own requests-per-second, including a deliberate pause at
      zero
    name: Consignado Throughput
paths:
  /v1/consignado/fundos/{id}/creditos:
    get:
      tags:
        - Consignado Fundo Créditos
      summary: List the credits ceded to one fund the caller administers
      description: >-
        Returns the credits a fund you administer actually OWNS.


        Ownership is keyed on the cessão registration and on nothing else: a
        credit merely ATTRIBUTED to the fund (allocated to it, but with no
        cessão registered) is INVISIBLE here, exactly as it is on the fund's own
        route.


        This operation is for the BANCARIZADOR, which administers many funds and
        carries none on its credential, so it names the fund it means. The fence
        is the tenant plus that fund: the tenant is derived from the validated
        identity and is never read from the request, and the path id must
        resolve to a fund registered under THAT tenant. An id belonging to
        another tenant answers 404, identically to one that never existed. The
        reference the credit query runs on is the resolved fund row's own, so
        nothing else in the request narrows or widens it.


        A fund reading its own credits uses GET /v1/consignado/fundo/creditos
        instead, where the fund comes from the credential and there is no fund
        parameter at all.
      operationId: listConsignadoFundoCreditosCedidosAsBancarizador
      parameters:
        - description: >-
            The fund's internal id, as returned in the id field of GET
            /v1/consignado/fundos. It must name a fund registered under the
            caller's own tenant; anything else answers 404.
          in: path
          name: id
          required: true
          schema:
            description: >-
              The fund's internal id, as returned in the id field of GET
              /v1/consignado/fundos. It must name a fund registered under the
              caller's own tenant; anything else answers 404.
            format: uuid
            type: string
        - description: >-
            Narrows the read to ONE credit the caller already names: the same
            idempotency_key the bid was submitted under. Omit for the whole
            page. It never widens the fund fence.
          explode: false
          in: query
          name: credit_key
          schema:
            description: >-
              Narrows the read to ONE credit the caller already names: the same
              idempotency_key the bid was submitted under. Omit for the whole
              page. It never widens the fund fence.
            maxLength: 128
            type: string
        - description: >-
            Maximum number of credits to return. Omitted means the ceiling of
            500; a value outside 1..500 is refused with a validation error.
          explode: false
          in: query
          name: limit
          schema:
            description: >-
              Maximum number of credits to return. Omitted means the ceiling of
              500; a value outside 1..500 is refused with a validation error.
            format: int64
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCededCreditsResponse'
          description: OK
          headers:
            Cache-Control:
              schema:
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    ListCededCreditsResponse:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/CededCredit'
          type: array
      required:
        - items
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-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
        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
    CededCredit:
      additionalProperties: false
      properties:
        cedido_at:
          description: When the cessão was durably registered, in UTC.
          format: date-time
          type: string
        credit_key:
          description: >-
            The credit's own business key — the same idempotency_key the bid was
            submitted and had its cessão registered under.
          type: string
        fundo_ref:
          description: >-
            The fund this credit was ceded to, byte for byte. Always the fund
            this read was fenced on: the credential's fund on the fund's own
            route, the fund resolved from the path against the caller's tenant
            on the bancarizador's route.
          type: string
        id_solicitacao:
          description: >-
            The rail's pre-auction solicitação this credit came from. Empty when
            the credit's bid carried none.
          type: string
      required:
        - credit_key
        - id_solicitacao
        - fundo_ref
        - cedido_at
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````