Esta requisição possibilita a listagem de todas as transações realizada em um determinado período.
Através dos filtros disponíveis, é possível buscar por exemplo por todas as transações por um determinado status, data de vencimento, data de emissão ou de pagamento.
| Endpoint https://api.paghiper.com/transaction/list/ |
| Protocolo / Tipo de Requisição HTTPS / POST |
| Autenticação Para utilizar o endpoint será necessário possuir credencias apiKey e token. Esses dados estão disponíveis no painel de credenciais no PagHiper. Pagina de credenciais: https://www.paghiper.com/painel/credenciais/ |
| Tipo de Conteúdo (JSON) O header “Accept” deverá ser enviado contendo o formato da mensagem desejado. "Accept", "application/json" Importante: Este procedimento é explicado em detalhes no item: 11. Configurando o Formato das Mensagens. |
No exemplo abaixo foi requerido a listagem de todas as transações que foram pagas em todo o mês de janeiro/2018, além de limitar o resultado em 2 registro por pagina, iniciando da primeira página.
{
"token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX",
"apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz",
"initial_date":"2018-01-01",
"final_date":"2018-01-31",
"filter_date":"paid_date",
"status":"paid",
"limit":"2",
"page":"1",
}
{
"transaction_list_request": {
"result": "success",
"response_message": "lista encontrada",
"current_page": 1,
"total_page": 48,
"transaction_list": [
{
"transaction_id": "FJWTCLK4M9LU3MSG",
"order_id": "55977",
"status": "paid",
"status_date": "2018-01-05 05:32:31",
"due_date": "2018-01-25",
"value_cents": 7531,
"discount_cents": 1200,
"value_fee_cents": 199,
"payer_email": "[email protected]",
"payer_name": "Alexandro Mustaff",
"payer_cpf_cnpj": "00000000000",
"payer_phone": "11999999999",
"create_date": "2018-01-02 18:56:48",
"paid_date": "2018-01-05 05:32:31",
"bank_slip": {
"digitable_line": "34191.00000 00000.780247 00000.190000 9 74460000007531",
"url_slip": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999",
"url_slip_pdf": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999/pdf"
},
"items": [
{
"item_id": "H5BBRMHHC",
"description": "Capsula da beleza (60 Comprimidos)",
"quantity": 1,
"price_cents": 8000
},
{
"item_id": "6FDFJPTG4YZ499W",
"description": "Frete",
"quantity": 1,
"price_cents": 731
}
]
},
{
"transaction_id": "D21R8MBBUHD1PG5T",
"order_id": "55962",
"status": "paid",
"status_date": "2018-01-06 05:50:22",
"due_date": "2018-01-15",
"value_cents": 10560,
"discount_cents": 989,
"value_fee_cents": 199,
"payer_email": "[email protected]",
"payer_name": "Matheus Pill",
"payer_cpf_cnpj": "00000000000",
"payer_phone": "11999999999",
"create_date": "2018-01-04 17:05:53",
"paid_date": "2018-01-06 05:50:22",
"bank_slip": {
"digitable_line": "34191.00000 00000.780247 00000.190000 9 74460000007531",
"url_slip": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999",
"url_slip_pdf": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999/pdf"
},
"items": [
{
"item_id": "UJ7JK6KJJ-morango",
"description": "Morango (907g) - Conserva",
"quantity": 1,
"price_cents": 9889
},
{
"item_id": "6FDFJPTG4YZ499W",
"description": "Frete",
"quantity": 1,
"price_cents": 1660
}
]
}
],
"http_code": "201"
}
}