Consultar lista de recorrências.

GET

/rec

Rec

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

rec.read-Permissão para consulta de recorrências

Parâmetros de Consulta

Respostas

🟢200

application/json

Bodyapplication/json

🟠403AcessoNegado

🔴503ServicoIndisponivel

Request Example

Shell

JavaScript

Java

Swift

curl --location '/rec?inicio=undefined&fim=undefined&cpf=undefined&cnpj=undefined&locationPresente=undefined&status=undefined&convenio=undefined&paginacao.paginaAtual=undefined&paginacao.itensPorPagina=undefined'

Response Example

200 - Exemplo de retorno da consulta de recorrências 1

{
    "parametros": {
        "inicio": "2024-04-01T00:00:00Z",
        "fim": "2024-04-01T23:59:59Z",
        "paginacao": {
            "paginaAtual": 0,
            "itensPorPagina": 100,
            "quantidadeDePaginas": 1,
            "quantidadeTotalDeItens": 1
        }
    },
    "recs": [
        {
            "idRec": "RN1234567820240115abcdefghijk",
            "status": "APROVADA",
            "politicaRetentativa": "NAO_PERMITE",
            "valor": {
                "valorRec": "300.00"
            },
            "calendario": {
                "dataFinal": "2028-09-01",
                "dataInicial": "2024-02-01",
                "periodicidade": "MENSAL"
            },
            "loc": {
                "criacao": "2023-12-19T12:28:05.230Z",
                "id": 5100,
                "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
                "idRec": "RN1234567820240115abcdefghijk"
            },
            "pagador": {
                "codMun": "2673833",
                "cpf": "75633122216",
                "ispbParticipante": "81102623"
            },
            "recebedor": {
                "cnpj": "92221288310574",
                "nome": "Imobiliária Bom Sucesso"
            },
            "vinculo": {
                "contrato": "98625023",
                "objeto": "Serviços de Gestão de Imóveis",
                "devedor": {
                    "cpf": "87734514122",
                    "nome": "Fulano de Tal"
                }
            },
            "atualizacao": [
                {
                    "data": "2024-01-03T08:30:02.050Z",
                    "nome": "CRIADA"
                },
                {
                    "data": "2024-01-04T09:40:42.210Z",
                    "nome": "APROVADA"
                }
            ]
        }
    ]
}

Página anterior

Gerenciamento de recorrências

Próxima página

Criar recorrência.