Skip to main content
PUT
Amend a MED value recovery

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-amend-2024-0001"

Path Parameters

idRecValores
string
required

The value-recovery GUID.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

Body

application/json
tpSituacao
integer<int64>
required

New situation code (0..5).

Example:

4

contatoEmail
string

New creator-contact email.

Example:

"ops@example.com"

contatoTelefone
string

New creator-contact phone.

Example:

"+5511999999999"

detalhes
string

New free-text detail; required when tpSituacao=4 (Outros).

Example:

"Updated detail."

Response

OK

breached
boolean
required

True when the devolver deadline has been reached or passed (computed at read time); false when no deadline is set.

Example:

false

contatoEmail
string
required

Creator-contact email.

Example:

"ops@example.com"

contatoTelefone
string
required

Creator-contact phone.

Example:

"+5511999999999"

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

Example:

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

idRecValores
string
required

Value-recovery GUID (the natural key).

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

idTransacaoRaiz
string
required

EndToEndId of the root transaction being recovered.

Example:

"E1234567820240101000000000000001"

pspCriador
string
required

ISPB of the recovery creator.

Example:

"12345678"

status
integer<int64>
required

stRecValores lifecycle code (0=Criada .. 6=Cancelada).

Example:

0

statusDescription
string
required

Human-readable stRecValores label.

Example:

"Criada"

tpSituacao
integer<int64>
required

Situation code (0..5).

Example:

0

tpSituacaoDescription
string
required

Human-readable tpSituacao label.

Example:

"Golpe/Estelionato"

detalhes
string

Free-text detail (required when tpSituacao=4 Outros).

Example:

"Suspected scam."

devolverDeadline
string

Creator-side 72h devolver deadline (RFC 3339 UTC; contract §2.22/§5), from the Analise stage close; null unless this institution is the pspCriador on an Analisada recovery.

Example:

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

dictCorrelationId
string

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

Example:

"a9f13566e19f5ca51329479a5bae60c5"

dictReturnedAt
string

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

Example:

"2025-08-27T10:30:05.025Z"