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

    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

    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
    • cob
    • cobv
  • pagination
    Type: object ·
    required

    Pagination and sorting parameters

    • page
      Type: integer Format: int32

      Page number (zero-based)

    • size
      Type: integer Format: int32
      max:  
      500

      Number of items per page (max: 500)

    • sort
      Type: array string[]

      Sort criteria in the format 'field,direction' (e.g., 'createdAt,desc')

Headers
  • x-branch
    Type: string
    required

    Branch of the location owner account

  • x-account-number
    Type: string
    required

    Number of the location owner account

  • Idempotency-Key
    Type: string
    required

    Unique idempotency key

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/loc
curl 'http://localhost/loc?page=0&size=50&sort=' \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "parametros": {
    "inicio": "2026-07-31T12:59:10.330Z",
    "fim": "2026-07-31T12:59:10.330Z",
    "tipoCob": "cob",
    "paginacao": {
      "paginaAtual": 1,
      "itensPorPagina": 1,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "loc": [
    {
      "id": "string",
      "location": "string",
      "tipoCob": "cob",
      "status": "ACTIVE",
      "txid": "string",
      "criacao": "2026-07-31T12:59:10.330Z"
    }
  ]
}

Locations retrieved successfully