> ## 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 cautionary block audit records

> Returns the audit records of the manual interventions on one lock (`lock_id`) or on one group settlement (`refund_ref`), newest first. Send exactly one of the two. A record exists for every close and surplus return, for every release that moved funds out of the blocking account, and for every other release or settlement confirmation that carried an attribution header (`X-Actor-Id`, `X-Override-Reason` or `X-Override-Ticket`). Each record carries the actor declared in `X-Actor-Id` (Pix Lerian does not check it against the access token), the reason, the ticket and the request ID. An ID with no record returns an empty `entries` list, not `404`.



## OpenAPI

````yaml /pt/openapi/v3-current/pix-lerian-spi.yaml get /balance-locks/audit
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: Public API for outbound Pix transfers, refunds, and scheduled payments.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — Payments
  version: 1.2.0
servers:
  - url: https://api.example.com/spi/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Create, list, and retrieve Pix refunds.
    name: Refunds
  - name: Scheduled Payments
    description: Register, list, retrieve, and cancel scheduled Pix payments.
  - description: Initiate, process, list, and retrieve outbound Pix transfers.
    name: Transfers
  - description: >-
      Register, list, retrieve, and cancel recurring series of scheduled Pix
      payments.
    name: Scheduled Payment Recurrences
  - description: >-
      Hold the funds of a received Pix in a cautionary block (MED 2.0), return
      them to the payer, or give them back to the account holder.
    name: Balance Locks
paths:
  /balance-locks/audit:
    get:
      tags:
        - Balance Locks
      summary: List cautionary block audit records
      description: >-
        Returns the audit records of the manual interventions on one lock
        (`lock_id`) or on one group settlement (`refund_ref`), newest first.
        Send exactly one of the two. A record exists for every close and surplus
        return, for every release that moved funds out of the blocking account,
        and for every other release or settlement confirmation that carried an
        attribution header (`X-Actor-Id`, `X-Override-Reason` or
        `X-Override-Ticket`). Each record carries the actor declared in
        `X-Actor-Id` (Pix Lerian does not check it against the access token),
        the reason, the ticket and the request ID. An ID with no record returns
        an empty `entries` list, not `404`.
      operationId: listBalanceLockAudit
      parameters:
        - description: Per-block override lookup (mutually exclusive with refund_ref)
          explode: false
          in: query
          name: lock_id
          schema:
            description: Per-block override lookup (mutually exclusive with refund_ref)
            type: string
        - description: Group override lookup (mutually exclusive with lock_id)
          explode: false
          in: query
          name: refund_ref
          schema:
            description: Group override lookup (mutually exclusive with lock_id)
            type: string
      responses:
        '200':
          content:
            application/json:
              example:
                entries:
                  - id: 01a17e29-5544-7b96-8d2a-3f0e71c9a4b8
                    lock_id: 01a17cf3-128e-7c41-9b2e-5d7a3f8c1e60
                    action: CLOSE
                    actor: backoffice.ops@example.com
                    reason: manual devolution paid by Pix
                    ticket: MED-4821
                    request_id: 01a17e29-5302-7c0a-b5e1-94d2f6a83c17
                    correlation_id: med-2026-000123
                    created_at: '2026-10-27T16:20:00Z'
              schema:
                $ref: '#/components/schemas/ListBalanceLockAuditResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0003
                title: Bad Request
                status: 400
                detail: >-
                  Your request contains one or more fields with an invalid data
                  type.
                code: PIX-0003
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Neither or both of lock_id and refund_ref (PIX-0003), or a lock_id
            that is not a UUID (PIX-0020).
        '500':
          content:
            application/json:
              example:
                code: PIX-0000
                title: Internal Server Error
                message: >-
                  The server encountered an unexpected error. Please try again
                  later.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0000
                title: Internal Server Error
                status: 500
                detail: >-
                  The server could not complete the request. Please try again
                  later.
                code: PIX-0000
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unexpected server error (PIX-0000).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ListBalanceLockAuditResponse:
      additionalProperties: false
      properties:
        entries:
          items:
            $ref: '#/components/schemas/BalanceLockAuditEntryResponse'
          type:
            - array
            - 'null'
      required:
        - entries
      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
    LegacyErrorEnvelope:
      additionalProperties: false
      properties:
        code:
          description: PIX-XXXX error code
          type: string
        message:
          description: Human-readable error message
          type: string
        title:
          description: Short error title
          type: string
        fields:
          additionalProperties:
            type: string
          description: Per-field detail, keyed by the field or header the refusal names
          type: object
        headers:
          additionalProperties:
            type: string
          description: Per-header detail, keyed by the request header the refusal names
          type: object
      required:
        - code
        - title
        - message
      type: object
    BalanceLockAuditEntryResponse:
      additionalProperties: false
      properties:
        action:
          examples:
            - CLOSE
          type: string
        actor:
          examples:
            - backoffice.ops@example.com
          type: string
        correlation_id:
          type: string
        created_at:
          format: date-time
          type: string
        id:
          examples:
            - 01a17e29-5544-7b96-8d2a-3f0e71c9a4b8
          type: string
        lock_id:
          type: string
        reason:
          examples:
            - manual devolution paid by Pix
          type: string
        refund_ref:
          type: string
        request_id:
          type: string
        ticket:
          examples:
            - MED-4821
          type: string
      required:
        - id
        - action
        - actor
        - reason
        - request_id
        - created_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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.