Patch a recurring charge (cancel)

​
Path Parameters
  • txid
    Type: string
    required
Body·
required
application/json
  • status
    Type: string enum
    values
    • CRIADA
    • ATIVA
    • CONCLUIDA
    • EXPIRADA
    • REJEITADA
    • CANCELADA
Responses
  • application/json
  • 400

    Requisição inválida

  • 403

    Acesso negado — credencial sem o escopo exigido pela operação ou certificado rejeitado. Respondido no gateway de exposição (Bacen: AcessoNegado)

  • 404

    Recurso não encontrado para esta conta

  • 503

    Serviço temporariamente indisponível (Bacen: ServicoIndisponivel)

Request Example for patch/api/cobr/{txid}
curl 'http://localhost:8080/api/cobr/{txid}' \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "status": "CRIADA"
}'

{
  "txid": "string",
  "idRec": "string",
  "calendario": {
    "criacao": "2026-09-16T19:14:18.843Z",
    "dataDeVencimento": "2026-09-16"
  },
  "valor": {
    "original": "string"
  },
  "ajusteDiaUtil": true,
  "recebedor": {
    "agencia": "string",
    "conta": "string",
    "tipoConta": "CORRENTE",
    "cnpj": "string",
    "nome": "string",
    "convenio": "string"
  },
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string",
    "email": "string",
    "logradouro": "string",
    "cidade": "string",
    "uf": "string",
    "cep": "string"
  },
  "infoAdicional": "string",
  "politicaRetentativa": "NAO_PERMITE",
  "status": "CRIADA",
  "encerramento": {
    "rejeicao": {
      "codigo": "string",
      "descricao": "string"
    },
    "cancelamento": {
      "solicitante": "PSP_PAGADOR",
      "codigo": "string",
      "descricao": "string"
    }
  },
  "tentativas": [
    {
      "endToEndId": "string",
      "tipo": "AGND",
      "status": "SOLICITADA",
      "dataLiquidacao": "2026-09-16",
      "rejeicao": {
        "codigo": "string",
        "descricao": "string"
      },
      "atualizacao": [
        {
          "status": "string",
          "statusAnterior": "string",
          "origem": "USER",
          "motivo": "string",
          "data": "2026-09-16T19:14:18.843Z"
        }
      ]
    }
  ],
  "atualizacao": [
    {
      "status": "string",
      "statusAnterior": "string",
      "origem": "USER",
      "motivo": "string",
      "data": "2026-09-16T19:14:18.843Z"
    }
  ]
}

Operação realizada com sucesso