> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 6 - Cancelar Proposta

<Warning>***Não é possível realizar a chamada do endpoint de cancelamento com 7 dias do desembolso da proposta ou se ela se encontrar com o status de cedida (ID = 10).***</Warning>

Por meio desta endpoint o parceiro cancela uma operação de FGTS.
Regras:

* A operação não pode ultrapassar o prazo de 7 dias do momento do desembolso
* Caso ocorra desembolso da operação, será necessária a devolução do valor para nós.

## Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

<Expandable title="Mensagens de requisições com erro">
  O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

  | Código | Mensagem Técnica                                                                       | Mensagem ao Usuário                                                                    | Tipo de Erro      |
  | ------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----------------- |
  | 400    | 4. Número de CPF inválido                                                              | O número do CPF informado é inválido                                                   | Erro de validação |
  | 400    | 5. Existe uma Operação Fiduciária em andamento. Tente mais tarde                       | Existe uma Operação Fiduciária em andamento. Tente mais tarde                          | Erro de negócio   |
  | 400    | 10. Operação não permitida antes de determinada data                                   | A operação não é permitida antes de determinada data                                   | Erro de negócio   |
  | 400    | 13. Operação não permitida por pendência no processo de pagamento de saque-aniversário | A operação não é permitida por pendência no processo de pagamento de saque-aniversário | Erro de negócio   |
  | 400    | 27. Operação já cancelada                                                              | A operação já foi cancelada                                                            | Erro de negócio   |
  | 400    | 28. Cancelamento não permitido                                                         | O cancelamento não é permitido                                                         | Erro de negócio   |
  | 400    | 38. Identificador da Solicitação inválido                                              | O identificador da solicitação é inválido                                              | Erro de negócio   |
</Expandable>


## OpenAPI

````yaml post /FGTS/CancelarProposta
openapi: 3.0.1
info:
  title: BMPDigitalCore.ApiExterna.FGTS.API
  version: '1.0'
servers:
  - url: https://api.bmpdigital.moneyp.dev.br
security:
  - Bearer: []
paths:
  /FGTS/CancelarProposta:
    post:
      tags:
        - FGTS
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelarPropostaCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/CancelarPropostaCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CancelarPropostaCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CancelarPropostaResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CancelarPropostaResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CancelarPropostaResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
components:
  schemas:
    CancelarPropostaCommand:
      type: object
      properties:
        dto:
          $ref: '#/components/schemas/FGTSSaqAnivCancelarPropostaDTO'
      additionalProperties: false
    CancelarPropostaResponse:
      type: object
      properties:
        Msg:
          type: string
          nullable: true
        Result:
          type: boolean
          writeOnly: true
        HasError:
          type: boolean
        Messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
        Boleto:
          type: string
          format: uuid
          nullable: true
      additionalProperties: false
    ResponseBase:
      type: object
      properties:
        Msg:
          type: string
          nullable: true
        Result:
          type: boolean
          writeOnly: true
        HasError:
          type: boolean
        Messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          nullable: true
      additionalProperties: false
    FGTSSaqAnivCancelarPropostaDTO:
      required:
        - CodigoProposta
      type: object
      properties:
        CodigoOperacao:
          type: string
          description: Código operação
          nullable: true
        CodigoProposta:
          type: string
          description: Código da proposta
          format: uuid
          nullable: true
        TextoMotivoCancelamento:
          type: string
          description: Motivo do cancelamento
          nullable: true
      additionalProperties: false
    Message:
      type: object
      properties:
        MessageType:
          $ref: '#/components/schemas/ErrorType'
        Code:
          type: string
          nullable: true
        Context:
          type: string
          nullable: true
        Description:
          type: string
          nullable: true
        Field:
          type: string
          nullable: true
      additionalProperties: false
    ErrorType:
      enum:
        - 1
        - 2
        - 3
      type: integer
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Informe o token
      name: Authorization
      in: header

````