List MED refund requests
curl --request GET \
--url https://api.example.com/v1/med/refunds \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/med/refunds"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/med/refunds', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"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"
}
}List MED refund requests
Lists the refund requests detected by the worker pollers (requested by this institution or against it), filterable by status, role ISPB, and the contested payment’s endToEndId. Read projection — no JDPI round-trip.
GET
/
v1
/
med
/
refunds
List MED refund requests
curl --request GET \
--url https://api.example.com/v1/med/refunds \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/med/refunds"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/med/refunds', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"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
JWT bearer token issued by the identity provider.
Query Parameters
Filter on stSolDevolucao (0=Aberta, 1=Cancelada, 2=Analisada).
Example:
"0"
Filter on the contested ISPB (refunds requested against this institution).
Example:
"87654321"
Filter on the requester ISPB (refunds this institution requested).
Example:
"12345678"
Filter on the contested payment's endToEndId.
Example:
"E1234567820240101000000000000001"
Response
OK
The list of detected refund requests, newest first.
Show child attributes
Show child attributes
Was this page helpful?

