⌘K

Listar Cobranças

Lista as cobranças recorrentes por período, com filtros por recorrência, devedor e status, além de paginação.

GET/cobr

Lista as cobranças recorrentes criadas dentro do período informado. Requer o scope cobr.read. Retorna 200 com os parâmetros da consulta e o array cobsr, em que cada item traz a cobrança completa, incluindo o array de tentativas.

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

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (scope cobr.read)

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`inicio`	string	Obrigatorio	Data/hora inicial do período de consulta (formato RFC 3339, ex: 2026-08-01T00:00:00Z)
`fim`	string	Obrigatorio	Data/hora final do período de consulta (formato RFC 3339, ex: 2026-08-31T23:59:59Z)
`idRec`	string	Opcional	Filtra pelas cobranças de uma recorrência específica
`cpf`	string	Opcional	Filtra pelo CPF do devedor. Não pode ser usado junto com cnpj
`cnpj`	string	Opcional	Filtra pelo CNPJ do devedor. Não pode ser usado junto com cpf
`status`	string	Opcional	Filtra pelo status da cobrança: CRIADA, ATIVA, CONCLUIDA, EXPIRADA, REJEITADA ou CANCELADA
`convenio`	string	Opcional	Filtra pelo identificador do convênio
`paginacao.paginaAtual`	integer	Opcional	Número da página atual (inicia em 0, valor padrão 0)
`paginacao.itensPorPagina`	integer	Opcional	Quantidade de itens por página (padrão 100, máximo 1000)

Exemplo de Response

{
  "parametros": {
    "inicio": "2026-08-01T00: 00:00Z",
    "fim": "2026-08-31T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "cobsr": [
    {
      "txid": "3136957d93134f2184b369e8f1c0729d",
      "idRec": "RR1234567820260801abcdefghijk",
      "status": "ATIVA",
      "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"
      },
      "atualizacao": [
        {
          "data": "2026-08-01T10: 30: 00.000Z",
          "status": "CRIADA"
        },
        {
          "data": "2026-08-05T08: 00: 00.000Z",
          "status": "ATIVA"
        }
      ],
      "tentativas": [
        {
          "dataLiquidacao": "2026-08-15",
          "tipo": "AGND",
          "status": "AGENDADA",
          "endToEndId": "E12345678202608151221abcdef12345",
          "atualizacao": [
            {
              "data": "2026-08-05T08: 00: 00.000Z",
              "status": "SOLICITADA"
            },
            {
              "data": "2026-08-05T08: 00: 05.000Z",
              "status": "AGENDADA"
            }
          ]
        }
      ]
    }
  ]
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/cobr?inicio=2026-08-01T00:00:00Z&fim=2026-08-31T23:59:59Z&idRec=RR1234567820260801abcdefghijk&status=ATIVA&paginacao.paginaAtual=0&paginacao.itensPorPagina=100" \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Os filtros cpf e cnpj são mutuamente exclusivos: informe apenas um dos dois na mesma consulta. Enviar ambos retorna erro 400.