Analyze a MED refund request

curl --request POST \
  --url https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "med-analyze-2024-0001",
  "resultadoAnalise": 0,
  "detalhesAnalise": "Confirmed fraud.",
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "motivoRejeicao": 0,
  "valorDevolvido": 10000
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"med-analyze-2024-0001\",\n  \"resultadoAnalise\": 0,\n  \"detalhesAnalise\": \"Confirmed fraud.\",\n  \"endToEndIdDevolucao\": \"D1234567820240101000000000000099\",\n  \"motivoRejeicao\": 0,\n  \"valorDevolvido\": 10000\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'med-analyze-2024-0001',
    resultadoAnalise: 0,
    detalhesAnalise: 'Confirmed fraud.',
    endToEndIdDevolucao: 'D1234567820240101000000000000099',
    motivoRejeicao: 0,
    valorDevolvido: 10000
  })
};

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

import requests

url = "https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze"

payload = {
    "idempotencyKey": "med-analyze-2024-0001",
    "resultadoAnalise": 0,
    "detalhesAnalise": "Confirmed fraud.",
    "endToEndIdDevolucao": "D1234567820240101000000000000099",
    "motivoRejeicao": 0,
    "valorDevolvido": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "dtHrCriacao": "2024-01-01T12:00:00.000Z",
  "dtHrUltModificacao": "2024-01-01T12:05:00.000Z",
  "endToEndId": "E1234567820240101000000000000001",
  "idSolDevolucao": "d4e5f6a7-b8c9-0123-def4-56789012345a",
  "ispbContestado": "87654321",
  "ispbSolicitante": "12345678",
  "motivo": 1,
  "motivoDescription": "Fraude",
  "status": 0,
  "statusDescription": "Aberta",
  "valorDevolucao": 25000,
  "analysisDeadline": "2024-01-01T18:00:00.000Z",
  "detalhes": "Operational failure.",
  "detalhesAnalise": "Insufficient balance.",
  "dtHrRegistro": "2021-08-06T10:33:08.241Z",
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "idRecValores": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "idRelatoInfracao": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "motivoRejeicao": 0,
  "motivoRejeicaoDescription": "Falta de saldo",
  "resultadoAnalise": 0,
  "resultadoAnaliseDescription": "Aceita Totalmente",
  "valorDevolvido": 25000
}

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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"
  }
}

POST

med

refunds

{idSolDevolucao}

analyze

Analyze a MED refund request

curl --request POST \
  --url https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "med-analyze-2024-0001",
  "resultadoAnalise": 0,
  "detalhesAnalise": "Confirmed fraud.",
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "motivoRejeicao": 0,
  "valorDevolvido": 10000
}
'

package main

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

func main() {

	url := "https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"med-analyze-2024-0001\",\n  \"resultadoAnalise\": 0,\n  \"detalhesAnalise\": \"Confirmed fraud.\",\n  \"endToEndIdDevolucao\": \"D1234567820240101000000000000099\",\n  \"motivoRejeicao\": 0,\n  \"valorDevolvido\": 10000\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'med-analyze-2024-0001',
    resultadoAnalise: 0,
    detalhesAnalise: 'Confirmed fraud.',
    endToEndIdDevolucao: 'D1234567820240101000000000000099',
    motivoRejeicao: 0,
    valorDevolvido: 10000
  })
};

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

import requests

url = "https://api.example.com/v1/med/refunds/{idSolDevolucao}/analyze"

payload = {
    "idempotencyKey": "med-analyze-2024-0001",
    "resultadoAnalise": 0,
    "detalhesAnalise": "Confirmed fraud.",
    "endToEndIdDevolucao": "D1234567820240101000000000000099",
    "motivoRejeicao": 0,
    "valorDevolvido": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "breached": false,
  "dtHrCriacao": "2024-01-01T12:00:00.000Z",
  "dtHrUltModificacao": "2024-01-01T12:05:00.000Z",
  "endToEndId": "E1234567820240101000000000000001",
  "idSolDevolucao": "d4e5f6a7-b8c9-0123-def4-56789012345a",
  "ispbContestado": "87654321",
  "ispbSolicitante": "12345678",
  "motivo": 1,
  "motivoDescription": "Fraude",
  "status": 0,
  "statusDescription": "Aberta",
  "valorDevolucao": 25000,
  "analysisDeadline": "2024-01-01T18:00:00.000Z",
  "detalhes": "Operational failure.",
  "detalhesAnalise": "Insufficient balance.",
  "dtHrRegistro": "2021-08-06T10:33:08.241Z",
  "endToEndIdDevolucao": "D1234567820240101000000000000099",
  "idRecValores": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "idRelatoInfracao": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "motivoRejeicao": 0,
  "motivoRejeicaoDescription": "Falta de saldo",
  "resultadoAnalise": 0,
  "resultadoAnaliseDescription": "Aceita Totalmente",
  "valorDevolvido": 25000
}

