Patch Dynamic Immediate Charge (COB-2)

Revises an ACTIVE COB with a CobRevisada body: calendario.expiracao, devedor, valor.original, valor.modalidadeAlteracao, solicitacaoPagador and infoAdicionais. An omitted field is left unchanged; devedor and infoAdicionais are replaced whole, not merged item by item. chave, loc and valor.retirada 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 lowercase alphanumeric characters [a-z0-9]

Body·

required

application/json

Revisão de uma cobrança imediata (CobRevisada)

calendario
Type: object ·

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

Debtor information (payer)
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 da revisão da cobrança imediata

Responses

application/json

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0021`	400	Charge is not in a valid status for this operation	`CobOperacaoInvalida`
`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
application/json

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0018`	404	Charge not found	`CobNaoEncontrado`

Código interno	HTTP	Descrição	Erro normativo Bacen
`CHARGE-0016`	409	Charge is not active and cannot be modified. The txid is no longer available for new charges	`CobOperacaoInvalida`

application/json

application/json

patch/api/cob/{txid}

curl http://localhost:8080/api/cob/txid12345678901234567890123456 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "REMOVIDA_PELO_USUARIO_RECEBEDOR",
  "calendario": {
    "expiracao": 1
  },
  "devedor": {
    "cpf": "",
    "cnpj": "",
    "nome": ""
  },
  "valor": {
    "original": "",
    "modalidadeAlteracao": 0
  },
  "solicitacaoPagador": "",
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "emitImage": true
}'

Show Schema

{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "calendario": {
    "criacao": "2026-09-16T19:14:18.661Z",
    "expiracao": 1
  },
  "valor": {
    "original": "string",
    "modalidadeAlteracao": 1,
    "retirada": {
      "saque": {
        "valor": "string",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "string"
      },
      "troco": {
        "valor": "string",
        "modalidadeAlteracao": 0,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "string"
      }
    }
  },
  "chave": "string",
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "loc": {
    "id": "string",
    "location": "string",
    "tipoCob": "cob",
    "criacao": "2026-09-16T19:14:18.661Z"
  },
  "location": "string",
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "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.661Z",
      "infoPagador": "string",
      "devolucoes": [
        {
          "id": "devolucao001",
          "rtrId": "D1234567820260713123456789012345",
          "valor": "10.0",
          "natureza": "ORIGINAL",
          "descricao": "string",
          "horario": {
            "solicitacao": "2026-09-16T19:14:18.661Z",
            "liquidacao": "2026-09-16T19:14:18.661Z"
          },
          "status": "EM_PROCESSAMENTO",
          "motivo": "string"
        }
      ]
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-09-16T19:14:18.661Z"
}

Charge updated successfully