Listar Pagamentos

Acesso exclusivo para o usuário com o perfil proprietário.

Para buscar os pagamentos recebidos pela loja, é enviado uma requisição do tipo POST para o endpoint {{ BASE_API_URL }}/v1/pagamentos/pagination passando no corpo da requisição o objeto PaginationFilterDTO com os filtros desejados.

Exemplo de payload para buscar pagamentos de uma loja
{
  "filtros": 
    {
      "dataFinal": "2023-11-10",
      "dataInicial": "2023-10-01",
      "localPagamentoId": -1, // enviar esse valor por padrão.
      "redeId": -1 // enviar esse valor por padrão.
    },
  "pageNo": 0,
  "pageSize": 25,
  "sortBy": "dataPagto"
}
Exemplo de response retornando array de pagamentos
{
  "content": [
      {
        "pagamentos": [
            {
              "id": 591419,
              "mensagem": null,
              "permissao": null,
              "dataInicial": null,
              "dataFinal": null,
              "lojaId": 441,
              "redeId": null,
              "localPagamentoId": null,
              "clienteId": 343512,
              "clienteCpf": "136.360.099-07",
              "dataPagto": "02/10/2023",
              "valorPago": 211.69,
              "tipoPagto": "Carnê",
              "nomeLoja": "Sonho Azul",
              "flgCancelado": false,
              "motivoCancelamento": "",
              "numeroParcela": 1,
              "diferencaDias": null,
              "formaPagamento": "LOJA",
              "formaPagamentoDetalhe": "Sonho Azul",
              "qtdPagamentos": null
            }
        ],
        "valorTotal": 211.69,
        "qtdItems": 1
    }
  ],
  "pageable": {
      "sort": {
          "sorted": true,
          "unsorted": false,
          "empty": false
      },
      "pageNumber": 0,
      "pageSize": 25,
      "offset": 0,
      "unpaged": false,
      "paged": true
  },
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
  },
  "first": true,
  "numberOfElements": 1,
  "size": 25,
  "number": 0,
  "empty": false
}

Para mais informações, acesse a documentação da API: