Skip to main content
PUT
Amend a MED value recovery

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

idRecValores
string
requerido

The value-recovery GUID.

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

Cuerpo

application/json
idempotencyKey
string
requerido

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.

Ejemplo:

"med-amend-2024-0001"

tpSituacao
integer<int64>
requerido

New situation code (0..5).

Ejemplo:

4

contatoEmail
string

New creator-contact email.

Ejemplo:

"ops@example.com"

contatoTelefone
string

New creator-contact phone.

Ejemplo:

"+5511999999999"

detalhes
string

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

Ejemplo:

"Updated detail."

Respuesta

OK

breached
boolean
requerido

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

Ejemplo:

false

contatoEmail
string
requerido

Creator-contact email.

Ejemplo:

"ops@example.com"

contatoTelefone
string
requerido

Creator-contact phone.

Ejemplo:

"+5511999999999"

dtHrCriacao
string
requerido

JDPI creation timestamp (RFC 3339 UTC).

Ejemplo:

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

dtHrUltModificacao
string
requerido

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

Ejemplo:

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

idRecValores
string
requerido

Value-recovery GUID (the natural key).

Ejemplo:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

idTransacaoRaiz
string
requerido

EndToEndId of the root transaction being recovered.

Ejemplo:

"E1234567820240101000000000000001"

pspCriador
string
requerido

ISPB of the recovery creator.

Ejemplo:

"12345678"

status
integer<int64>
requerido

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

Ejemplo:

0

statusDescription
string
requerido

Human-readable stRecValores label.

Ejemplo:

"Criada"

tpSituacao
integer<int64>
requerido

Situation code (0..5).

Ejemplo:

0

tpSituacaoDescription
string
requerido

Human-readable tpSituacao label.

Ejemplo:

"Golpe/Estelionato"

detalhes
string

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

"a9f13566e19f5ca51329479a5bae60c5"

dictReturnedAt
string

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

Ejemplo:

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