List Locations (Bacen GET /loc)

​

Lists locations created within the [inicio, fim] date-time range, optionally filtered by tipoCob, with pagination. Bacen API Pix v2.9.0: GET /loc

Query Parameters
  • inicio
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • fim
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • tipoCob
    Type: string enum

    Type of charge bound to the location (Bacen tipoCob)

    values
    • cob
    • cobv
  • txIdPresente
    Type: boolean
  • paginacao.paginaAtual
    Type: integer Format: int32

    Página corrente (0-based)

  • paginacao.itensPorPagina
    Type: integer Format: int32

    Itens por página

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/loc
curl 'http://localhost:8080/api/loc?inicio=&fim=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "parametros": {
    "inicio": "2026-09-16T19:14:18.674Z",
    "fim": "2026-09-16T19:14:18.674Z",
    "tipoCob": "cob",
    "txIdPresente": true,
    "paginacao": {
      "paginaAtual": 1,
      "itensPorPagina": 1,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "loc": [
    {
      "id": "string",
      "location": "string",
      "tipoCob": "cob",
      "status": "ACTIVE",
      "txid": "string",
      "criacao": "2026-09-16T19:14:18.674Z"
    }
  ]
}

Locations retrieved successfully