---
title: "Consultar locations cadastradas."
method: GET
path: "/locrec"
tags: ["PayloadLocationRec"]
---

# Consultar locations cadastradas.

`GET /locrec`

Endpoint para consultar locations cadastradas

## Query parameters

- `inicio` string, date-time, required — Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.
- `fim` string, date-time, required — Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.
- `idRecPresente` boolean
- `convenio` string — Filtro pelo convênio associado.
- `paginacao.paginaAtual` integer — Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.
- `paginacao.itensPorPagina` integer — Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

## Response `200`

lista dos locations cadastrados de acordo com o critério de busca.

- PayloadLocationRecConsultadas
  - `parametros` ParametrosConsultaPayloadLocationRec, required — Parâmetros utilizados para a realização de uma consulta de locations.
    - `inicio` string, date-time, required — Data inicial utilizada na consulta. Respeita RFC 3339.
    - `fim` string, date-time, required — Data de fim utilizada na consulta. Respeita RFC 3339.
    - `idRecPresente` boolean — Filtro pela existência de id da recorrência.
    - `recebedor` object
      - `convenio` string — Convênio entre usuário e participante recebedor.
    - `paginacao` Paginacao, required
      - `paginaAtual` integer, required — Número da página recuperada.
      - `itensPorPagina` integer, required — Quantidade de registros retornado na página.
      - `quantidadeDePaginas` integer, required — Quantidade de páginas disponíveis para consulta.
      - `quantidadeTotalDeItens` integer, required — Quantidade total de itens disponíveis de acordo com os parâmetros informados.
  - `loc` PayloadLocationRecCompleta[], required
    - `id` integer, required — Identificador da location a ser informada na criação de uma recorrência .
    - `location` string, uri, required — Localização do Payload a ser informada na criação da recorrência.
    - `criacao` string, date-time, required — Data e hora em que a location foi criada. Respeita RFC 3339.
    - `idRec` string — # Identificador da Recorrência Regra de formação: - RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: - "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; - "A": identificação da possibilidade de novas tentativas, sendo possíveis os valores "R" ou "N" (1 caractere). "R" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou "N" caso não permita novas tentativas. - "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o ID Recorrência, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros caracteres do CNPJ do prestador de serviço de iniciação (8 caracteres alfanuméricos [A-Z|0-9]); - "yyyyMMdd": data (8 caracteres) de criação da recorrência; - "kkkkkkkkkkk": sequencial criado pelo agente que gerou o ID Recorrência (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: - "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou - "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.”

## Other responses

- `403` — Requisição de participante autenticado que viola alguma regra de autorização.
- `503` — Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.

## Changes

> 35 revisions in range; 28 could not be searched.

- **2020-06-29** `5967a4b6f934` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/bacen/apis/api-pix/changes/locrec/get.md)

---

[API](https://skmtc.dev/bacen/apis/api-pix.md) · [All operations](https://skmtc.dev/bacen/apis/api-pix/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bacen/api-pix/revisions/5c39d7116745/schema)