Skip to main content
GET
Get a MED infraction

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

idRelatoInfracao
string
required

The infraction GUID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

ispb
string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the record has to be one that participant is a party to - either side of a dispute, the creator of a value recovery, the participant a refund credit was booked for - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed. A record this deployment does not hold is 404 PIX-0147 too when an ispb is named. An ISPB this deployment does not act as is 422 PIX-0128, before any record is read. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

indirectId
string<uuid>

The registered indirect participant (UUID) this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the infraction has to be over a payment this deployment recorded for that indirect - the rule GET /v1/med/infractions?indirectId= lists by - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed; an infraction this deployment does not hold is 404 PIX-0147 too when an indirectId is named. It is ROUTING DATA you supply, never a credential, and a token confined to one indirect has to name it here. Not a valid UUID is 400 PIX-0061. Sending it empty (indirectId=) reads the same as omitting it.

Example:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Response

OK

counterpartIspb
string
required

ISPB of the counterparty.

Example:

"87654321"

createdAt
string
required

JDPI creation timestamp (RFC 3339 UTC).

Example:

"2024-01-01T12:00:00.000Z"

creatorIspb
string
required

ISPB of the infraction creator.

Example:

"12345678"

endToEndId
string
required

EndToEndId of the suspect payment.

Example:

"E1234567820240101000000000000001"

infractionId
string
required

Infraction GUID (the natural key).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

reason
integer<int64>
required

Infraction reason code (1=refund request, 2=refund cancellation).

Example:

1

reasonDescription
string
required

Human-readable infraction reason label.

Example:

"Solicitacao de refund"

status
integer<int64>
required

stRelatoInfracao lifecycle code (0=Aberto, 1=Recebido, 2=Cancelado, 3=Analisado).

Example:

0

statusDescription
string
required

Human-readable stRelatoInfracao label.

Example:

"Aberto"

tpSitOrigem
integer<int64>
required

Situation-origin code (0..5).

Example:

0

tpSitOrigemDescription
string
required

Human-readable tpSitOrigem label.

Example:

"Golpe/Estelionato"

updatedAt
string
required

JDPI last-modification timestamp (RFC 3339 UTC) — the poll watermark.

Example:

"2024-01-01T12:05:00.000Z"

analysisDetails
string

Analysis detail.

Example:

"Confirmed."

analysisResult
integer<int64>

Infraction analysis result (0=Aceita, 1=Rejeitada); null until analysed.

Example:

0

analysisResultDescription
string

Human-readable infraction analysis-result label.

Example:

"Aceita"

details
string

Free-text detail to help the receiving PSP analyse.

Example:

"Suspected scam."

fraudMarkerId
string

Fraud-marker GUID, when analysis produced one.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

recoveryId
string

Value-recovery GUID, when the infraction came from a recovery.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

vlrInfracao
integer<int64>

Amount to block on the account, in centavos; null when absent.

Example:

15000