Saltar al contenido principal
POST
/
v1
/
med
/
refunds
/
{idSolDevolucao}
/
analyze
Analizar una solicitud de devolución MED
curl --request POST \
  --url https://plugin-pix-direct.api.lerian.net/v1/med/refunds/{idSolDevolucao}/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "resultadoAnalise": 123,
  "detalhesAnalise": "<string>",
  "endToEndIdDevolucao": "<string>",
  "motivoRejeicao": 123,
  "valorDevolvidoCents": 123
}
'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/med/refunds/{idSolDevolucao}/analyze"

payload = {
"idempotencyKey": "<string>",
"resultadoAnalise": 123,
"detalhesAnalise": "<string>",
"endToEndIdDevolucao": "<string>",
"motivoRejeicao": 123,
"valorDevolvidoCents": 123
}
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({
idempotencyKey: '<string>',
resultadoAnalise: 123,
detalhesAnalise: '<string>',
endToEndIdDevolucao: '<string>',
motivoRejeicao: 123,
valorDevolvidoCents: 123
})
};

fetch('https://plugin-pix-direct.api.lerian.net/v1/med/refunds/{idSolDevolucao}/analyze', 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/refunds/{idSolDevolucao}/analyze",
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([
'idempotencyKey' => '<string>',
'resultadoAnalise' => 123,
'detalhesAnalise' => '<string>',
'endToEndIdDevolucao' => '<string>',
'motivoRejeicao' => 123,
'valorDevolvidoCents' => 123
]),
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/refunds/{idSolDevolucao}/analyze"

payload := strings.NewReader("{\n \"idempotencyKey\": \"<string>\",\n \"resultadoAnalise\": 123,\n \"detalhesAnalise\": \"<string>\",\n \"endToEndIdDevolucao\": \"<string>\",\n \"motivoRejeicao\": 123,\n \"valorDevolvidoCents\": 123\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/refunds/{idSolDevolucao}/analyze")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotencyKey\": \"<string>\",\n \"resultadoAnalise\": 123,\n \"detalhesAnalise\": \"<string>\",\n \"endToEndIdDevolucao\": \"<string>\",\n \"motivoRejeicao\": 123,\n \"valorDevolvidoCents\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/med/refunds/{idSolDevolucao}/analyze")

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 \"idempotencyKey\": \"<string>\",\n \"resultadoAnalise\": 123,\n \"detalhesAnalise\": \"<string>\",\n \"endToEndIdDevolucao\": \"<string>\",\n \"motivoRejeicao\": 123,\n \"valorDevolvidoCents\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "breached": true,
  "dtHrCriacao": "<string>",
  "dtHrUltModificacao": "<string>",
  "endToEndId": "<string>",
  "idSolDevolucao": "<string>",
  "ispbContestado": "<string>",
  "ispbSolicitante": "<string>",
  "motivo": 123,
  "motivoDescription": "<string>",
  "status": 123,
  "statusDescription": "<string>",
  "valorDevolucaoCents": 123,
  "analysisDeadline": "<string>",
  "detalhes": "<string>",
  "detalhesAnalise": "<string>",
  "endToEndIdDevolucao": "<string>",
  "idRecValores": "<string>",
  "idRelatoInfracao": "<string>",
  "motivoRejeicao": 123,
  "motivoRejeicaoDescription": "<string>",
  "resultadoAnalise": 123,
  "resultadoAnaliseDescription": "<string>",
  "valorDevolvidoCents": 123
}
{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de ruta

idSolDevolucao
string
requerido

The refund-request GUID. El GUID de la solicitud de devolución.

Cuerpo

application/json
idempotencyKey
string
requerido

Clave de idempotencia derivada del negocio (Chave-Idempotencia).

resultadoAnalise
integer<int64>
requerido

Resultado del análisis (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada).

detalhesAnalise
string

Detalle del análisis; obligatorio al rechazar con motivoRejeicao=4.

endToEndIdDevolucao
string

Id de devolucao pacs.004/008; obligatorio cuando resultadoAnalise es 0 o 1.

motivoRejeicao
integer<int64>

Motivo de rechazo (0,1,3,4); obligatorio cuando resultadoAnalise=2.

valorDevolvidoCents
integer<int64>

Monto realmente devuelto, en centavos; obligatorio para una aceptación parcial.

Respuesta

OK

breached
boolean
requerido

True cuando el plazo de análisis se ha alcanzado o superado (calculado en el momento de la lectura); false cuando no hay plazo definido.

dtHrCriacao
string
requerido

Marca de tiempo de creación en el upstream (RFC 3339 UTC).

dtHrUltModificacao
string
requerido

Marca de tiempo de la última modificación en el upstream (RFC 3339 UTC): la marca de agua del sondeo.

endToEndId
string
requerido

EndToEndId del pago contestado o de la devolucao.

idSolDevolucao
string
requerido

GUID de la solicitud de devolución (la clave natural).

ispbContestado
string
requerido

ISPB del PSP contestado.

ispbSolicitante
string
requerido

ISPB del PSP solicitante.

motivo
integer<int64>
requerido

Código de motivo de la devolución (0=Falha Operacional, 1=Fraude, 3=Pix Automático).

motivoDescription
string
requerido

Etiqueta legible para humanos del motivo de la devolución.

status
integer<int64>
requerido

Código de ciclo de vida stSolDevolucao (0=Aberta, 1=Cancelada, 2=Analisada).

statusDescription
string
requerido

Etiqueta legible para humanos de stSolDevolucao.

valorDevolucaoCents
integer<int64>
requerido

Monto de devolución solicitado, en centavos.

analysisDeadline
string

Plazo de análisis del lado contestado; null para solicitudes del lado del emisor y terminales.

detalhes
string

Detalle de texto libre.

detalhesAnalise
string

Detalle del análisis.

endToEndIdDevolucao
string

Referencia de devolucao pacs.004/pacs.008, registrada en el análisis.

idRecValores
string

GUID de la recuperación de valores, cuando proviene de una recuperación.

idRelatoInfracao
string

GUID de la infracción vinculada, cuando hay fraude.

motivoRejeicao
integer<int64>

Motivo de rechazo (0,1,3,4); presente solo cuando el análisis rechazó la solicitud.

motivoRejeicaoDescription
string

Etiqueta legible para humanos del motivo de rechazo.

resultadoAnalise
integer<int64>

Resultado del análisis de la devolución (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada); null hasta que se analice.

resultadoAnaliseDescription
string

Etiqueta legible para humanos del resultado del análisis de la devolución.

valorDevolvidoCents
integer<int64>

Monto realmente devuelto, en centavos; null cuando está ausente.