> ## Documentation Index
> Fetch the complete documentation index at: https://docs-finance.superpagamentos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar transações

> Liste suas cobranças Pix por período, com filtros e paginação.

<Info>
  Essa rota utiliza os certificados e o Bearer Token de **Cash In**.
</Info>

## Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de **Cash In**, a chave e a senha na requisição:

<ParamField path="--cert" type="file" required>
  Certificado de Cash In do cliente (`client.crt`).
</ParamField>

<ParamField path="--key" type="file" required>
  Chave privada do cliente (`client.key`).
</ParamField>

<ParamField path="--pass" type="string" required>
  Senha para descriptografar a chave `.key`, enviada por e-mail junto com os certificados.
</ParamField>

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer Token de Cash In. Formato: `Bearer {access_token}`.
</ParamField>

## Query

<ParamField query="inicio" type="string" required>
  Início do período consultado, no formato RFC 3339. Exemplo: `2026-07-01T00:00:00Z`.
</ParamField>

<ParamField query="fim" type="string" required>
  Fim do período consultado, no formato RFC 3339. Exemplo: `2026-07-31T23:59:59Z`.
</ParamField>

<ParamField query="cpf" type="string">
  Filtra as cobranças pelo CPF do devedor.
</ParamField>

<ParamField query="cnpj" type="string">
  Filtra as cobranças pelo CNPJ do devedor.
</ParamField>

<ParamField query="status" type="string">
  Filtra pelo status da cobrança: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_USUARIO_RECEBEDOR` ou `REMOVIDA_PELO_PSP`.
</ParamField>

<ParamField query="paginacao.paginaAtual" type="integer">
  Página que você quer consultar. Padrão: `0`.
</ParamField>

<ParamField query="paginacao.itensPorPagina" type="integer">
  Itens por página, de `1` a `1000`. Padrão: `100`.
</ParamField>

## Resposta

<ResponseField name="parametros" type="object">
  Parâmetros aplicados na consulta, incluindo período e dados de paginação.

  <Expandable title="parametros">
    <ResponseField name="inicio" type="string">
      Início do período consultado.
    </ResponseField>

    <ResponseField name="fim" type="string">
      Fim do período consultado.
    </ResponseField>

    <ResponseField name="paginacao" type="object">
      Dados de paginação: `paginaAtual`, `itensPorPagina`, `quantidadeDePaginas` e `quantidadeTotalDeItens`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="cobs" type="array">
  Lista de cobranças encontradas no período. Cada item traz `txid`, `status`, `valor`, `chave`, `devedor`, `calendario` e `solicitacaoPagador`.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://api.pix.basspago.com.br/cob?inicio=2026-07-01T00:00:00Z&fim=2026-07-31T23:59:59Z" \
    --cert ./client.crt \
    --key ./client.key \
    --pass "SUA_SENHA_DO_CERTIFICADO" \
    -H "Authorization: Bearer {access_token}"
  ```

  ```php PHP theme={null}
  <?php

  $query = http_build_query([
      'inicio' => '2026-07-01T00:00:00Z',
      'fim' => '2026-07-31T23:59:59Z',
  ]);

  $ch = curl_init("https://api.pix.basspago.com.br/cob?{$query}");

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_SSLCERT => './client.crt',
      CURLOPT_SSLKEY => './client.key',
      CURLOPT_KEYPASSWD => 'SUA_SENHA_DO_CERTIFICADO',
      CURLOPT_HTTPHEADER => ['Authorization: Bearer {access_token}'],
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ```

  ```javascript Node.js theme={null}
  import fs from "node:fs";
  import https from "node:https";
  import axios from "axios";

  const agent = new https.Agent({
    cert: fs.readFileSync("./client.crt"),
    key: fs.readFileSync("./client.key"),
    passphrase: "SUA_SENHA_DO_CERTIFICADO",
  });

  const { data } = await axios.get("https://api.pix.basspago.com.br/cob", {
    httpsAgent: agent,
    headers: { Authorization: "Bearer {access_token}" },
    params: {
      inicio: "2026-07-01T00:00:00Z",
      fim: "2026-07-31T23:59:59Z",
    },
  });

  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - OK theme={null}
  {
    "parametros": {
      "inicio": "2026-07-01T00:00:00Z",
      "fim": "2026-07-31T23:59:59Z",
      "paginacao": {
        "paginaAtual": 0,
        "itensPorPagina": 100,
        "quantidadeDePaginas": 1,
        "quantidadeTotalDeItens": 2
      }
    },
    "cobs": [
      {
        "calendario": {
          "criacao": "2026-07-15T10:30:00.000Z",
          "expiracao": 3600
        },
        "txid": "a1b2c3d4e5f60718293a4b5c6d7e8f90",
        "revisao": 0,
        "status": "CONCLUIDA",
        "valor": {
          "original": "150.00"
        },
        "chave": "e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4",
        "devedor": {
          "cpf": "11144477735",
          "nome": "Maria Oliveira"
        },
        "solicitacaoPagador": "Pagamento do pedido #90210"
      },
      {
        "calendario": {
          "criacao": "2026-07-16T14:00:00.000Z",
          "expiracao": 3600
        },
        "txid": "b2c3d4e5f60718293a4b5c6d7e8f9012",
        "revisao": 0,
        "status": "ATIVA",
        "valor": {
          "original": "75.50"
        },
        "chave": "e3b0c442-98fc-4c1a-b2d6-9a7f5e10c3d4",
        "devedor": {
          "cpf": "22255588896",
          "nome": "João Pereira"
        },
        "solicitacaoPagador": "Pagamento do pedido #90211"
      }
    ]
  }
  ```
</ResponseExample>