Listar Cobrancas

Lista as cobrancas Pix imediatas cadastradas, com suporte a paginacao e filtros por periodo, documento e status.

GET/cob

Retorna uma lista paginada de cobrancas Pix imediatas dentro do periodo informado. Permite filtrar por CPF, CNPJ e status da cobranca.

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

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2
`Content-Type`	application/json	Tipo do conteudo da requisicao

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`inicio`	string	Obrigatorio	Data/hora de inicio do periodo de consulta (formato RFC 3339, ex: 2025-01-01T00:00:00Z)
`fim`	string	Obrigatorio	Data/hora de fim do periodo de consulta (formato RFC 3339, ex: 2025-01-31T23:59:59Z)
`cpf`	string	Opcional	Filtrar por CPF do devedor
`cnpj`	string	Opcional	Filtrar por CNPJ do devedor
`status`	string	Opcional	Filtrar por status da cobranca (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP)
`paginacao.paginaAtual`	integer	Opcional	Pagina atual da consulta (default: 0)
`paginacao.itensPorPagina`	integer	Opcional	Quantidade de itens por pagina (1-1000, default: 100)

Exemplo de Response

{
  "parametros": {
    "inicio": "2025-01-01T00: 00:00Z",
    "fim": "2025-01-31T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 2
    }
  },
  "cobs": [
    {
      "calendario": {
        "criacao": "2025-01-15T10: 30: 00.000Z",
        "expiracao": 3600
      },
      "txid": "fc9a43e0b7e14b5a8c3d2f1e0a9b8c7d",
      "revisao": 0,
      "status": "CONCLUIDA",
      "valor": {
        "original": "150.00"
      },
      "chave": "sua-chave-pix@example.com",
      "devedor": {
        "cpf": "12345678909",
        "nome": "Fulano de Tal"
      },
      "solicitacaoPagador": "Pagamento do pedido #12345"
    },
    {
      "calendario": {
        "criacao": "2025-01-16T14: 00: 00.000Z",
        "expiracao": 3600
      },
      "txid": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
      "revisao": 0,
      "status": "ATIVA",
      "valor": {
        "original": "75.50"
      },
      "chave": "sua-chave-pix@example.com",
      "solicitacaoPagador": "Pagamento do pedido #12346"
    }
  ]
}

Exemplos de Codigo

curl -X GET "https://api.pix.basspago.com.br/cob?inicio=2025-01-01T00:00:00Z&fim=2025-01-31T23:59:59Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100" \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json"