Infrações e MED

Consultar infração MED

Exige monkeypay:infractions:read. Uma infração fora do alcance da organização do token responde 404.

GEThttps://api.monkeypay.app/api/v2/resource/infractions/{infractionId}Bearer

Fluxo

Antes de chamar

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    GETListar infrações

    /resource/infractions

    Obtenha o infractionId

Esta chamada

GETConsultar infração

/resource/infractions/{infractionId}

Respostas possíveis

  • 200Infração encontrada

    Confira status e dados da transação

  • 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

  • 404Infração inexistente ou fora do alcance

    Confira o identificador

Depois do sucesso

  1. Chamada

    POSTEnviar defesa

    /resource/mediations

    Envie uma defesa quando aplicável

Autorização

BearerRequer autenticação Bearer

Parâmetros

infractionIdstringcaminhoobrigatório
<infractionId>

Respostas

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "transactionId": "<transaction-id>",
7 "externalId": "<external-id>",
8 "walletId": "<wallet-id>",
9 "accountId": "<account-id>",
10 "account": {
11 "id": "<id>",
12 "bankCode": "<bank-code>",
13 "bankIspb": "<bank-ispb>",
14 "bankName": "<bank-name>",
15 "agency": "<agency>",
16 "accountNumber": "<account-number>",
17 "holder": "<holder>",
18 "type": "<type>",
19 "status": "<status>"
20 },
21 "status": "<status>",
22 "type": "<type>",
23 "amount": 1,
24 "reason": "<reason>",
25 "pixTransaction": {
26 "endToEnd": "<end-to-end>"
27 },
28 "createdAt": "<created-at>",
29 "updatedAt": "<updated-at>"
30 },
31 "pagination": null
32}

Campos da resposta

errorbooleanopcional
false
messagestringopcional
<message>
dataobjectopcional
<data>
idstring (uuid)opcional
<id>
transactionIdstring (uuid)opcional
<transactionId>
externalIdstringopcional
<externalId>
walletIdstringopcional
<walletId>
accountIdstringopcional
<accountId>
accountobjectopcional
<account>
idstringopcional
<id>
bankCodestringopcional
<bankCode>
bankIspbstringopcional
<bankIspb>
bankNamestringopcional
<bankName>
agencystringopcional
<agency>
accountNumberstringopcional
<accountNumber>
holderstringopcional
<holder>
typestringopcional
<type>
statusstringopcional
<status>
statusstringopcional
<status>
typestringopcional
<type>
amountnumberopcional

Valor em reais.

<amount>
reasonstringopcional
<reason>
pixTransactionobjectopcional
<pixTransaction>
endToEndstringopcional
<endToEnd>
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/infractions/{infractionId}' \
3 --header 'Content-Type: application/json' \
4 --header 'Authorization: Bearer <seu-token>'

Resposta

1{
2 "error": false,
3 "message": "<message>",
4 "data": {
5 "id": "<id>",
6 "transactionId": "<transaction-id>",
7 "externalId": "<external-id>",
8 "walletId": "<wallet-id>",
9 "accountId": "<account-id>",
10 "account": {
11 "id": "<id>",
12 "bankCode": "<bank-code>",
13 "bankIspb": "<bank-ispb>",
14 "bankName": "<bank-name>",
15 "agency": "<agency>",
16 "accountNumber": "<account-number>",
17 "holder": "<holder>",
18 "type": "<type>",
19 "status": "<status>"
20 },
21 "status": "<status>",
22 "type": "<type>",
23 "amount": 1,
24 "reason": "<reason>",
25 "pixTransaction": {
26 "endToEnd": "<end-to-end>"
27 },
28 "createdAt": "<created-at>",
29 "updatedAt": "<updated-at>"
30 },
31 "pagination": null
32}