v1

latestOpenAPI 3.0.0Apache 2.02026-07-1751129352.2 KB
PayloadLocationRec

Consultar locations cadastradas.

Endpoint para consultar locations cadastradas

get/locrec

Query parameters

iniciostring date-time required

Filtra os registros cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339.

fimstring date-time required

Filtra os registros cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339.

idRecPresenteboolean
conveniostring

Filtro pelo convênio associado.

paginacao.paginaAtualinteger

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0.

paginacao.itensPorPaginainteger

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros.

Response

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

Example response

{
  "parametros": {
    "inicio": "2020-01-01T00:00:00Z",
    "fim": "2020-12-01T17:00:00Z"
  },
  "loc": [
    {
      "location": "pix.example.com/qr/v2/rec/2353c790eefb11eaadc10242ac120002",
      "idRec": "RR1234567820240115abcdefghijk"
    }
  ]
}