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

> Cancela uma solicitacao de reivindicacao ativa.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml DELETE /v1/claims/{claimId}
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/claims/{claimId}:
    delete:
      tags:
        - API de Reivindicacoes de Chaves
      summary: Cancelar reivindicacao
      description: Cancela uma solicitacao de reivindicacao ativa.
      parameters:
        - $ref: '#/components/parameters/ClaimIdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelClaimRequest'
      responses:
        '200':
          description: Reivindicacao cancelada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimStatusResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ClaimIdPath:
      name: claimId
      in: path
      required: true
      description: Identificador da reivindicacao.
      schema:
        type: string
      example: '12345678901'
  schemas:
    CancelClaimRequest:
      type: object
      required:
        - key
        - accountId
      properties:
        key:
          type: string
          description: Chave PIX para cancelar a reivindicacao.
          example: '11122233344'
        accountId:
          type: string
          description: Identificador da conta do reivindicador.
          format: uuid
          example: 019c96a0-0c0c-7221-8cf3-13313fb60081
    ClaimStatusResponse:
      type: object
      required:
        - claimId
        - status
      properties:
        claimId:
          type: string
          description: Identificador unico da reivindicacao.
          example: claim_abc123xyz
        status:
          $ref: '#/components/schemas/ClaimStatusEnum'
    ClaimStatusEnum:
      type: string
      description: >
        Status da reivindicacao de propriedade de chave PIX. Valores string
        representando o estado de uma reivindicacao de portabilidade ou
        propriedade.


        **Valores validos:**

        - `OPEN` = Reivindicacao foi iniciada e aguarda acao das partes
        envolvidas

        - `CONFIRMED` = Reivindicacao foi confirmada pelo reivindicador

        - `COMPLETED` = Processo de reivindicacao concluido com sucesso, chave
        transferida

        - `CANCELLED` = Reivindicacao foi cancelada pelo reivindicador ou pelo
        sistema

        - `AWAITING_RESOLUTION` = Aguardando resolucao ou decisao do
        proprietario atual da chave
      enum:
        - OPEN
        - CONFIRMED
        - COMPLETED
        - CANCELLED
        - AWAITING_RESOLUTION
      example: OPEN
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Codigo do erro
        message:
          type: string
          description: Mensagem de erro
        details:
          type: array
          items:
            type: string
          description: Detalhes adicionais do erro
  responses:
    BadRequest:
      description: Requisicao Invalida - Parametros invalidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_key_type:
              summary: Invalid key type
              value:
                code: INVALID_KEY_TYPE
                message: Key type must be between 0 and 4
                details:
                  - 'keyType: must be one of [0, 1, 2, 3, 4]'
            missing_required_field:
              summary: Missing required field
              value:
                code: VALIDATION_ERROR
                message: Required field is missing
                details:
                  - 'accountId: field is required'
            invalid_document_format:
              summary: Invalid document format
              value:
                code: INVALID_DOCUMENT
                message: Document must be valid CPF (11 digits) or CNPJ (14 digits)
                details:
                  - 'document: must match pattern ^\d{11}$|^\d{14}$'
            invalid_phone_format:
              summary: Invalid phone format
              value:
                code: INVALID_PHONE
                message: Phone must be in Brazilian format
                details:
                  - 'phone: must match pattern ^\+55\d{2}\d{8,9}$'
    Unauthorized:
      description: Nao Autorizado - Autenticacao invalida ou ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing authentication token
              value:
                code: MISSING_TOKEN
                message: Authorization header is required
                details: []
            invalid_token:
              summary: Invalid token
              value:
                code: INVALID_TOKEN
                message: Invalid or expired access token
                details: []
            expired_token:
              summary: Expired token
              value:
                code: TOKEN_EXPIRED
                message: Access token has expired. Please obtain a new token.
                details: []
    InternalServerError:
      description: Erro Interno do Servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            generic_error:
              summary: Generic internal error
              value:
                code: INTERNAL_ERROR
                message: An internal error occurred. Please try again later.
                details: []
            database_error:
              summary: Database error
              value:
                code: DATABASE_ERROR
                message: Database operation failed
                details: []
            external_service_error:
              summary: External service error
              value:
                code: EXTERNAL_SERVICE_ERROR
                message: External service (JD PIX) is temporarily unavailable
                details: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````