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

apiKeystring 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

tokenstring 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/

statusstring

Listar as transaçõ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_datestring date

Data inicial do filtro <br /><br />Exemplo esperado <br />2018-01-01 <br /><br />Caso não seja enviado esse parâmetro, será utilizado os últimos 90 dias. <br /><br />Verifique as orientações do parâmetro: <br /><strong>filter_date</strong>

final_datestring date

Data inicial do filtro <br /><br />Exemplo esperado <br />2018-01-01 <br /><br />Caso não seja enviado esse parâmetro, será utilizado a data atual. <br /><br />Verifique as orientações do parâmetro: <br /><strong>filter_date</strong>

filter_datestring
  • Campo obrigatório caso utilize o <strong>initial_date</strong> e <strong>final_date</strong> <br />Este parâmetro tem a função de filtrar a busca de datas por:<br /><br />• Data em que a transação foi criada,<br /> • Data em que a transação foi paga<br />ou<br />• Data em que vence a transação<br /><br />Esperado:<br><br><table class="especificacoesmini"> <thead> <tr> <th>opções</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>create_date</td> <td>Data da criaçã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_datestring 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_cnpjstring

<strong>CPF ou CNPJ do pagador</strong><br /><br />Útil para buscar os pedidos/pix de um cliente especifico através do CPF ou CNPJ

order_idstring

<strong>Código de referência da venda</strong><br /><br /> Código para referenciar o pagamento ou o número do pedido <br /><br />Útil para buscar o pagamento de um pedido criado pelo sistema do lojista, caso o número do pedido tenha vínculo com este parâmetro.

value_centsinteger

Possibilidade de buscar pelo valor da transação<br /><br /> Valor unitário em centavos<br /> Exemplo:Filtrar transações com o valor de R$ 1.000,00 (mil reais), deverá ser informado: 100000 (total em centavos)

value_cents_filterstring

Deve ser utilizado apenas em conjunto com o parâmetro: <strong>value_cents</strong> <br><br>O uso desse parâmetro auxiliaria por exemplo a listar todas as transações de valores menores ou iguais ( <= ) á R$ 1000,00 (mil reais). <br><br>Esperado: <br><br> <table class="especificacoesmini"> <thead> <tr> <th>símbolo</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>=</td> <td>Igual</td> </tr> <tr> <td>>=</td> <td>Maior igual</td> </tr> <tr> <td><=</td> <td>Menor igual</td> </tr> <tr> <td>></td> <td>Maior</td> </tr> <tr> <td><</td> <td>Menor</td> </tr> </tbody> </table>

limitinteger

Limita o número máximo de transações retornadas a no máximo 100 registro.<br><br /> Esperado: <br><strong>1 a 100</strong><br /><br> Esse parâmetro é útil para paginação

pageinteger

necessário quando se deseja realizar paginação dos resultados. <br><br>Esperado: <br><strong>1 a 999</strong>

Response

200

object required

Changes

No recorded changes to this operation across all 1 revision of this API.