Relatórios

Solicitar exportação de relatório

Requer 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.

POSThttps://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

  3. Você

    Defina uma idempotencyKey

    Opcional; permite reenviar sem duplicar

Esta chamada

POSTSolicitar relatório

/resource/reports

Respostas possíveis

Depois do sucesso

  1. Chamada

    GETConsultar relatório

    /resource/reports/{id}

    Até completed: true

  2. Você

    Baixe o arquivo

    downloadUrl vale 1 hora

Autorização

BearerRequer autenticação Bearer

Body

walletIdstringobrigatório
Tamanho1 ≤ tamanho
<wallet-id>
organizationIdstringopcional

Quando informado, deve ser a organização proprietária da wallet.

Tamanho1 ≤ tamanho
<organization-id>
typestringobrigatório

valores: transactionsledger-entriesconsolidated-balance

transactions
formatstringobrigatório

valores: xlsxcsvparquetpdf

xlsx
startDatestring (date-time)obrigatório
<start-date>
endDatestring (date-time)obrigatório
<end-date>
idempotencyKeystringopcional
Tamanho1 ≤ tamanho
<idempotency-key>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "walletId": "<wallet-id>",
7 "type": "transactions",
8 "format": "xlsx",
9 "fileName": "<file-name>",
10 "completed": true,
11 "idempotencyKey": "<idempotency-key>",
12 "queryParams": "<query-params>",
13 "createdAt": "<created-at>",
14 "updatedAt": "<updated-at>"
15 },
16 "pagination": null
17}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
<message>
dataobjectopcional
<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>
paginationobjectopcional
<pagination>
Credenciais

Requisição

1curl --request POST \
2 --url 'https://api.monkeypay.app/api/v2/resource/reports' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>' \
5 --data '{
6 "walletId": "<wallet-id>",
7 "organizationId": "<organization-id>",
8 "type": "transactions",
9 "format": "xlsx",
10 "startDate": "<start-date>",
11 "endDate": "<end-date>",
12 "idempotencyKey": "<idempotency-key>"
13 }'

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "walletId": "<wallet-id>",
7 "type": "transactions",
8 "format": "xlsx",
9 "fileName": "<file-name>",
10 "completed": true,
11 "idempotencyKey": "<idempotency-key>",
12 "queryParams": "<query-params>",
13 "createdAt": "<created-at>",
14 "updatedAt": "<updated-at>"
15 },
16 "pagination": null
17}