Infrações e MED

Explore 5 endpoints de Infrações e MED, com finalidade, método e rota derivados do contrato publicado.

Endpoints relacionados

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

Quando usar cada endpoint

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

EndpointFinalidade
GET/resource/infractionsLista infrações da organização do token e das suborganizações vinculadas. Exige monkeypay:infractions:read; mediations=true também exige monkeypay:mediations:read. O filtro organizationId só aceita uma organização dentro desse alcance.
GET/resource/infractions/{infractionId}Exige monkeypay:infractions:read. Uma infração fora do alcance da organização do token responde 404.
GET/resource/mediationsLista mediações da organização do token e das suborganizações vinculadas. Exige monkeypay:mediations:read.
POST/resource/mediationsEnvia uma única defesa para uma infração no alcance da credencial. Exige monkeypay:mediations:write e um liquidante com MED habilitado.
GET/resource/mediations/{mediationId}Exige monkeypay:mediations:read. Uma mediação fora do alcance da organização do token responde 404.

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.

Acompanhar e defender uma infração

  1. Chamada

    GETListar infrações

    /resource/infractions

    Inclui casos das suborganizações vinculadas

  2. Chamada

    GETConsultar infração

    /resource/infractions/{infractionId}

    Confira o estado e guarde o infractionId

  3. Chamada

    POSTEnviar defesa

    /resource/mediations

    Envie a defesa com pelo menos um anexo

  4. Chamada

    GETConsultar mediação

    /resource/mediations/{mediationId}

    Consulte o estado registrado da defesa

Consultar mediações

  1. Chamada

    GETListar mediações

    /resource/mediations

    Inclui mediações das suborganizações vinculadas

  2. Chamada

    GETConsultar mediação

    /resource/mediations/{mediationId}

    Consulte detalhes e anexos autorizados