List refunds

Returns a paginated list of MED 2.0 Refunds (devoluções) owned by the requesting tenant’s organization, newest first by default. Filtering is always scoped to the tenant organization resolved from the authenticated context. requesting_participant / contested_participant are optional accessory filters, not tenant boundaries. status, refund_reason, and sort_order are case-insensitive.

GET /dict/refunds

List refunds

cURL

curl --request GET \
  --url https://api.example.com/dict-hub/v1/dict/refunds \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": false,
  "items": [
    {
      "contestedParticipant": "87654321",
      "creationTime": "2026-01-01T12:00:00Z",
      "id": "018f8c1d-1234-7abc-9def-000000000001",
      "lastModified": "2026-01-01T12:30:00Z",
      "monitorAccount": false,
      "refundAmount": "1000.00",
      "refundReason": "OPERATIONAL_FLAW",
      "requestingParticipant": "12345678",
      "status": "OPEN",
      "transactionId": "E12345678202601011200abcdef01234",
      "alreadySettledAmount": "<string>",
      "analysisDetails": "<string>",
      "analysisResult": "TOTALLY_ACCEPTED",
      "bacenRefundId": "3d48532f-1a2b-4422-81c3-b7dc852e262b",
      "correlationId": "9f3a8b7e2c1d4e5a8b6f1a2b3c4d5e6f",
      "effectiveRefundedAmount": "<string>",
      "fundsRecoveryId": "<string>",
      "infractionReportId": "<string>",
      "refundAccount": {
        "accountNumber": "123456",
        "accountType": "CACC",
        "branch": "0001",
        "participant": "99999011",
        "taxIdNumber": "12345678909"
      },
      "refundDetails": "refund due to operational failure",
      "refundRejectionReason": "NO_BALANCE",
      "refundTransactionId": "<string>",
      "settleReason": "<string>",
      "settleType": "REFUND",
      "surplusAmount": "<string>"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 1
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

status · string

Filter by lifecycle status (case-insensitive)

Ejemplo:

"OPEN"

refund_reason · string

Filter by refund reason (case-insensitive)

Ejemplo:

"FRAUD"

transaction_id · string

Filter by the contested transaction end-to-end ID (32 chars)

Ejemplo:

"E12345678202601011200abcdef01234"

infraction_report_id · string

Filter by the linked infraction report UUID

Ejemplo:

"c3d4e5f6-a7b8-4901-abcd-34567890abcd"

requesting_participant · string

Filter by the requesting participant ISPB (8 characters, uppercase alphanumeric)

Required string length: 8

Pattern: ^[A-Z0-9]{8}$

Ejemplo:

"12345678"

contested_participant · string

Filter by the contested participant ISPB (8 characters, uppercase alphanumeric)

Required string length: 8

Pattern: ^[A-Z0-9]{8}$

Ejemplo:

"87654321"

page · string

Page number (default: 1, minimum: 1)

Ejemplo:

"1"

limit · string

Maximum number of items per page (default: 10, max: 100)

Ejemplo:

"10"

sort_order · string

Sort direction by last_modified (default: desc, case-insensitive)

Ejemplo:

"desc"

Respuesta

200

application/json

OK

hasMore · boolean · requerido

Ejemplo:

false

items · object[] | null · requerido

Show child attributes

limit · integer<int64> · requerido

Ejemplo:

10

page · integer<int64> · requerido

Ejemplo:

1

total · integer<int64> · requerido

Ejemplo:

1