Skip to main content
POST
Cancel a MED fraud marker

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-fraud-cancel-2024-0001"

Path Parameters

idMarcacaoFraude
string
required

The fraud-marker GUID.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

Body

application/json
ispb
string

The ISPB of the direct participant this operation acts as. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own JDPI credential - and this field is the only thing on the request that says which of them acts. OPTIONAL while it acts as a single participant: omit it and that one acts. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. It also selects the JDPI channel the call goes out on, so a MED write made under the wrong one reaches a JD that has never heard of this institution. Send it as an absent key, not an empty string; an empty value is refused 400 PIX-0061.

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

"12345678"

Response

OK

cpfCnpj
string
required
deprecated

Deprecated: read taxId, which carries the same value. The flagged document.

Example:

"12345678901"

createdAt
string
required

JDPI creation timestamp (RFC 3339 UTC).

Example:

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

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 watermark.

Example:

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

fraudMarkerId
string
required

Fraud-marker GUID (the natural key).

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

idMarcacaoFraude
string
required
deprecated

Deprecated: read fraudMarkerId, which carries the same value. Fraud-marker GUID (the natural key).

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

ispb
string
required

ISPB of the creator PSP.

Example:

"12345678"

status
integer<int64>
required

stMarcacaoFraude lifecycle code (0=Registrada, 1=Cancelada).

Example:

0

statusDescription
string
required

Human-readable stMarcacaoFraude label.

Example:

"Registrada"

taxId
string
required

The flagged document.

Example:

"12345678901"

tpFraude
integer<int64>
required

Fraud-type code (0..4; 4=Desconhecida is read-only).

Example:

1

tpFraudeDescription
string
required

Human-readable tpFraude label.

Example:

"Conta laranja"

tpPessoa
integer<int64>
required

Person-type code (0=Pessoa Fisica, 1=Pessoa Juridica).

Example:

0

tpPessoaDescription
string
required

Human-readable tpPessoa label.

Example:

"Pessoa Fisica"

updatedAt
string
required

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

Example:

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

chave
string
deprecated

Deprecated: read key, which carries the same value. The flagged Pix key, when known.

Example:

"user@example.com"

dictCorrelationId
string

idCorrelacao — the DICT support identifier for this consultar call; quote it to JD when disputing whether the read happened.

Example:

"a7f12465e19f5ca51329479a5bae60c2"

dictReturnedAt
string

dtHrRetornoDict — when DICT answered this consultar (contract 2.16).

Example:

"2023-08-16T10:30:05.025Z"

idRelatoInfracao
string
deprecated

Deprecated: read infractionId, which carries the same value. Linked infraction GUID, when the marker was auto-created from a closed infraction.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

infractionId
string

Linked infraction GUID, when the marker was auto-created from a closed infraction.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

infractionIspb
string

Linked infraction's PSP ISPB, when infraction-originated.

Example:

"87654321"

ispbRelatoInfracao
string
deprecated

Deprecated: read infractionIspb, which carries the same value. Linked infraction's PSP ISPB, when infraction-originated.

Example:

"87654321"

key
string

The flagged Pix key, when known.

Example:

"user@example.com"