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

# Cancelar Cobranças de Parcela

Este endpoint oferece a possibilidade de cancelar cobranças que foram previamente registradas.

Ele garante que as cobranças associadas as parcelas possam ser canceladas e reemitidas, permitindo um controle mais preciso sobre o fluxo de pagamentos.

O processo de cancelamento é assíncrono, ou seja, a operação é realizada em segundo plano, e um callback é disparado para o parceiro assim que o cancelamento do registro da cobrança é concluído, informando que o cancelamento foi realizado com sucesso.

Esse endpoint oferece flexibilidade no gerenciamento de cobranças, permitindo que o parceiro cancele registros de forma simples e mantenha um controle adequado de suas operações financeiras.

<Warning>Utilize o valor gerado pelo campo `codigoLiquidacao`, retornado na resposta do endpoint [Gerar uma Cobrança de Parcela](https://bmpdocs.moneyp.com.br/fgts/api-reference/liquidacao-antecipada/gerar-cobranca), para cancelar uma negociação de cobrança.</Warning>


## OpenAPI

````yaml post /FGTS/CancelarCobrancas
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/CancelarCobrancas:
    post:
      tags:
        - FGTS
      parameters:
        - name: IdempotencyKey
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgendaCancelarCobrancasCommand'
          text/json:
            schema:
              $ref: '#/components/schemas/AgendaCancelarCobrancasCommand'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AgendaCancelarCobrancasCommand'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
            text/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '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:
    AgendaCancelarCobrancasCommand:
      type: object
      properties:
        Dto:
          $ref: '#/components/schemas/AgendaCancelarCobrancasDTO'
      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
    AgendaCancelarCobrancasDTO:
      required:
        - CodigoLiquidacao
      type: object
      properties:
        CodigoProposta:
          type: string
          description: Código identificador da proposta FGTS na BMP. Obrigatório.
          format: uuid
        CodigoLiquidacao:
          type: string
          description: Código Liquidacao da Agenda.
          format: uuid
      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

````