Skip to main content
POST
Cancel a MED infraction

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

idRelatoInfracao
string
obrigatório

The infraction GUID.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Corpo

application/json
idempotencyKey
string
obrigatório

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.

Exemplo:

"med-infraction-cancel-2024-0001"

Resposta

OK

dtHrCriacao
string
obrigatório

JDPI creation timestamp (RFC 3339 UTC).

Exemplo:

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

dtHrUltModificacao
string
obrigatório

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

Exemplo:

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

endToEndId
string
obrigatório

EndToEndId of the suspect payment.

Exemplo:

"E1234567820240101000000000000001"

idRelatoInfracao
string
obrigatório

Infraction GUID (the natural key).

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

motivo
integer<int64>
obrigatório

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

Exemplo:

1

motivoDescription
string
obrigatório

Human-readable infraction motivo label.

Exemplo:

"Solicitacao de devolucao"

pspContraParte
string
obrigatório

ISPB of the counterparty.

Exemplo:

"87654321"

pspCriador
string
obrigatório

ISPB of the infraction creator.

Exemplo:

"12345678"

status
integer<int64>
obrigatório

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

Exemplo:

0

statusDescription
string
obrigatório

Human-readable stRelatoInfracao label.

Exemplo:

"Aberto"

tpSitOrigem
integer<int64>
obrigatório

Situation-origin code (0..5).

Exemplo:

0

tpSitOrigemDescription
string
obrigatório

Human-readable tpSitOrigem label.

Exemplo:

"Golpe/Estelionato"

detalhes
string

Free-text detail to help the recebedor analyse.

Exemplo:

"Suspected scam."

detalhesAnalise
string

Analysis detail.

Exemplo:

"Confirmed."

idMarcacaoFraude
string

Fraud-marker GUID, when analysis produced one.

Exemplo:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

idRecValores
string

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

Exemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

resultadoAnalise
integer<int64>

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

Exemplo:

0

resultadoAnaliseDescription
string

Human-readable infraction analysis-result label.

Exemplo:

"Aceita"

vlrInfracao
integer<int64>

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

Exemplo:

15000