Skip to main content
POST
Cancel a MED infraction

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this write: any stable business string you choose, sent as the X-Idempotency request header - the same header, by the same name, that the Midaz ledger takes, so one integration sends one thing by one name. Send the SAME value again to retry safely: the plugin projects it deterministically into the GUID form JDPI requires (contract 6), so a repeat lands in the same JDPI dedup slot inside JD's 24h window and the operation is applied once. The raw value is never forwarded verbatim, so correlate JDPI-side logs with the projection rather than with what you sent. The header is REQUIRED: omitting it is refused 400 PIX-0061 before any JDPI call. BREAKING CHANGE: this value used to be the body field idempotencyKey, which no longer exists.

Example:

"med-infraction-cancel-2024-0001"

Path Parameters

idRelatoInfracao
string
required

The infraction GUID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

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"

dtHrCriacao
string
required
deprecated

Deprecated: read createdAt, which carries the same value. JDPI creation timestamp (RFC 3339 UTC).

Example:

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

dtHrUltModificacao
string
required
deprecated

Deprecated: read updatedAt, which carries the same value. 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
deprecated

Deprecated: read infractionId, which carries the same value. Infraction GUID (the natural key).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

infractionId
string
required

Infraction GUID (the natural key).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

motivo
integer<int64>
required
deprecated

Deprecated: read reason, which carries the same value. Infraction motivo code (1=Solicitacao de devolucao, 2=Cancelamento da devolucao).

Example:

1

motivoDescription
string
required
deprecated

Deprecated: read reasonDescription, which carries the same value. Human-readable infraction motivo label.

Example:

"Solicitacao de devolucao"

pspContraParte
string
required
deprecated

Deprecated: read counterpartIspb, which carries the same value. ISPB of the counterparty.

Example:

"87654321"

pspCriador
string
required
deprecated

Deprecated: read creatorIspb, which carries the same value. ISPB of the infraction creator.

Example:

"12345678"

reason
integer<int64>
required

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

Example:

1

reasonDescription
string
required

Human-readable infraction motivo label.

Example:

"Solicitacao de devolucao"

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 recebedor analyse.

Example:

"Suspected scam."

detalhes
string
deprecated

Deprecated: read details, which carries the same value. Free-text detail to help the recebedor analyse.

Example:

"Suspected scam."

detalhesAnalise
string
deprecated

Deprecated: read analysisDetails, which carries the same value. Analysis detail.

Example:

"Confirmed."

fraudMarkerId
string

Fraud-marker GUID, when analysis produced one.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

idMarcacaoFraude
string
deprecated

Deprecated: read fraudMarkerId, which carries the same value. Fraud-marker GUID, when analysis produced one.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

idRecValores
string
deprecated

Deprecated: read recoveryId, which carries the same value. Value-recovery GUID, when the infraction came from a recovery.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

recoveryId
string

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

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

resultadoAnalise
integer<int64>
deprecated

Deprecated: read analysisResult, which carries the same value. Infraction analysis result (0=Aceita, 1=Rejeitada); null until analysed.

Example:

0

resultadoAnaliseDescription
string
deprecated

Deprecated: read analysisResultDescription, which carries the same value. Human-readable infraction analysis-result label.

Example:

"Aceita"

vlrInfracao
integer<int64>

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

Example:

15000