v1

latestOpenAPI 3.0.0Apache 2.02026-07-1751129352.2 KB
LoteCobV

Consultar lotes de cobranças com vencimento.

Endpoint para consultar lista de lotes de cobranças com vencimento.

get/lotecobv

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.

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

Lotes de cobranças com vencimento.

Example response

{
  "parametros": {
    "inicio": "2020-04-01T00:00:00Z",
    "fim": "2020-04-01T17:00:00Z"
  },
  "lotes": [
    {
      "cobsv": [
        {
          "problema": {
            "type": "https://pix.bcb.gov.br/api/v2/error/NaoEncontrado",
            "title": "Not found",
            "status": 404,
            "violacoes": [
              {
                "razao": "Valor da cobrança não pode ser 0.00",
                "propriedade": "cob.chave",
                "valor": "061996671234"
              }
            ]
          }
        }
      ]
    }
  ]
}