| Campo | Tamanho | Tipo | Presença | Descrição | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKey | Até 50 caracteres | Texto | Obrigatória | 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 |
||||||||||||
| token | Até 128 caracteres | Texto | Obrigatória | 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/ |
||||||||||||
| status | Até 15 caracteres | Texto | Opcional | Listar as transações de acordo com o seu status atual Esperado:
| ||||||||||||
| initial_date | Date | Opcional | 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 |
|||||||||||||
| final_date | Date | Opcional | 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 |
|||||||||||||
| filter_date | Texto | Obrigatório* | * 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 ou • Data em que a transação foi paga Esperado:
|
|||||||||||||
| due_date | Date | Opcional | Data de vencimento do Pix Exemplo esperado 2018-01-17 Utilizado apenas para listar pix que irão vencer em uma determinada data. |
|||||||||||||
| order_id | Até 64 caracteres | Texto | Opcional | 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. |
||||||||||||
| payer_cpf_cnpj | Até 14 caracteres | Texto | Opcional | CPF ou CNPJ do pagador Útil para buscar os pedidos pix de um cliente especifico através do CPF ou CNPJ |
||||||||||||
| value_cents | Até 15 caracteres | Numérico | Opcional | 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) |
||||||||||||
| value_cents_filter | Até 2 caracteres | Texto | Opcional | 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:
|
||||||||||||
| limit | Até 3 caracteres | Numérico | Opcional | 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 |
||||||||||||
| page | Até 3 caracteres | Numérico | Opcional | necessário quando se deseja realizar paginação dos resultados. Esperado: 1 a 999 |