Create a MED value recovery

curl --request POST \
  --url https://api.example.com/v1/med/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contatoEmail": "ops@example.com",
  "contatoTelefone": "+5511999999999",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "idempotencyKey": "med-recovery-2024-0001",
  "tpSituacao": 0,
  "detalhes": "Suspected scam."
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/recoveries"

	payload := strings.NewReader("{\n  \"contatoEmail\": \"ops@example.com\",\n  \"contatoTelefone\": \"+5511999999999\",\n  \"idTransacaoRaiz\": \"E1234567820240101000000000000001\",\n  \"idempotencyKey\": \"med-recovery-2024-0001\",\n  \"tpSituacao\": 0,\n  \"detalhes\": \"Suspected scam.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contatoEmail: 'ops@example.com',
    contatoTelefone: '+5511999999999',
    idTransacaoRaiz: 'E1234567820240101000000000000001',
    idempotencyKey: 'med-recovery-2024-0001',
    tpSituacao: 0,
    detalhes: 'Suspected scam.'
  })
};

fetch('https://api.example.com/v1/med/recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/recoveries"

payload = {
    "contatoEmail": "ops@example.com",
    "contatoTelefone": "+5511999999999",
    "idTransacaoRaiz": "E1234567820240101000000000000001",
    "idempotencyKey": "med-recovery-2024-0001",
    "tpSituacao": 0,
    "detalhes": "Suspected scam."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "breached": false,
  "contatoEmail": "ops@example.com",
  "contatoTelefone": "+5511999999999",
  "dtHrCriacao": "2024-01-01T12:00:00.000Z",
  "dtHrUltModificacao": "2024-01-01T12:05:00.000Z",
  "idRecValores": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "pspCriador": "12345678",
  "status": 0,
  "statusDescription": "Criada",
  "tpSituacao": 0,
  "tpSituacaoDescription": "Golpe/Estelionato",
  "detalhes": "Suspected scam.",
  "devolverDeadline": "2024-01-04T12:00:00.000Z",
  "dictCorrelationId": "a9f13566e19f5ca51329479a5bae60c5",
  "dictReturnedAt": "2025-08-27T10:30:05.025Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

med

recoveries

Create a MED value recovery

curl --request POST \
  --url https://api.example.com/v1/med/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contatoEmail": "ops@example.com",
  "contatoTelefone": "+5511999999999",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "idempotencyKey": "med-recovery-2024-0001",
  "tpSituacao": 0,
  "detalhes": "Suspected scam."
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/med/recoveries"

	payload := strings.NewReader("{\n  \"contatoEmail\": \"ops@example.com\",\n  \"contatoTelefone\": \"+5511999999999\",\n  \"idTransacaoRaiz\": \"E1234567820240101000000000000001\",\n  \"idempotencyKey\": \"med-recovery-2024-0001\",\n  \"tpSituacao\": 0,\n  \"detalhes\": \"Suspected scam.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contatoEmail: 'ops@example.com',
    contatoTelefone: '+5511999999999',
    idTransacaoRaiz: 'E1234567820240101000000000000001',
    idempotencyKey: 'med-recovery-2024-0001',
    tpSituacao: 0,
    detalhes: 'Suspected scam.'
  })
};

fetch('https://api.example.com/v1/med/recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/med/recoveries"

payload = {
    "contatoEmail": "ops@example.com",
    "contatoTelefone": "+5511999999999",
    "idTransacaoRaiz": "E1234567820240101000000000000001",
    "idempotencyKey": "med-recovery-2024-0001",
    "tpSituacao": 0,
    "detalhes": "Suspected scam."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "breached": false,
  "contatoEmail": "ops@example.com",
  "contatoTelefone": "+5511999999999",
  "dtHrCriacao": "2024-01-01T12:00:00.000Z",
  "dtHrUltModificacao": "2024-01-01T12:05:00.000Z",
  "idRecValores": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "pspCriador": "12345678",
  "status": 0,
  "statusDescription": "Criada",
  "tpSituacao": 0,
  "tpSituacaoDescription": "Golpe/Estelionato",
  "detalhes": "Suspected scam.",
  "devolverDeadline": "2024-01-04T12:00:00.000Z",
  "dictCorrelationId": "a9f13566e19f5ca51329479a5bae60c5",
  "dictReturnedAt": "2025-08-27T10:30:05.025Z"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

contatoEmail

string

required

Creator-contact email (required).

Example:

"ops@example.com"

contatoTelefone

string

required

Creator-contact phone (required).

Example:

"+5511999999999"

idTransacaoRaiz

string

required

EndToEndId of the root transaction being recovered.

Example:

"E1234567820240101000000000000001"

idempotencyKey

string

required

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.

Example:

"med-recovery-2024-0001"

tpSituacao

integer<int64>

required

Situation code (0=Golpe, 1=Nao autorizada, 2=Coercao, 3=Acesso fraudulento, 4=Outros, 5=Desconhecida).

Example:

0

detalhes

string

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

Example:

"Suspected scam."

grafoRastreamento

object

Optional graph-traversal FILTER parameters; omit to use JDPI defaults.

Show child attributes

Response

Accepted

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"

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Create a MED value recovery

Authorizations

Body

Response