Pular para o conteúdo principal
POST
/
v1
/
med
/
recoveries
Criar recuperação de valores MED
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"
}

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Corpo

application/json
contatoEmail
string
obrigatório

E-mail de contato do criador (obrigatório).

contatoTelefone
string
obrigatório

Telefone de contato do criador (obrigatório).

idTransacaoRaiz
string
obrigatório

EndToEndId da transação raiz sendo recuperada.

idempotencyKey
string
obrigatório

Chave de idempotência derivada do negócio (Chave-Idempotencia).

tpSituacao
integer<int64>
obrigatório

Código de situação (0=Golpe, 1=Nao autorizada, 2=Coercao, 3=Acesso fraudulento, 4=Outros, 5=Desconhecida).

detalhes
string

Detalhe em texto livre; obrigatório quando tpSituacao=4 (Outros).

grafoRastreamento
object

Resposta

Aceito

breached
boolean
obrigatório

True quando o prazo de devolver foi atingido ou ultrapassado (computado no momento da leitura); false quando nenhum prazo está definido.

contatoEmail
string
obrigatório

E-mail de contato do criador.

contatoTelefone
string
obrigatório

Telefone de contato do criador.

dtHrCriacao
string
obrigatório

Data/hora de criação no upstream (RFC 3339 UTC).

dtHrUltModificacao
string
obrigatório

Data/hora da última modificação no upstream (RFC 3339 UTC) — o watermark.

idRecValores
string
obrigatório

GUID da recuperação de valores (a chave natural).

idTransacaoRaiz
string
obrigatório

EndToEndId da transação raiz sendo recuperada.

pspCriador
string
obrigatório

ISPB do criador da recuperação.

status
integer<int64>
obrigatório

código de ciclo de vida stRecValores (0=Criada.. 6=Cancelada).

statusDescription
string
obrigatório

Rótulo legível de stRecValores.

tpSituacao
integer<int64>
obrigatório

Código de situação (0..5).

tpSituacaoDescription
string
obrigatório

Rótulo legível de tpSituacao.

detalhes
string

Detalhe em texto livre (obrigatório quando tpSituacao=4 Outros).

devolverDeadline
string

Prazo de 72h do lado do criador para devolver, a partir do encerramento da etapa de Analise; nulo a menos que esta instituição seja o pspCriador em uma recuperação Analisada.