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' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "ops@example.com",
  "contactPhone": "+5511999999999",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "situationType": 0,
  "details": "Suspected scam.",
  "ispb": "12345678"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"contactEmail\": \"ops@example.com\",\n  \"contactPhone\": \"+5511999999999\",\n  \"idTransacaoRaiz\": \"E1234567820240101000000000000001\",\n  \"situationType\": 0,\n  \"details\": \"Suspected scam.\",\n  \"ispb\": \"12345678\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'ops@example.com',
    contactPhone: '+5511999999999',
    idTransacaoRaiz: 'E1234567820240101000000000000001',
    situationType: 0,
    details: 'Suspected scam.',
    ispb: '12345678'
  })
};

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 = {
    "contactEmail": "ops@example.com",
    "contactPhone": "+5511999999999",
    "idTransacaoRaiz": "E1234567820240101000000000000001",
    "situationType": 0,
    "details": "Suspected scam.",
    "ispb": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "contactEmail": "ops@example.com",
  "contactPhone": "+5511999999999",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "creatorIspb": "12345678",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "situationType": 0,
  "situationTypeDescription": "Golpe/Estelionato",
  "status": 0,
  "statusDescription": "Criada",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "details": "Suspected scam.",
  "dictCorrelationId": "a9f13566e19f5ca51329479a5bae60c5",
  "dictReturnedAt": "2025-08-27T10:30:05.025Z",
  "returnDeadline": "2024-01-04T12:00:00.000Z"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "contactEmail": "ops@example.com",
  "contactPhone": "+5511999999999",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "situationType": 0,
  "details": "Suspected scam.",
  "ispb": "12345678"
}
'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"contactEmail\": \"ops@example.com\",\n  \"contactPhone\": \"+5511999999999\",\n  \"idTransacaoRaiz\": \"E1234567820240101000000000000001\",\n  \"situationType\": 0,\n  \"details\": \"Suspected scam.\",\n  \"ispb\": \"12345678\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactEmail: 'ops@example.com',
    contactPhone: '+5511999999999',
    idTransacaoRaiz: 'E1234567820240101000000000000001',
    situationType: 0,
    details: 'Suspected scam.',
    ispb: '12345678'
  })
};

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 = {
    "contactEmail": "ops@example.com",
    "contactPhone": "+5511999999999",
    "idTransacaoRaiz": "E1234567820240101000000000000001",
    "situationType": 0,
    "details": "Suspected scam.",
    "ispb": "12345678"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "contactEmail": "ops@example.com",
  "contactPhone": "+5511999999999",
  "createdAt": "2024-01-01T12:00:00.000Z",
  "creatorIspb": "12345678",
  "idTransacaoRaiz": "E1234567820240101000000000000001",
  "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "situationType": 0,
  "situationTypeDescription": "Golpe/Estelionato",
  "status": 0,
  "statusDescription": "Criada",
  "updatedAt": "2024-01-01T12:05:00.000Z",
  "details": "Suspected scam.",
  "dictCorrelationId": "a9f13566e19f5ca51329479a5bae60c5",
  "dictReturnedAt": "2025-08-27T10:30:05.025Z",
  "returnDeadline": "2024-01-04T12:00:00.000Z"
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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.

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

Body

application/json

contactEmail

string

required

Creator-contact email (required).

Example:

"ops@example.com"

contactPhone

string

required

Creator-contact phone (required).

Example:

"+5511999999999"

idTransacaoRaiz

string

required

EndToEndId of the root transaction being recovered.

Example:

"E1234567820240101000000000000001"

situationType

integer<int64>

required

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

Example:

0

details

string

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

Example:

"Suspected scam."

grafoRastreamento

object

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

Show child attributes

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

Accepted

breached

boolean

required

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

Example:

false

contactEmail

string

required

Creator-contact email.

Example:

"ops@example.com"

contactPhone

string

required

Creator-contact phone.

Example:

"+5511999999999"

createdAt

string

required

JDPI creation timestamp (RFC 3339 UTC).

Example:

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

creatorIspb

string

required

ISPB of the recovery creator.

Example:

"12345678"

idTransacaoRaiz

string

required

EndToEndId of the root transaction being recovered.

Example:

"E1234567820240101000000000000001"

recoveryId

string

required

Value-recovery GUID (the natural key).

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

situationType

integer<int64>

required

Situation code (0..5).

Example:

0

situationTypeDescription

string

required

Human-readable situationType label.

Example:

"Golpe/Estelionato"

status

integer<int64>

required

stRecValores lifecycle code (0=created .. 6=cancelled).

Example:

0

statusDescription

string

required

Human-readable stRecValores label.

Example:

"Criada"

updatedAt

string

required

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

Example:

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

details

string

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

Example:

"Suspected scam."

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"

returnDeadline

string

Creator-side 72h return deadline (RFC 3339 UTC; contract §2.22/§5), from the analysis stage close; null unless this institution is the creatorIspb on an analyzed recovery.

Example:

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

Direct participant APIs

Indirect participant APIs

Create a MED value recovery

Authorizations

Headers

Body

Response