Patch dynamic charge with due date (COBV)

Revises an ACTIVE COBV with a CobVRevisada body: calendario.dataDeVencimento, calendario.validadeAposVencimento, devedor, valor.original, valor.multa, valor.juros, valor.desconto, valor.abatimento, solicitacaoPagador and infoAdicionais. An omitted field is left unchanged; devedor, each charge rule and infoAdicionais are replaced whole, not merged item by item. chave and loc are immutable once the charge is issued. Send only status = REMOVIDA_PELO_USUARIO_RECEBEDOR with no other fields to cancel; cancelled charges cannot be paid.

Path Parameters

txid
Type: string
required

Transaction identifier (txid). Must be 26-35 alphanumeric characters [a-zA-Z0-9]

Body·

required

application/json

Revisão de uma cobrança com vencimento (CobVRevisada)

calendario
Type: object ·

Calendário da revisão da cobrança com vencimento
devedor
Type: object ·

Debtor (payer) information
emitImage
Type: boolean

Se true, devolve o PNG do QR Code em base64 (extensão Finaya)
infoAdicionais
Type: array object[] · …50

Substitui a lista de informações adicionais por inteiro quando enviada

Additional information for the payer
solicitacaoPagador
Type: string
max length:
140

Texto a ser apresentado ao pagador
status
enum
const:
REMOVIDA_PELO_USUARIO_RECEBEDOR

Status of a dynamic charge
values
- REMOVIDA_PELO_USUARIO_RECEBEDOR
valor
Type: object ·

Valor e encargos da revisão da cobrança com vencimento

Responses

application/json

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0006`	400	Failed to generate QR image	—
`CHARGE-0007`	400	QR payload must not be blank	—
`CHARGE-0008`	400	Amount must be greater than or equal to 0	`CobOperacaoInvalida`
`CHARGE-0015`	400	Cannot modify immutable field	`CobOperacaoInvalida`
`CHARGE-0021`	400	Charge is not in a valid status for this operation	`CobOperacaoInvalida`
`CHARGE-0025`	400	Due date must be greater than or equal to charge creation date	`CobVOperacaoInvalida`
`CHARGE-0026`	400	Discount date must be less than or equal to due date	`CobVOperacaoInvalida`
`CHARGE-0027`	400	Invalid value rule: mode requires a value greater than 0.00	`CobVOperacaoInvalida`
`CHARGE-0028`	400	Invalid configuration: mode NONE should not have associated data	`CobVOperacaoInvalida`
`CHARGE-0030`	400	Fixed date discounts are required when mode is FIXED_DATE (max 3 entries)	`CobVOperacaoInvalida`
`CHARGE-0031`	400	PATCH body must contain at least one field to apply	`CobVOperacaoInvalida`
`PIX-0001`	400	Headers x-branch and x-account-number are required	`PixConsultaInvalida`

application/json

application/json

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0001`	404	Invalid Pix key: key not found or inactive	`CobOperacaoInvalida`
`CHARGE-0018`	404	Charge not found	`CobNaoEncontrado`
`LOCATION-0001`	404	Location not found	`PayloadLocationNaoEncontrado`

application/json

application/json
application/json

Código interno	HTTP	Descrição	Erro normativo Bacen
`LOCATION-0003`	410	Location is already deleted.	`PermanentementeRemovido`

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0005`	502	Error validating Pix key	`ServicoIndisponivel`

patch/api/cobv/{txid}

curl http://localhost:8080/api/cobv/txid12345678901234567890123456 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
  "calendario": {
    "dataDeVencimento": "",
    "validadeAposVencimento": 1
  },
  "devedor": {
    "cpf": "",
    "cnpj": "",
    "nome": "",
    "email": "",
    "logradouro": "",
    "cidade": "",
    "uf": "",
    "cep": ""
  },
  "valor": {
    "original": "",
    "multa": {
      "modalidade": 1,
      "valorPerc": ""
    },
    "juros": {
      "modalidade": 1,
      "valorPerc": ""
    },
    "desconto": {
      "modalidade": 1,
      "descontoDataFixa": [
        {
          "data": "",
          "valorPerc": ""
        }
      ],
      "valorPerc": ""
    },
    "abatimento": {
      "modalidade": 1,
      "valorPerc": ""
    }
  },
  "solicitacaoPagador": "",
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "emitImage": true
}'

Show Schema

{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "chave": "string",
  "calendario": {
    "criacao": "2026-09-16T19:14:18.660Z",
    "dataDeVencimento": "2026-09-16",
    "validadeAposVencimento": 1
  },
  "valor": {
    "original": "string",
    "multa": {
      "modalidade": 1,
      "valorPerc": "string"
    },
    "juros": {
      "modalidade": 1,
      "valorPerc": "string"
    },
    "abatimento": {
      "modalidade": 1,
      "valorPerc": "string"
    },
    "desconto": {
      "modalidade": 1,
      "descontoDataFixa": [
        {
          "data": "2026-09-16",
          "valorPerc": "string"
        }
      ],
      "valorPerc": "string"
    }
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string",
    "email": "string",
    "logradouro": "string",
    "cidade": "string",
    "uf": "string",
    "cep": "string"
  },
  "recebedor": {
    "nome": "string",
    "cidade": "string",
    "taxId": "string",
    "logradouro": "string",
    "uf": "string",
    "cep": "string"
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "loc": {
    "id": "string",
    "location": "string",
    "tipoCob": "cob",
    "criacao": "2026-09-16T19:14:18.660Z"
  },
  "location": "string",
  "pix": [
    {
      "endToEndId": "E1234567820260713123456789012345",
      "txid": "string",
      "valor": "100.0",
      "componentesValor": {
        "original": {
          "valor": "100.0"
        },
        "saque": {
          "valor": "20.0",
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "string"
        },
        "troco": {
          "valor": "20.0",
          "modalidadeAgente": "AGTEC",
          "prestadorDoServicoDeSaque": "string"
        },
        "juros": {
          "valor": "100.0"
        },
        "multa": {
          "valor": "100.0"
        },
        "abatimento": {
          "valor": "100.0"
        },
        "desconto": {
          "valor": "100.0"
        }
      },
      "chave": "string",
      "horario": "2026-09-16T19:14:18.660Z",
      "infoPagador": "string",
      "devolucoes": [
        {
          "id": "devolucao001",
          "rtrId": "D1234567820260713123456789012345",
          "valor": "10.0",
          "natureza": "ORIGINAL",
          "descricao": "string",
          "horario": {
            "solicitacao": "2026-09-16T19:14:18.660Z",
            "liquidacao": "2026-09-16T19:14:18.660Z"
          },
          "status": "EM_PROCESSAMENTO",
          "motivo": "string"
        }
      ]
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-09-16T19:14:18.660Z"
}

Charge with due date updated successfully