> ## 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.

# Cancelar recuperação de fundos DICT

> Transiciona uma recuperação de fundos para →CANCELLED (antes de REFUNDING) e reporta a cancelação ao BACEN.



## OpenAPI

````yaml pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/{id}/cancel
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Interface OpenAPI 3.1 da capacidade DICT (Diretório de Identificadores de
    Contas Transacionais) do Lerian SPI, a integração direta entre a instituição
    e o Sistema de Pagamentos Instantâneos Brasileiro (SPI/Pix). Abrange o ciclo
    de vida das chaves PIX, as reivindicações de portabilidade e titularidade,
    os relatos de infração, as devoluções, os marcadores de fraude, os
    relatórios DICT síncronos e as operações internas de conciliação e
    provisionamento que mantêm o diretório de chaves consistente.
  license:
    name: Lerian Studio General License
  title: Lerian SPI — DICT API
  version: 1.0.0
servers:
  - url: https://spi.sandbox.lerian.net
security: []
tags:
  - description: >-
      Ciclo de vida das chaves PIX: registro, listagem, busca, consulta,
      exclusão e estatísticas.
    name: Keys
  - description: >-
      Reivindicações de portabilidade e titularidade de chaves PIX ao longo de
      todo o seu ciclo de vida (iniciar, confirmar, rejeitar, cancelar,
      reconhecer, concluir).
    name: Claims
  - description: 'Relatos de infração DICT: criar, listar e recuperar.'
    name: Infractions
  - description: 'Solicitações de devolução DICT: criar, listar e recuperar.'
    name: Refunds
  - description: 'Marcadores de fraude PIX: criar, listar e estatísticas.'
    name: Fraud Markers
  - description: >-
      Relatórios síncronos sobre o próprio registro DICT do Lerian SPI: resumos
      COUNT(*) de chaves (por tipo/status) e reivindicações (por tipo/status +
      em aberto após o prazo). Somente COUNT — o DICT não retém dinheiro.
    name: Reports
  - description: >-
      Operações internas do DICT: execuções de conciliação, provisionamento do
      ISPB do participante, processamento de prazos de reivindicações e limpeza
      de chaves órfãs.
    name: Internal
paths:
  /api/v1/dict/funds-recoveries/{id}/cancel:
    post:
      tags:
        - Funds Recoveries
      summary: Cancelar recuperação de fundos DICT
      description: >-
        Transiciona uma recuperação de fundos para →CANCELLED (antes de
        REFUNDING) e reporta a cancelação ao BACEN.
      operationId: cancelFundsRecovery
      parameters:
        - description: Funds recovery UUID (local record id)
          in: path
          name: id
          required: true
          schema:
            description: Funds recovery UUID (local record id)
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelFundsRecoveryRequest'
              description: cancelFundsRecovery body (reporting participant)
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FundsRecoveryResponse'
                description: Persisted local DICT funds-recovery record
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CancelFundsRecoveryRequest:
      additionalProperties: false
      properties:
        participantISPB:
          description: >-
            ISPB (8 numeric digits) of the participant cancelling the funds
            recovery; gated to the calling direct's scope
          examples:
            - '12345678'
          type: string
      required:
        - participantISPB
      type: object
    FundsRecoveryResponse:
      additionalProperties: false
      properties:
        createdAt:
          description: Record creation timestamp (RFC 3339, UTC)
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        id:
          description: Server-assigned local funds-recovery record UUID
          examples:
            - 550e8400-e29b-41d4-a716-446655440003
          type: string
        reportStatus:
          description: >-
            BACEN report delivery state: PENDING, SENT, or FAILED (FAILED is
            retryable; the local record stands)
          examples:
            - SENT
          type: string
        rootTransactionId:
          description: >-
            BACEN end-to-end identifier (E2E ID) of the originating fraudulent
            transaction
          examples:
            - E1234567820260614ABCDEFGHIJKLMNO
          type: string
        situationType:
          description: MED 2.0 situation classification
          examples:
            - SCAM
          type: string
        status:
          description: >-
            Local funds-recovery lifecycle state: CREATED, AWAITING_ANALYSIS,
            ANALYSED, REFUNDING, COMPLETED, or CANCELLED
          examples:
            - CREATED
          type: string
        updatedAt:
          description: Last update timestamp (RFC 3339, UTC)
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
      required:
        - id
        - rootTransactionId
        - situationType
        - status
        - reportStatus
        - createdAt
        - updatedAt
      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
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````