---
title: "Listar transações via API"
method: POST
path: "/invoice/list/"
---

# Listar transações via API

`POST /invoice/list/`

## Request

- Base URL: `https://pix.paghiper.com`
- URL: `https://pix.paghiper.com/invoice/list/`
- Auth: none required

## Request body

- object
  - `apiKey` string, required: Campo composto de números, letras, traços e hífen.<br>Sempre começa por <strong>apk_</strong><br><br> Exemplo: apk_48040241-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz<br> <br> Utilizado para identificar o vendedor
  - `token` string, required: Token individual para cada vendedor, utilizado para validar a solicitação e não deve ser compartilhado com terceiros.<br><br>Para obter o token:<br>https://www.paghiper.com/painel/token/
  - `status` string: Listar as transa&ccedil;&otilde;es de acordo com o seu status atual<br /><br /> Esperado:<table class="especificacoesmini"> <thead> <tr> <th>status</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>pending</td> <td>aguardando</td> </tr> <tr> <td>canceled</td> <td>cancelado</td> </tr> <tr> <td>paid</td> <td>aprovado e completo</td> </tr> <tr> <td>processing</td> <td>analise</td> </tr> <tr> <td>refunded</td> <td>estornado</td> </tr> </table> </tbody>
  - `initial_date` string, date: Data inicial do filtro <br /><br />Exemplo esperado <br />2018-01-01 <br /><br />Caso n&atilde;o seja enviado esse par&acirc;metro, ser&aacute; utilizado os &uacute;ltimos 90 dias. <br /><br />Verifique as orienta&ccedil;&otilde;es do par&acirc;metro: <br /><strong>filter_date</strong>
  - `final_date` string, date: Data inicial do filtro <br /><br />Exemplo esperado <br />2018-01-01 <br /><br />Caso n&atilde;o seja enviado esse par&acirc;metro, ser&aacute; utilizado a data atual.&nbsp;<br /><br />Verifique as orienta&ccedil;&otilde;es do par&acirc;metro: <br /><strong>filter_date</strong>
  - `filter_date` string: * Campo obrigat&oacute;rio caso utilize o <strong>initial_date</strong> e <strong>final_date</strong> <br />Este par&acirc;metro tem a fun&ccedil;&atilde;o de filtrar a busca de datas por:<br /><br />&bull; Data em que a transa&ccedil;&atilde;o foi criada,<br /> &bull; Data em que a transa&ccedil;&atilde;o foi paga<br />ou<br />&bull; Data em que vence a transa&ccedil;&atilde;o<br /><br />Esperado:<br><br><table class="especificacoesmini"> <thead> <tr> <th>op&ccedil;&otilde;es</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>create_date</td> <td>Data da cria&ccedil;&atilde;o</td> </tr> <tr> <td>paid_date</td> <td>Data do pagamento</td> </tr> <tr> <td>due_date</td> <td>Data do vencimento</td> </tr> </tbody> </table>
  - `due_date` string, date: Data de vencimento do pix <br><br>Exemplo esperado 2018-01-17 <br><br>Utilizado apenas para listar pix que irão vencer em uma determinada data.
  - `payer_cpf_cnpj` string: <strong>CPF ou CNPJ do pagador</strong><br /><br />&Uacute;til para buscar os pedidos/pix de um cliente especifico através do CPF ou CNPJ
  - `order_id` string: <strong>C&oacute;digo de refer&ecirc;ncia da venda</strong><br /><br /> C&oacute;digo para referenciar o pagamento ou o n&uacute;mero do pedido <br /><br />&Uacute;til para buscar o pagamento de um pedido criado pelo sistema do lojista, caso o n&uacute;mero do pedido tenha v&iacute;nculo com este par&acirc;metro.
  - `value_cents` integer: Possibilidade de buscar pelo valor da transa&ccedil;&atilde;o<br /><br /> Valor unit&aacute;rio em centavos<br /> Exemplo:Filtrar transa&ccedil;&otilde;es com o valor de R$ 1.000,00 (mil reais), dever&aacute; ser informado: 100000 (total em centavos)
  - `value_cents_filter` string: Deve ser utilizado apenas em conjunto com o par&acirc;metro: <strong>value_cents</strong> <br><br>O uso desse par&acirc;metro auxiliaria por exemplo a listar todas as transa&ccedil;&otilde;es de valores menores ou iguais ( &lt;= ) &aacute; R$ 1000,00 (mil reais). <br><br>Esperado: <br><br> <table class="especificacoesmini"> <thead> <tr> <th>s&iacute;mbolo</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>=</td> <td>Igual</td> </tr> <tr> <td>&gt;=</td> <td>Maior igual</td> </tr> <tr> <td>&lt;=</td> <td>Menor igual</td> </tr> <tr> <td>&gt;</td> <td>Maior</td> </tr> <tr> <td>&lt;</td> <td>Menor</td> </tr> </tbody> </table>
  - `limit` integer: Limita o n&uacute;mero m&aacute;ximo de transa&ccedil;&otilde;es retornadas a no m&aacute;ximo 100 registro.<br><br /> Esperado: <br><strong>1 a 100</strong><br /><br> Esse par&acirc;metro &eacute; &uacute;til para pagina&ccedil;&atilde;o
  - `page` integer: necess&aacute;rio quando se deseja realizar pagina&ccedil;&atilde;o dos resultados. <br><br>Esperado: <br><strong>1 a 999</strong>

## Response `200`

200

- object

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/paghiper/apis/pix.md) - [All operations](https://skmtc.dev/paghiper/apis/pix/llms.txt) - [OpenAPI document](https://skmtc.dev/paghiper/apis/pix/revisions/0e72404c989d?raw)