---
title: "Consultar locations cadastradas."
method: GET
path: "/loc"
tags: ["PayloadLocation"]
---

# Consultar locations cadastradas.

`GET /loc`

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.
- `txIdPresente` boolean
- `tipoCob` 'cob' | 'cobv'
- `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.

- PayloadLocationConsultadas
  - `parametros` ParametrosConsultaPayloadLocation, 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.
    - `txIdPresente` boolean — Filtro pela existência de txid.
    - `tipoCob` 'cob' | 'cobv'
    - `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` PayloadLocationCompleta[], required
    - `id` integer, required — Identificador da location a ser informada na criação da cobrança .
    - `txid` string — # Identificador da transação O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos. Na pacs.008, é referenciado como `TransactionIdentification <txId>` ou `idConciliacaoRecebedor`. Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.
    - `location` string, uri, required — Localização do Payload a ser informada na criação da cobrança.
    - `tipoCob` 'cob' | 'cobv', required
    - `criacao` string, date-time, required — Data e hora em que a location foi criada. Respeita RFC 3339.

## 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

- **2021-02-10** `3872a6881bfb` — 1 breaking
  - the `loc/items/allOf[subschema #1: Location do Payload Completa]/id` response's property format changed from `int32` to `int64` for status `200`
- **2020-12-03** `1ab8ae73a0ae` — 3 info
  - added the non-success response with the status `403`
  - added the non-success response with the status `503`
  - added the optional property `parametros/tipoCob` to the response with the `200` status
- **2020-11-06** `f4a2162d6068` — 2 info
  - added the new optional `query` request parameter `tipoCob`
  - added the required property `loc/items/allOf[subschema #1: Location do Payload Completa]/tipoCob` to the response with the `200` status
- **2020-10-21** `f669c19a8e32` — 2 info
  - added `#/components/schemas/PayloadLocationCompleta` to the `loc/items/` response property `allOf` list for the response status `200`
  - removed `#/components/schemas/PayloadLocation` from the `loc/items/` response property `allOf` list for the response status `200`
- **2020-10-20** `60591eda9f58` — 2 breaking
  - for the `query` request parameter `txIdPresente`, the type changed from `string` to `boolean`, and format from `boolean` to no format
  - the `parametros/txIdPresente` response's property type changed from `string` to `boolean`, and format from `boolean` to no format for status `200`

[Full history](https://skmtc.dev/bacen/apis/api-pix/changes/loc/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/e60160879b89/schema)