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

{
  "data": [
    {
      "breached": false,
      "contestedIspb": "87654321",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "endToEndId": "E1234567820240101000000000000001",
      "reason": 1,
      "reasonDescription": "Fraude",
      "refundAmount": 25000,
      "refundRequestId": "d4e5f6a7-b8c9-0123-def4-56789012345a",
      "requesterIspb": "12345678",
      "status": 0,
      "statusDescription": "Aberta",
      "updatedAt": "2024-01-01T12:05:00.000Z",
      "analysisDeadline": "2024-01-01T18:00:00.000Z",
      "analysisDetails": "Insufficient balance.",
      "analysisResult": 0,
      "analysisResultDescription": "Aceita Totalmente",
      "details": "Operational failure.",
      "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "refundEndToEndId": "D1234567820240101000000000000099",
      "refundedAmount": 25000,
      "registeredAt": "2021-08-06T10:33:08.241Z",
      "rejectionReason": 0,
      "rejectionReasonDescription": "Falta de saldo"
    }
  ]
}

{
  "code": "<string>",
  "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": "<string>",
  "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": "<string>",
  "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. The role and queue ISPBs name the DIRECT participant, and the indirect participants riding it share its refund requests; indirectId narrows the listing to ONE indirect — only the refund requests over a payment this deployment recorded for that indirect (the payment’s own indirectId, as GET /v1/transactions?indirectId= reads it), never another indirect’s, never one over the direct participant’s own payment, and never one over a payment this deployment did not book. A token confined to one indirect has to name it. A malformed indirectId is 400 PIX-0061; an empty match is a 200 with an empty data array.

GET

med

refunds

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

{
  "data": [
    {
      "breached": false,
      "contestedIspb": "87654321",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "endToEndId": "E1234567820240101000000000000001",
      "reason": 1,
      "reasonDescription": "Fraude",
      "refundAmount": 25000,
      "refundRequestId": "d4e5f6a7-b8c9-0123-def4-56789012345a",
      "requesterIspb": "12345678",
      "status": 0,
      "statusDescription": "Aberta",
      "updatedAt": "2024-01-01T12:05:00.000Z",
      "analysisDeadline": "2024-01-01T18:00:00.000Z",
      "analysisDetails": "Insufficient balance.",
      "analysisResult": 0,
      "analysisResultDescription": "Aceita Totalmente",
      "details": "Operational failure.",
      "infractionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "recoveryId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "refundEndToEndId": "D1234567820240101000000000000099",
      "refundedAmount": 25000,
      "registeredAt": "2021-08-06T10:33:08.241Z",
      "rejectionReason": 0,
      "rejectionReasonDescription": "Falta de saldo"
    }
  ]
}

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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

status

string

Filter on stSolDevolucao (0=open, 1=cancelled, 2=analyzed).

Exemplo:

"0"

contestedIspb

string

Filter on the contested ISPB (refunds requested against this institution).

Exemplo:

"87654321"

requesterIspb

string

Filter on the requester ISPB (refunds this institution requested).

Exemplo:

"12345678"

end_to_end_id

string

Filter on the contested payment's endToEndId.

Exemplo:

"E1234567820240101000000000000001"

indirectId

string<uuid>

The registered indirect participant (UUID) whose refund requests are listed. OPTIONAL: omit it and the listing is not narrowed by indirect. Named, only the refund requests over a payment this deployment recorded for that indirect come back - never another indirect's, never one over a payment of the direct participant itself, and never one over a payment this deployment did not book. A token confined to one indirect has to name it here. Not a valid UUID is 400 PIX-0061.

Exemplo:

"3f2504e0-4f89-41d3-9a0c-0305e82c3301"

Resposta

data

object[] | null

obrigatório

The list of detected refund requests, newest first.

Show child attributes

APIs do participante direto

APIs de participantes indiretos

List MED refund requests

Autorizações

Parâmetros de consulta

Resposta