Get a MED value recovery

curl --request GET \
  --url https://api.example.com/v1/med/recoveries/{idRecValores} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

{
  "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"
  }
}

Get a MED value recovery

Returns a single value recovery by its idRecValores GUID, read live from JDPI (contract 2.21). An unknown id returns a coded 404. Optional ispb names the direct participant the request acts for: named, the record has to be one that participant is a party to, or the answer is 404 PIX-0147 before anything is read from JDPI or changed; an ISPB this deployment does not act as is 422 PIX-0128 before any record is read; a token confined to one participant has to name it. Optional indirectId names the registered indirect participant the request acts for: named, the value recovery has to be over a root payment this deployment recorded for that indirect — the rule GET /v1/med/recoveries/awaiting-return?indirectId= lists by — or the answer is 404 PIX-0147 before anything is read from JDPI or changed; a token confined to one indirect has to name it; a malformed indirectId is 400 PIX-0061.

GET

med

recoveries

{idRecValores}

Get a MED value recovery

curl --request GET \
  --url https://api.example.com/v1/med/recoveries/{idRecValores} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

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

Path Parameters

idRecValores

string

required

The value-recovery GUID.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

Query Parameters

ispb

string

The ISPB of the direct participant this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the record has to be one that participant is a party to - either side of a dispute, the creator of a value recovery, the participant a refund credit was booked for - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed. A record this deployment does not hold is 404 PIX-0147 too when an ispb is named. An ISPB this deployment does not act as is 422 PIX-0128, before any record is read. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

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

Example:

"12345678"

indirectId

string<uuid>

The registered indirect participant (UUID) this request acts for. OPTIONAL: omit it and the request is answered exactly as before. Named, the value recovery has to be over a root payment this deployment recorded for that indirect - the rule GET /v1/med/recoveries/awaiting-return?indirectId= lists by - or the answer is 404 PIX-0147 and nothing is read from JDPI or changed; a record this deployment does not hold is 404 PIX-0147 too when an indirectId is named. It is ROUTING DATA you supply, never a credential, and a token confined to one indirect has to name it here. Not a valid UUID is 400 PIX-0061. Sending it empty (indirectId=) reads the same as omitting it.

Example:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Response

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

Get a MED value recovery

Authorizations

Path Parameters

Query Parameters

Response