Skip to main content
POST
Cancel 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"

Body

application/json
idempotencyKey
string
required

Client-supplied idempotency key: any stable business string. The plugin projects it deterministically into the GUID form JDPI requires (contract 6), so the same value always dedups against the same JDPI request and the raw value is never sent verbatim.

Example:

"med-infraction-cancel-2024-0001"

Response

OK

dtHrCriacao
string
required

JDPI creation timestamp (RFC 3339 UTC).

Example:

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

dtHrUltModificacao
string
required

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

Example:

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

endToEndId
string
required

EndToEndId of the suspect payment.

Example:

"E1234567820240101000000000000001"

idRelatoInfracao
string
required

Infraction GUID (the natural key).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

motivo
integer<int64>
required

Infraction motivo code (1=Solicitacao de devolucao, 2=Cancelamento da devolucao).

Example:

1

motivoDescription
string
required

Human-readable infraction motivo label.

Example:

"Solicitacao de devolucao"

pspContraParte
string
required

ISPB of the counterparty.

Example:

"87654321"

pspCriador
string
required

ISPB of the infraction creator.

Example:

"12345678"

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"

detalhes
string

Free-text detail to help the recebedor analyse.

Example:

"Suspected scam."

detalhesAnalise
string

Analysis detail.

Example:

"Confirmed."

idMarcacaoFraude
string

Fraud-marker GUID, when analysis produced one.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

idRecValores
string

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

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

resultadoAnalise
integer<int64>

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

Example:

0

resultadoAnaliseDescription
string

Human-readable infraction analysis-result label.

Example:

"Aceita"

vlrInfracao
integer<int64>

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

Example:

15000