Patch dynamic charge with due date (COBV)

​

Partially updates an ACTIVE COBV: amount, due date, validity after due date, abatement, discount, interest, fine, and additional info. Send only status = REMOVED_BY_RECEIVER (Bacen: REMOVIDO_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]

Headers
  • x-branch
    Type: string
    required

    Branch of the charge owner account

  • x-account-number
    Type: string
    required

    Number of the charge owner account

  • Idempotency-Key
    Type: string
    required
Body·
required
application/json

Partial update for a dynamic charge with due date (COBV)

  • abatement
    Type: object ·

    Abatement configuration for charge with due date

  • additionalInfo
    Type: array object[] · …50

    Replaces the full additional information list when sent

    Additional information for the payer

  • discount
    Type: object ·

    Discount configuration for charge with due date

  • dueDate
    Type: string Format: date

    New due date (YYYY-MM-DD)

  • emitImage
    Type: boolean

    If true, includes base64 PNG in the response

  • fine
    Type: object ·

    Fine configuration for charge with due date

  • interest
    Type: object ·

    Interest configuration for charge with due date

  • original
    Type: string Pattern: ^\d+\.\d{2}$

    New original amount (replaces stored value)

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVED_BY_RECEIVER
  • validAfterDueDays
    Type: integer Format: int32

    Days the charge remains valid after the due date

Responses
  • application/json
Request Example for patch/cobv/{txid}
curl http://localhost/cobv/txid12345678901234567890123456 \
  --request PATCH \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "ATIVA",
  "original": "",
  "dueDate": "",
  "validAfterDueDays": 1,
  "abatement": {
    "modalidade": "1",
    "valorPerc": ""
  },
  "discount": {
    "modalidade": "1",
    "descontoDataFixa": [
      {
        "data": "",
        "valorPerc": ""
      }
    ],
    "valorPerc": ""
  },
  "interest": {
    "modalidade": "1",
    "valorPerc": ""
  },
  "fine": {
    "modalidade": "1",
    "valorPerc": ""
  },
  "additionalInfo": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "emitImage": true
}'

{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "chave": "string",
  "calendario": {
    "criacao": "2026-07-31T12:59:10.316Z",
    "dataDeVencimento": "2026-07-31",
    "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-07-31",
          "valorPerc": "string"
        }
      ],
      "valorPerc": "string"
    }
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "recebedor": {
    "nome": "string",
    "cidade": "string",
    "taxId": "string",
    "endereco": {
      "logradouro": "string",
      "cidade": "string",
      "uf": "string",
      "cep": "string"
    }
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "loc": {
    "id": "string",
    "url": "string"
  },
  "pix": [
    {
      "endToEndId": "string",
      "txid": "string",
      "valor": "string",
      "horario": "2026-07-31T12:59:10.316Z",
      "infoPagador": "string"
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-07-31T12:59:10.316Z"
}

OK