Patch Dynamic Immediate Charge (COB-2)

Partially updates an ACTIVE COB: expiration, payer request, 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 lowercase alphanumeric characters [a-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

    Unique idempotency key

Body·
required
application/json

Partial update for a dynamic immediate charge (COB)

  • emitImage
    Type: boolean

    If true, includes base64 PNG in the response

  • expiracao
    Type: integer Format: int32
    min:  
    1

    New expiration time in seconds from creation (no max limit as per Bacen API Pix v2.9.0)

  • infoAdicionais
    Type: array object[] · …50

    Replaces the full additional information list when sent

    Additional information for the payer

  • solicitacaoPagador
    Type: string
    max length:  
    140

    Optional message/request from the payer

  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
    • REMOVED_BY_RECEIVER
    • REMOVIDO_PELO_USUARIO_RECEBEDOR
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/cob/{txid}
curl http://localhost/cob/txid12345678901234567890123456 \
  --request PATCH \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "ATIVA",
  "expiracao": 1,
  "solicitacaoPagador": "",
  "infoAdicionais": [
    {
      "nome": "",
      "valor": ""
    }
  ],
  "emitImage": true
}'
{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "calendario": {
    "criacao": "2026-07-31T17:52:48.786Z",
    "expiracao": 1
  },
  "valor": {
    "original": "string",
    "modalidadeAlteracao": 1
  },
  "chave": "string",
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "loc": {
    "id": "string",
    "url": "string"
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-07-31T17:52:48.786Z"
}