⌘K

Listar Recorrências

Lista as recorrências de Pix Automático criadas em um intervalo de datas, com filtros opcionais e paginação.

Os parâmetros cpf e cnpj são mutuamente exclusivos. Se ambos forem enviados na mesma requisição, a API retorna erro 400.

GET/rec

Lista recorrências filtradas pelo período de criação. Requer o escopo rec.read.

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 (escopo rec.read)

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`inicio`	string (RFC 3339)	Obrigatorio	Data inicial do filtro (ex: 2026-07-01T00:00:00Z)
`fim`	string (RFC 3339)	Obrigatorio	Data final do filtro (ex: 2026-07-31T23:59:59Z)
`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
`locationPresente`	boolean	Opcional	Filtra recorrências que possuem (ou não) location vinculada
`status`	string	Opcional	Filtra pelo status da recorrência (CRIADA, APROVADA, REJEITADA, EXPIRADA, CANCELADA)
`convenio`	string	Opcional	Filtra pelo identificador de convênio do recebedor (até 60 caracteres)
`paginacao.paginaAtual`	integer	Opcional	Página atual da listagem (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-07-01T00: 00:00Z",
    "fim": "2026-07-31T23: 59:59Z",
    "paginacao": {
      "paginaAtual": 0,
      "itensPorPagina": 100,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "recs": [
    {
      "idRec": "RN1234567820260801abcdefghijk",
      "status": "APROVADA",
      "vinculo": {
        "contrato": "63100862",
        "devedor": {
          "cpf": "45164632481",
          "nome": "Fulano de Tal"
        },
        "objeto": "Serviço de streaming de música"
      },
      "calendario": {
        "dataInicial": "2026-08-01",
        "dataFinal": "2027-08-01",
        "periodicidade": "MENSAL"
      },
      "valor": {
        "valorRec": "35.00"
      },
      "politicaRetentativa": "NAO_PERMITE",
      "recebedor": {
        "cnpj": "01602606000113",
        "nome": "Empresa de Serviços SA"
      },
      "atualizacao": [
        {
          "data": "2026-07-19T10: 30: 00.000Z",
          "nome": "CRIADA"
        },
        {
          "data": "2026-07-19T11: 05: 00.000Z",
          "nome": "APROVADA"
        }
      ]
    }
  ]
}

Exemplos de Codigo

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