⌘K

Cancelar Cobrança

Cancela uma cobrança recorrente antes da liquidação. O cancelamento encerra a cobrança e cancela as tentativas de liquidação agendadas.

Não é possível cancelar a cobrança em data igual ou posterior à data prevista para a primeira tentativa de liquidação. O cancelamento deve ser solicitado antes dessa data.

PATCH/cobr/{txid}

Cancela uma cobrança recorrente. Requer o scope cobr.write. O único valor aceito no body é "CANCELADA". Retorna 200 com a cobrança cancelada, incluindo o bloco encerramento e as tentativas com status CANCELADA quando aplicável.

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Content-Type`	application/json	Tipo do conteúdo da requisição
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (scope cobr.write)

Parametros de Rota

Nome	Tipo	Descricao
`txid`	string	Identificador da transação (padrão [a-zA-Z0-9]{26,35})

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`status`	string	Obrigatorio	Único valor aceito: "CANCELADA"

Exemplo de Request

{
  "status": "CANCELADA"
}

Exemplo de Response

{
  "txid": "3136957d93134f2184b369e8f1c0729d",
  "idRec": "RR1234567820260801abcdefghijk",
  "status": "CANCELADA",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "criacao": "2026-08-01T10: 30: 00.000Z",
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "politicaRetentativa": "PERMITE_3R_7D",
  "ajusteDiaUtil": true,
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  },
  "encerramento": {
    "cancelamento": {
      "solicitante": "USUARIO_RECEBEDOR",
      "codigo": "SLCR",
      "descricao": "Cancelamento de agendamento solicitado pelo usuário recebedor"
    }
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 30: 00.000Z",
      "status": "CRIADA"
    },
    {
      "data": "2026-08-05T08: 00: 00.000Z",
      "status": "ATIVA"
    },
    {
      "data": "2026-08-10T14: 20: 00.000Z",
      "status": "CANCELADA"
    }
  ],
  "tentativas": [
    {
      "dataLiquidacao": "2026-08-15",
      "tipo": "AGND",
      "status": "CANCELADA",
      "endToEndId": "E12345678202608151221abcdef12345",
      "atualizacao": [
        {
          "data": "2026-08-05T08: 00: 00.000Z",
          "status": "SOLICITADA"
        },
        {
          "data": "2026-08-05T08: 00: 05.000Z",
          "status": "AGENDADA"
        },
        {
          "data": "2026-08-10T14: 20: 00.000Z",
          "status": "CANCELADA"
        }
      ]
    }
  ]
}

Exemplos de Codigo

curl -X PATCH https://api.pix.basspago.com.br/cobr/3136957d93134f2184b369e8f1c0729d \
  --cert ./client.crt \
  --key ./client.key \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "status": "CANCELADA"
  }'

Códigos de Cancelamento

O bloco encerramento.cancelamento informa quem solicitou o cancelamento e o código do motivo:

Código	Descrição
`ACCT`	Problema relacionado à conta (por exemplo, conta encerrada ou inválida)
`BLCK`	Conta ou recurso bloqueado
`CCLD`	Recorrência associada cancelada
`FAIL`	Falha no processamento da cobrança
`OTHR`	Outro motivo não classificado
`SLBD`	Cancelamento solicitado pelo usuário pagador (devedor)
`SLCR`	Cancelamento de agendamento solicitado pelo usuário recebedor