Relatórios

Explore 3 endpoints de Relatórios, com finalidade, método e rota derivados do contrato publicado.

Endpoints relacionados

Abra um endpoint para consultar parâmetros, exemplos e respostas.

GETListar relatórios/resource/reportsPOSTSolicitar relatório/resource/reportsGETConsultar relatório/resource/reports/{id}

Quando usar cada endpoint

Compare a finalidade de cada operação antes de iniciar a integração.

EndpointFinalidade
GET/resource/reportsRequer monkeypay:reports:read; a wallet deve pertencer ao escopo organizacional.
POST/resource/reportsRequer monkeypay:reports:write; a wallet deve pertencer ao escopo organizacional. A geração é assíncrona: guarde o id devolvido e consulte GET /resource/reports/{id} até completed ser true.
GET/resource/reports/{id}Requer monkeypay:reports:read; valida escopo pela wallet gravada no relatório.

Finalidades, métodos e rotas vêm do contrato OpenAPI publicado.

Fluxo da categoria

A ordem das chamadas, quem executa cada passo e o que vem depois. Clique numa chamada para ver o fluxo dela.

Exportar

  1. Chamada

    POSTSolicitar relatório

    /resource/reports

    Responde 202 com completed: false

  2. Chamada

    GETConsultar relatório

    /resource/reports/{id}

    Consulte a cada poucos segundos

  3. MonkeyPay

    Arquivo pronto

    completed: true e downloadUrl

  4. Você

    Baixe o arquivo

    O link vale 1 hora, sem Authorization

Histórico

  1. Chamada

    GETListar relatórios

    /resource/reports

    Relatórios da carteira, com downloadUrl nos prontos