Infrações e MED

Listar mediações MED

Lista mediações da organização do token e das suborganizações vinculadas. Exige monkeypay:mediations:read.

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

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Você

    Tenha permissão de leitura de mediações

    monkeypay:mediations:read

Esta chamada

GETListar mediações

/resource/mediations

Respostas possíveis

  • 200Mediações paginadas

    Abra uma mediação pelo mediationId

  • 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

Depois do sucesso

  1. Chamada

    GETConsultar mediação

    /resource/mediations/{mediationId}

    Consulte uma mediação

Autorização

BearerRequer autenticação Bearer

Parâmetros

pageintegerqueryopcional
Intervalo1 ≤ valor
1
limitintegerqueryopcional
Intervalo1 ≤ valor ≤ 100
10
accountIdstringqueryopcional
<accountId>
walletIdstringqueryopcional
<walletId>
statusstringqueryopcional
<status>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "mediation": {
7 "id": "<id>",
8 "infractionId": "<infraction-id>",
9 "defense": "<defense>",
10 "attachments": [
11 "<attachments>"
12 ],
13 "status": "<status>",
14 "createdAt": "<created-at>",
15 "updatedAt": "<updated-at>"
16 },
17 "infraction": {
18 "id": "<id>",
19 "status": "<status>",
20 "type": "<type>",
21 "amount": 1,
22 "createdAt": "<created-at>"
23 }
24 }
25 ],
26 "pagination": {
27 "page": 1,
28 "limit": 1,
29 "total": 1,
30 "totalPages": 1
31 }
32}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
<message>
dataarrayopcional
<data>
mediationobjectopcional
<mediation>
idstring (uuid)opcional
<id>
infractionIdstring (uuid)opcional
<infractionId>
defensestringopcional
<defense>
attachmentsarrayopcional
<attachments>
statusstringopcional
<status>
createdAtstring (date-time)opcional
<createdAt>
updatedAtstring (date-time)opcional
<updatedAt>
infractionobjectopcional
<infraction>
idstring (uuid)opcional
<id>
statusstringopcional
<status>
typestringopcional
<type>
amountnumberopcional

Valor em reais.

<amount>
createdAtstring (date-time)opcional
<createdAt>
paginationobjectopcional
<pagination>
pageintegeropcional
<page>
limitintegeropcional
<limit>
totalintegeropcional
<total>
totalPagesintegeropcional
<totalPages>
Credenciais

Requisição

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

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": [
5 {
6 "mediation": {
7 "id": "<id>",
8 "infractionId": "<infraction-id>",
9 "defense": "<defense>",
10 "attachments": [
11 "<attachments>"
12 ],
13 "status": "<status>",
14 "createdAt": "<created-at>",
15 "updatedAt": "<updated-at>"
16 },
17 "infraction": {
18 "id": "<id>",
19 "status": "<status>",
20 "type": "<type>",
21 "amount": 1,
22 "createdAt": "<created-at>"
23 }
24 }
25 ],
26 "pagination": {
27 "page": 1,
28 "limit": 1,
29 "total": 1,
30 "totalPages": 1
31 }
32}