Create a MED value recovery

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/med/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contatoEmail": "<string>",
  "contatoTelefone": "<string>",
  "idTransacaoRaiz": "<string>",
  "idempotencyKey": "<string>",
  "tpSituacao": 123,
  "detalhes": "<string>"
}
'

import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries"

payload = {
    "contatoEmail": "<string>",
    "contatoTelefone": "<string>",
    "idTransacaoRaiz": "<string>",
    "idempotencyKey": "<string>",
    "tpSituacao": 123,
    "detalhes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contatoEmail: '<string>',
    contatoTelefone: '<string>',
    idTransacaoRaiz: '<string>',
    idempotencyKey: '<string>',
    tpSituacao: 123,
    detalhes: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/med/recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contatoEmail' => '<string>',
    'contatoTelefone' => '<string>',
    'idTransacaoRaiz' => '<string>',
    'idempotencyKey' => '<string>',
    'tpSituacao' => 123,
    'detalhes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries"

	payload := strings.NewReader("{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/med/recoveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/med/recoveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "breached": true,
  "contatoEmail": "<string>",
  "contatoTelefone": "<string>",
  "dtHrCriacao": "<string>",
  "dtHrUltModificacao": "<string>",
  "idRecValores": "<string>",
  "idTransacaoRaiz": "<string>",
  "pspCriador": "<string>",
  "status": 123,
  "statusDescription": "<string>",
  "tpSituacao": 123,
  "tpSituacaoDescription": "<string>",
  "detalhes": "<string>",
  "devolverDeadline": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

med

recoveries

Create a MED value recovery

curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/med/recoveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contatoEmail": "<string>",
  "contatoTelefone": "<string>",
  "idTransacaoRaiz": "<string>",
  "idempotencyKey": "<string>",
  "tpSituacao": 123,
  "detalhes": "<string>"
}
'

import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries"

payload = {
    "contatoEmail": "<string>",
    "contatoTelefone": "<string>",
    "idTransacaoRaiz": "<string>",
    "idempotencyKey": "<string>",
    "tpSituacao": 123,
    "detalhes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contatoEmail: '<string>',
    contatoTelefone: '<string>',
    idTransacaoRaiz: '<string>',
    idempotencyKey: '<string>',
    tpSituacao: 123,
    detalhes: '<string>'
  })
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/med/recoveries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contatoEmail' => '<string>',
    'contatoTelefone' => '<string>',
    'idTransacaoRaiz' => '<string>',
    'idempotencyKey' => '<string>',
    'tpSituacao' => 123,
    'detalhes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://plugin-pix-direct.api.lerian.net/v1/med/recoveries"

	payload := strings.NewReader("{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://plugin-pix-direct.api.lerian.net/v1/med/recoveries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/med/recoveries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contatoEmail\": \"<string>\",\n  \"contatoTelefone\": \"<string>\",\n  \"idTransacaoRaiz\": \"<string>\",\n  \"idempotencyKey\": \"<string>\",\n  \"tpSituacao\": 123,\n  \"detalhes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "breached": true,
  "contatoEmail": "<string>",
  "contatoTelefone": "<string>",
  "dtHrCriacao": "<string>",
  "dtHrUltModificacao": "<string>",
  "idRecValores": "<string>",
  "idTransacaoRaiz": "<string>",
  "pspCriador": "<string>",
  "status": 123,
  "statusDescription": "<string>",
  "tpSituacao": 123,
  "tpSituacaoDescription": "<string>",
  "detalhes": "<string>",
  "devolverDeadline": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization

string

header

required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Body

application/json

contatoEmail

string

required

Creator-contact email (required).

contatoTelefone

string

required

Creator-contact phone (required).

idTransacaoRaiz

string

required

EndToEndId of the root transaction being recovered.

idempotencyKey

string

required

Business-derived idempotency key (Chave-Idempotencia).

tpSituacao

integer<int64>

required

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

detalhes

string

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

grafoRastreamento

object

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.

contatoEmail

string

required

Creator-contact email.

contatoTelefone

string

required

Creator-contact phone.

dtHrCriacao

string

required

Upstream creation timestamp (RFC 3339 UTC).

dtHrUltModificacao

string

required

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

idRecValores

string

required

Value-recovery GUID (the natural key).

idTransacaoRaiz

string

required

EndToEndId of the root transaction being recovered.

pspCriador

string

required

ISPB of the recovery creator.

status

integer<int64>

required

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

statusDescription

string

required

Human-readable stRecValores label.

tpSituacao

integer<int64>

required

Situation code (0..5).

tpSituacaoDescription

string

required

Human-readable tpSituacao label.

detalhes

string

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

devolverDeadline

string

Creator-side 72h devolver deadline, from the Analise stage close; null unless this institution is the pspCriador on an Analisada recovery.

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado (native messaging)

Create a MED value recovery

Authorizations

Body

Response