DocumentaçãoSuporte
Referência API PagHiper

Listar transações via API

post
https://pix.paghiper.com/invoice/list/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Campo composto de números, letras, traços e hífen.
Sempre começa por apk_

Exemplo: apk_48040241-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz

Utilizado para identificar o vendedor

string
required

Token individual para cada vendedor, utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

string

Listar as transações de acordo com o seu status atual

Esperado:

statussignificado
pendingaguardando
canceledcancelado
paidaprovado e completo
processinganalise
refundedestornado

date

Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado os últimos 90 dias.

Verifique as orientações do parâmetro:
filter_date

date

Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado a data atual. 

Verifique as orientações do parâmetro:
filter_date

string
  • Campo obrigatório caso utilize o initial_date e final_date
    Este parâmetro tem a função de filtrar a busca de datas por:

    • Data em que a transação foi criada,
    • Data em que a transação foi paga
    ou
    • Data em que vence a transação

    Esperado:

    opçõessignificado
    create_dateData da criação
    paid_dateData do pagamento
    due_dateData do vencimento
date

Data de vencimento do pix

Exemplo esperado 2018-01-17

Utilizado apenas para listar pix que irão vencer em uma determinada data.

string

CPF ou CNPJ do pagador

Útil para buscar os pedidos/pix de um cliente especifico através do CPF ou CNPJ

string

Código de referência da venda

Código para referenciar o pagamento ou o número do pedido

Ú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.

int32

Possibilidade de buscar pelo valor da transação

Valor unitário em centavos
Exemplo:Filtrar transações com o valor de R$ 1.000,00 (mil reais), deverá ser informado: 100000 (total em centavos)

string

Deve ser utilizado apenas em conjunto com o parâmetro: value_cents

O uso desse parâmetro auxiliaria por exemplo a listar todas as transações de valores menores ou iguais ( <= ) á R$ 1000,00 (mil reais).

Esperado:

símbolosignificado
=Igual
>=Maior igual
<=Menor igual
>Maior
<Menor

int32

Limita o número máximo de transações retornadas a no máximo 100 registro.

Esperado:
1 a 100

Esse parâmetro é útil para paginação

int32

necessário quando se deseja realizar paginação dos resultados.

Esperado:
1 a 999

Responses

Updated 10 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago