Relatórios

Consultar link de download do relatório

Requer monkeypay:reports:read; valida escopo pela wallet gravada no relatório.

GEThttps://api.monkeypay.app/api/v2/resource/reports/{id}Bearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    POSTSolicitar relatório

    /resource/reports

    data.id do relatório

Esta chamada

GETConsultar relatório

/resource/reports/{id}

Respostas possíveis

  • 200completed: false

    Ainda gerando; consulte de novo em alguns segundos

  • 200completed: true

    Baixe pelo downloadUrl em até 1 hora

  • 401Token ausente ou expirado

    Emita outro token e repita uma única vez

  • 403Credencial sem a permissão exigida

    Não repita; leia o detail e peça o acesso

  • 404Relatório inexistente ou de outra organização

    Confira o identificador

Autorização

BearerRequer autenticação Bearer

Parâmetros

idstringcaminhoobrigatório
Tamanho1 ≤ tamanho
<id>

Respostas

1{
2 "error": false,
3 "message": "Report is still being generated",
4 "data": {
5 "id": "<id>",
6 "fileName": "<file-name>",
7 "format": "<format>",
8 "completed": true,
9 "downloadUrl": "<download-url>",
10 "createdAt": "<created-at>",
11 "updatedAt": "<updated-at>"
12 },
13 "pagination": null
14}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
Report is still being generated
dataobjectopcional
<data>
idstringopcional
<id>
fileNamestringopcional
<fileName>
formatstringopcional
<format>
completedbooleanopcional
<completed>
downloadUrlstringopcional

URL assinada e temporária; `null` enquanto o relatório é gerado. Baixe logo após obter e não a armazene.

<downloadUrl>
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
paginationobjectopcional
<pagination>
Credenciais

Requisição

1curl --request GET \
2 --url 'https://api.monkeypay.app/api/v2/resource/reports/{id}' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": false,
3 "message": "Report is still being generated",
4 "data": {
5 "id": "<id>",
6 "fileName": "<file-name>",
7 "format": "<format>",
8 "completed": true,
9 "downloadUrl": "<download-url>",
10 "createdAt": "<created-at>",
11 "updatedAt": "<updated-at>"
12 },
13 "pagination": null
14}