Pular para o conteúdo principal
POST
/
v1
/
med
/
refunds
/
{idSolDevolucao}
/
analyze
Analisar solicitação de devolução 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"
}

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).

Parâmetros de caminho

idSolDevolucao
string
obrigatório

O GUID da solicitação de devolução.

Corpo

application/json
idempotencyKey
string
obrigatório

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

resultadoAnalise
integer<int64>
obrigatório

Resultado da análise (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada).

detalhesAnalise
string

Detalhe da análise; obrigatório ao rejeitar com motivoRejeicao=4.

endToEndIdDevolucao
string

id da devolução pacs.004/008; obrigatório quando resultadoAnalise é 0 ou 1.

motivoRejeicao
integer<int64>

Motivo de rejeição (0,1,3,4); obrigatório quando resultadoAnalise=2.

valorDevolvidoCents
integer<int64>

Valor efetivamente devolvido, em centavos; obrigatório para um aceite parcial.

Resposta

OK

breached
boolean
obrigatório

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

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 do poll.

endToEndId
string
obrigatório

EndToEndId do pagamento contestado ou devolução.

idSolDevolucao
string
obrigatório

GUID da solicitação de devolução (a chave natural).

ispbContestado
string
obrigatório

ISPB do PSP contestado.

ispbSolicitante
string
obrigatório

ISPB do PSP solicitante.

motivo
integer<int64>
obrigatório

Código de motivo da devolução (0=Falha Operacional, 1=Fraude, 3=Pix Automático).

motivoDescription
string
obrigatório

Rótulo legível do motivo da devolução.

status
integer<int64>
obrigatório

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

statusDescription
string
obrigatório

Rótulo legível de stSolDevolucao.

valorDevolucaoCents
integer<int64>
obrigatório

Valor de devolução solicitado, em centavos.

analysisDeadline
string

Prazo de análise do lado contestado; nulo para o lado do solicitante e para requisições terminais.

detalhes
string

Detalhe em texto livre.

detalhesAnalise
string

Detalhe da análise.

endToEndIdDevolucao
string

referência da devolução pacs.004/pacs.008, registrada na análise.

idRecValores
string

GUID da recuperação de valores, quando a partir de uma recuperação.

idRelatoInfracao
string

GUID da infração vinculada, quando fraude.

motivoRejeicao
integer<int64>

Motivo de rejeição (0,1,3,4); presente somente quando a análise rejeitou a requisição.

motivoRejeicaoDescription
string

Rótulo legível do motivo de rejeição.

resultadoAnalise
integer<int64>

Resultado de análise da devolução (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada); nulo até ser analisada.

resultadoAnaliseDescription
string

Rótulo legível do resultado de análise da devolução.

valorDevolvidoCents
integer<int64>

Valor efetivamente devolvido, em centavos; nulo quando ausente.