Relatórios

Listar relatórios de uma wallet

Requer monkeypay:reports:read; a wallet deve pertencer ao escopo organizacional.

GEThttps://api.monkeypay.app/api/v2/resource/reportsBearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    GETListar carteiras

    /resource/wallets

    walletId

Esta chamada

GETListar relatórios

/resource/reports

Respostas possíveis

Autorização

BearerRequer autenticação Bearer

Parâmetros

walletIdstringqueryobrigatório
Tamanho1 ≤ tamanho
<walletId>
pageintegerqueryopcional
Intervalo1 ≤ valor
1
limitintegerqueryopcional
Intervalo1 ≤ valor ≤ 100
10
sortBystringqueryopcional

valores: createdAtupdatedAtfileNameformattype

createdAt
sortOrderstringqueryopcional

valores: ascdesc

desc
searchstringqueryopcional
<search>
startDatestringqueryopcional
<startDate>
endDatestringqueryopcional
<endDate>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "id": "<id>",
7 "walletId": "<wallet-id>",
8 "type": "transactions",
9 "format": "xlsx",
10 "fileName": "<file-name>",
11 "completed": true,
12 "idempotencyKey": "<idempotency-key>",
13 "queryParams": "<query-params>",
14 "createdAt": "<created-at>",
15 "updatedAt": "<updated-at>",
16 "downloadUrl": "<download-url>"
17 }
18 ],
19 "pagination": {
20 "page": 1,
21 "limit": 20,
22 "total": 57,
23 "totalPages": 3
24 }
25}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
<message>
dataarrayopcional
<data>
idstringopcional
<id>
walletIdstringopcional
<walletId>
typestringopcional

valores: transactionsledger-entriesconsolidated-balance

<type>
formatstringopcional

valores: xlsxcsvparquetpdf

<format>
fileNamestringopcional
<fileName>
completedbooleanopcional

`true` quando o arquivo está pronto para download.

<completed>
idempotencyKeystringopcional
<idempotencyKey>
queryParamsobjectopcional

Filtros usados na geração.

<queryParams>
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
downloadUrlstringopcional

URL temporária, presente quando `completed` é `true`.

<downloadUrl>
paginationobjectopcional
<pagination>
pageintegeropcional
1
limitintegeropcional
20
totalintegeropcional

Total de itens que atendem ao filtro.

57
totalPagesintegeropcional

Nunca é menor que 1, mesmo com a lista vazia.

3
Credenciais

Requisição

1curl --request GET \
2 --url 'https://api.monkeypay.app/api/v2/resource/reports?page=1&limit=10&sortBy=createdAt&sortOrder=desc' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "id": "<id>",
7 "walletId": "<wallet-id>",
8 "type": "transactions",
9 "format": "xlsx",
10 "fileName": "<file-name>",
11 "completed": true,
12 "idempotencyKey": "<idempotency-key>",
13 "queryParams": "<query-params>",
14 "createdAt": "<created-at>",
15 "updatedAt": "<updated-at>",
16 "downloadUrl": "<download-url>"
17 }
18 ],
19 "pagination": {
20 "page": 1,
21 "limit": 20,
22 "total": 57,
23 "totalPages": 3
24 }
25}