Este passo tem por finalidade listar as devolu\u00e7\u00f5es PIX usando os filtros.<\/p>\n\n\n\n
Segue exemplo de requisi\u00e7\u00e3o:<\/p>\n\n\n\n
curl --location --request GET 'https:\/\/hmlapi2.bancosemear.com.br\/paas-refund-api\/v1\/public\/refunds?endToEnd=E00795423202409181543QZokf67UnDr&page=1&itensPage=100&statusFilter=0&startDate=2024-10-08 00:00:00&endDate=2024-10-10 23:59:59' \\\n--header 'client_id: <CLIENT ID>' \\\n--header 'access_token: <ACCESS TOKEN' \\\n--header 'token: <TOKEN>'<\/code><\/pre>\n\n\n\nPar\u00e2metros de Requisi\u00e7\u00e3o<\/h4>\n\n\n\nCabe\u00e7alho<\/h5>\n\n\n\n\n- token:<\/strong> Payload JSON criptografado com uma chave p\u00fablica codificado em base64 (Gerado no passo anterior, Consulta\/Gera\u00e7\u00e3o de token<\/a>)<\/li>\n\n\n\n
- client_id:<\/strong> ID de cliente usado para controle de acesso do gateway de APIs<\/li>\n\n\n\n
- access-token:<\/strong> Token recebido ap\u00f3s executar o m\u00e9todo oAuth<\/a><\/li>\n<\/ul>\n\n\n\n
Query params<\/h4>\n\n\n\n\n- endToEnd:<\/strong> Identifica\u00e7\u00e3o referente ao pagamento recebido<\/li>\n\n\n\n
- page:<\/strong>\u00a0N\u00famero da pagina(utilizada para navega\u00e7\u00e3o), caso n\u00e3o seja enviado um valor, ser\u00e1 atribu\u00eddo 1 como default<\/li>\n\n\n\n
- itensPage:<\/strong>\u00a0Quantidade de itens por pagina( de 1 \u00e0 1.000 itens), caso n\u00e3o seja enviado um valor, ser\u00e1 atribu\u00eddo a quantidade padr\u00e3o do sistema<\/li>\n\n\n\n
- startDate:<\/strong>\u00a0Data inicial da busca <\/li>\n\n\n\n
- finalDate:<\/strong>\u00a0Data final da busca<\/li>\n\n\n\n
- statusFilter:<\/strong> Filtro por status, valores poss\u00edveis FALHA = 0, PENDENTE = 1, PAGO = 2, EXPIRADO = 3, TODOS = 4<\/li>\n<\/ul>\n\n\n\n
Resposta<\/h3>\n\n\n\n
Segue exemplo de resposta:<\/p>\n\n\n\n
\"actualPage\": 1,\n \"totalPages\": 1,\n \"totalItens\": 2,\n \"itensPerPage\": 100,\n \"refunds\": [\n {\n \"correlationId\": \"95137a35-5xx3-4e54-bxxc-10b97xxxc605\",\n \"transactionId\": \"JameesBondQA_2024-10-08_whGBqwRJzg\",\n \"endToEnd\": \"D0079542320xxxx251rFWFO4xxxiH\",\n \"originalEndToEnd\": \"E00795xxx409181xxxokf67UnDr\",\n \"status\": 2,\n \"processingStartDate\": \"2024-10-08T09:51:39.137\",\n \"movementDate\": \"2024-10-08T09:51:45.253\",\n \"processingEndDate\": \"2024-10-08T09:51:56\",\n \"amount\": 1.02,\n \"reason\": 2,\n \"payerDocument\": \"53303700000143\",\n \"payerAccount\": \"0110366690\",\n \"paymentDescription\": \"JamesBond QA QaVengers\",\n \"beneficiaryISPBB\": \"00755423\",\n \"beneficiaryAgency\": \"0001\",\n \"beneficiaryAgencyDigit\": \"9\",\n \"beneficiaryAccount\": \"0011055254\",\n \"beneficiaryAccountType\": \"CACC\",\n \"beneficiaryDocument\": \"00305550082\",\n \"beneficiaryName\": \"JOAO DA SILVA E SILVA\",\n \"errorCode\": null,\n \"errorDescription\": null\n },\n {\n \"correlationId\": \"b9334601-11b9-47b1-b349-595955744d5a\",\n \"transactionId\": \"JamesBondQA_2024-10-08_7BsBRbtywG\",\n \"endToEnd\": \"D007954232024100812445dguOXiQTvU\",\n \"originalEndToEnd\": \"E00795423202409181543QZokf67UnDr\",\n \"status\": 2,\n \"processingStartDate\": \"2024-10-08T09:44:27.643\",\n \"movementDate\": \"2024-10-08T09:44:47.917\",\n \"processingEndDate\": \"2024-10-08T09:44:57.86\",\n \"amount\": 0.02,\n \"reason\": 2,\n \"payerDocument\": \"53366651000143\",\n \"payerAccount\": \"0110378590\",\n \"paymentDescription\": \"Rafa QA QaVengers\",\n \"beneficiaryISPBB\": \"00795423\",\n \"beneficiaryAgency\": \"0001\",\n \"beneficiaryAgencyDigit\": \"9\",\n \"beneficiaryAccount\": \"0011017254\",\n \"beneficiaryAccountType\": \"CACC\",\n \"beneficiaryDocument\": \"00304140082\",\n \"beneficiaryName\": \"JOAO DA SILVA E SILVA\",\n \"errorCode\": null,\n \"errorDescription\": null\n }\n ]\n}<\/code><\/pre>\n\n\n\nPar\u00e2metros de Resposta<\/h5>\n\n\n\nCorpo (JSON)<\/h4>\n\n\n\nPropriedade<\/th> Descri\u00e7\u00e3o<\/th> Tipo<\/th><\/tr><\/thead> actualPage<\/td> Pagina atual<\/td> Integer<\/td><\/tr> totalPages<\/td> Total de p\u00e1ginas<\/td> Integer<\/td><\/tr> totalItens<\/td> Total de itens (linhas) apresentados na p\u00e1gina<\/td> Integer<\/td><\/tr> itensPerPage<\/td> Total de itens definidos para listar na p\u00e1gina<\/td> Integer<\/td><\/tr> refunds<\/td> Lista de devolu\u00e7\u00e3o<\/td> Integer<\/td><\/tr> correlationId<\/td> <\/td> String<\/td><\/tr> transactionId<\/td> <\/td> String<\/td><\/tr> endToEnd<\/mark><\/mark><\/td><\/td> String<\/td><\/tr> originalEndToEnd<\/td> <\/td> String<\/td><\/tr> status<\/td> FALHA = 0
PENDENTE = 1
PAGO = 2
EXPIRADO = 3
TODOS = 4<\/td> Integer<\/td><\/tr> processingStartDate<\/td> <\/td> Datetime<\/td><\/tr> movementDate<\/td> <\/td> Datetime<\/td><\/tr> processingEndDate<\/td> <\/td> Datetime<\/td><\/tr> amount<\/td> <\/td> Decimal<\/td><\/tr> reason<\/td> <\/td> Integer<\/td><\/tr> payerDocument<\/td> <\/td> String<\/td><\/tr> payerAccount<\/td> <\/td> String<\/td><\/tr> paymentDescription<\/td> <\/td> String<\/td><\/tr> beneficiaryISPBB<\/td> <\/td> String<\/td><\/tr> beneficiaryAgency<\/td> <\/td> String<\/td><\/tr> beneficiaryAgencyDigit<\/td> <\/td> String<\/td><\/tr> beneficiaryAccount<\/td> <\/td> String<\/td><\/tr> beneficiaryAccountType<\/td> <\/td> String<\/td><\/tr> beneficiaryDocument<\/td> <\/td> String<\/td><\/tr> beneficiaryName<\/td> <\/td> String<\/td><\/tr> errorCode<\/td> <\/td> Integer<\/td><\/tr> errorDescription<\/td> <\/td> String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<\/p>\n","protected":false},"excerpt":{"rendered":"
Descri\u00e7\u00e3o Este passo tem por finalidade listar as devolu\u00e7\u00f5es PIX usando os filtros. Endpoints Requisi\u00e7\u00e3o (GET) Segue exemplo de requisi\u00e7\u00e3o: Par\u00e2metros de Requisi\u00e7\u00e3o Cabe\u00e7alho Query params Resposta Segue exemplo de resposta: Par\u00e2metros de Resposta Corpo (JSON) Propriedade Descri\u00e7\u00e3o Tipo actualPage Pagina atual Integer totalPages Total de p\u00e1ginas Integer totalItens Total de itens (linhas) apresentados na …<\/p>\n