Listar Devoluções PIX

Descrição #

Este passo tem por finalidade listar as devoluções PIX usando os filtros.

Endpoints #

• Produção: 
• https://api2.bancosemear.com.br/paas-refund-api/v1/public/refunds?endToEnd=<>&page=1&itensPage=100&statusFilter=0&startDate=<>&endDate=<>
• Homologação: 
• https://hmlapi2.bancosemear.com.br/paas-refund-api/v1/public/refunds?endToEnd=<>&page=1&itensPage=100&statusFilter=0&startDate=<>&endDate=<>

Requisição (GET) #

Segue exemplo de requisição:

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' \
--header 'client_id: <CLIENT ID>' \
--header 'access_token: <ACCESS TOKEN' \
--header 'token: <TOKEN>'

Parâmetros de Requisição #

Cabeçalho #

• token: Payload JSON criptografado com uma chave pública codificado em base64 (Gerado no passo anterior, Consulta/Geração de token)
• client_id: ID de cliente usado para controle de acesso do gateway de APIs
• access-token: Token recebido após executar o método oAuth

Query params #

• endToEnd: Identificação referente ao pagamento recebido
• page: Número da pagina(utilizada para navegação), caso não seja enviado um valor, será atribuído 1 como default
• itensPage: Quantidade de itens por pagina( de 1 à 1.000 itens), caso não seja enviado um valor, será atribuído a quantidade padrão do sistema
• startDate: Data inicial da busca
• finalDate: Data final da busca
• statusFilter: Filtro por status, valores possíveis FALHA = 0, PENDENTE = 1, PAGO = 2, EXPIRADO = 3, TODOS = 4

Resposta #

Segue exemplo de resposta:

    "actualPage": 1,
    "totalPages": 1,
    "totalItens": 2,
    "itensPerPage": 100,
    "refunds": [
        {
            "correlationId": "95137a35-5xx3-4e54-bxxc-10b97xxxc605",
            "transactionId": "JameesBondQA_2024-10-08_whGBqwRJzg",
            "endToEnd": "D0079542320xxxx251rFWFO4xxxiH",
            "originalEndToEnd": "E00795xxx409181xxxokf67UnDr",
            "status": 2,
            "processingStartDate": "2024-10-08T09:51:39.137",
            "movementDate": "2024-10-08T09:51:45.253",
            "processingEndDate": "2024-10-08T09:51:56",
            "amount": 1.02,
            "reason": 2,
            "payerDocument": "53303700000143",
            "payerAccount": "0110366690",
            "paymentDescription": "JamesBond QA  QaVengers",
            "beneficiaryISPBB": "00755423",
            "beneficiaryAgency": "0001",
            "beneficiaryAgencyDigit": "9",
            "beneficiaryAccount": "0011055254",
            "beneficiaryAccountType": "CACC",
            "beneficiaryDocument": "00305550082",
            "beneficiaryName": "JOAO DA SILVA E SILVA",
            "errorCode": null,
            "errorDescription": null
        },
        {
            "correlationId": "b9334601-11b9-47b1-b349-595955744d5a",
            "transactionId": "JamesBondQA_2024-10-08_7BsBRbtywG",
            "endToEnd": "D007954232024100812445dguOXiQTvU",
            "originalEndToEnd": "E00795423202409181543QZokf67UnDr",
            "status": 2,
            "processingStartDate": "2024-10-08T09:44:27.643",
            "movementDate": "2024-10-08T09:44:47.917",
            "processingEndDate": "2024-10-08T09:44:57.86",
            "amount": 0.02,
            "reason": 2,
            "payerDocument": "53366651000143",
            "payerAccount": "0110378590",
            "paymentDescription": "Rafa QA  QaVengers",
            "beneficiaryISPBB": "00795423",
            "beneficiaryAgency": "0001",
            "beneficiaryAgencyDigit": "9",
            "beneficiaryAccount": "0011017254",
            "beneficiaryAccountType": "CACC",
            "beneficiaryDocument": "00304140082",
            "beneficiaryName": "JOAO DA SILVA E SILVA",
            "errorCode": null,
            "errorDescription": null
        }
    ]
}

Parâmetros de Resposta #

Corpo (JSON) #