{
  "code": "ERR-0001",
  "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": "ERR-0001",
  "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": "ERR-0001",
  "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

idSolDevolucao

string

required

The refund-request GUID.

Example:

"d4e5f6a7-b8c9-0123-def4-56789012345a"

Body

application/json

idempotencyKey

string

required

Client-supplied idempotency key: any stable business string. The plugin projects it deterministically into the GUID form JDPI requires (contract 6), so the same value always dedups against the same JDPI request and the raw value is never sent verbatim.

Example:

"med-analyze-2024-0001"

resultadoAnalise

integer<int64>

required

Analysis result (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada).

Example:

0

detalhesAnalise

string

Analysis detail; required when rejecting with motivoRejeicao=4.

Example:

"Confirmed fraud."

endToEndIdDevolucao

string

pacs.004/008 devolucao id; required when resultadoAnalise is 0 or 1.

Example:

"D1234567820240101000000000000099"

motivoRejeicao

integer<int64>

Rejection reason (0,1,3,4); required when resultadoAnalise=2.

Example:

0

valorDevolvido

integer<int64>

Amount actually refunded, in centavos; required for a partial acceptance.

Example:

10000

Response

breached

boolean

required

True when the analysis deadline has been reached or passed (computed at read time); false when no deadline is set.

Example:

false

dtHrCriacao

string

required

JDPI creation timestamp (RFC 3339 UTC).

Example:

"2024-01-01T12:00:00.000Z"

dtHrUltModificacao

string

required

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

Example:

"2024-01-01T12:05:00.000Z"

endToEndId

string

required

EndToEndId of the contested payment or devolucao.

Example:

"E1234567820240101000000000000001"

idSolDevolucao

string

required

Refund-request GUID (the natural key).

Example:

"d4e5f6a7-b8c9-0123-def4-56789012345a"

ispbContestado

string

required

ISPB of the contested PSP.

Example:

"87654321"

ispbSolicitante

string

required

ISPB of the requesting PSP.

Example:

"12345678"

motivo

integer<int64>

required

Refund motivo code (0=Falha Operacional, 1=Fraude, 3=Pix Automatico).

Example:

1

motivoDescription

string

required

Human-readable refund motivo label.

Example:

"Fraude"

status

integer<int64>

required

stSolDevolucao lifecycle code (0=Aberta, 1=Cancelada, 2=Analisada).

Example:

0

statusDescription

string

required

Human-readable stSolDevolucao label.

Example:

"Aberta"

valorDevolucao

integer<int64>

required

Requested refund amount, in centavos.

Example:

25000

analysisDeadline

string

Contestado-side analysis deadline (RFC 3339 UTC; contract §5, 6h Fraude / 48h otherwise); null for filer-side and terminal requests.

Example:

"2024-01-01T18:00:00.000Z"

detalhes

string

Free-text detail.

Example:

"Operational failure."

detalhesAnalise

string

Analysis detail.

Example:

"Insufficient balance."

dtHrRegistro

string

dtHrRegistro — when the request was REGISTERED in the JDPI base (raw JDPI instant), distinct from dtHrCriacao (the DICT creation instant). Returned by the §8.2.26 JDPI-base read only.

Example:

"2021-08-06T10:33:08.241Z"

endToEndIdDevolucao

string

pacs.004/pacs.008 devolucao reference, recorded at analysis.

Example:

"D1234567820240101000000000000099"

idRecValores

string

Value-recovery GUID, when from a recovery.

Example:

"b2c3d4e5-f6a7-8901-bcde-f23456789012"

idRelatoInfracao

string

Linked infraction GUID, when fraud.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

motivoRejeicao

integer<int64>

Rejection reason (0,1,3,4); present only when the analysis rejected the request.

Example:

0

motivoRejeicaoDescription

string

Human-readable rejection-reason label.

Example:

"Falta de saldo"

resultadoAnalise

integer<int64>

Refund analysis result (0=Aceita Totalmente, 1=Aceita Parcialmente, 2=Rejeitada); null until analysed.

Example:

0

resultadoAnaliseDescription

string

Human-readable refund analysis-result label.

Example:

"Aceita Totalmente"

valorDevolvido

integer<int64>

Amount actually refunded, in centavos; null when absent.

Example:

25000

Key DICT API

Key Claims API

Banks API

Indirect participants API

Transactions API

Transaction Limits API

QR Codes API

Refunds API

Pix Automático · Authorization requests

Pix Automático · Authorization management

Pix Automático · Composite QR codes

Pix Automático · Authorization events

Pix Automático · Schedule events

Pix Automático · Schedules and payment instructions

Pix Automático · Settlement

MED · Refunds

MED · Fraud markers

MED · Infractions

MED · Value recovery

Webhooks API

Error handling

Events

Analyze a MED refund request

Authorizations

Path Parameters

Body

Response