Get a refund

Retrieves a MED 2.0 refund by its resource ID (UUID), within the authenticated tenant organization scope. The response includes the Phase 2 settlement fields, which are null until settlement. Returns 404 when no active refund with that ID belongs to the tenant. A refund owned by another tenant produces the same response as an unknown ID.

GET /dict/refunds/{id}

Get a refund

cURL

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

200

{
  "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>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

id · string · requerido

Refund internal ID (UUID format)

Ejemplo:

"018f8c1d-1234-7abc-9def-000000000001"

Respuesta

200

application/json

OK

contestedParticipant · string · requerido

Ejemplo:

"87654321"

creationTime · string<date-time> · requerido

Ejemplo:

"2026-01-01T12:00:00Z"

id · string · requerido

Ejemplo:

"018f8c1d-1234-7abc-9def-000000000001"

lastModified · string<date-time> · requerido

Ejemplo:

"2026-01-01T12:30:00Z"

monitorAccount · boolean · requerido

Ejemplo:

false

refundAmount · string · requerido

Ejemplo:

"1000.00"

refundReason · enum<string> · requerido

Opciones disponibles: FRAUD, OPERATIONAL_FLAW, PIX_AUTOMATICO, REFUND_CANCELLED

Ejemplo:

"OPERATIONAL_FLAW"

requestingParticipant · string · requerido

Ejemplo:

"12345678"

status · enum<string> · requerido

Opciones disponibles: OPEN, CLOSED, CANCELLED

Ejemplo:

"OPEN"

transactionId · string · requerido

Ejemplo:

"E12345678202601011200abcdef01234"

alreadySettledAmount · string

analysisDetails · string

analysisResult · enum<string>

Opciones disponibles: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED

bacenRefundId · string

Ejemplo:

"3d48532f-1a2b-4422-81c3-b7dc852e262b"

correlationId · string

Ejemplo:

"9f3a8b7e2c1d4e5a8b6f1a2b3c4d5e6f"

effectiveRefundedAmount · string

fundsRecoveryId · string

infractionReportId · string

refundAccount · object

Show child attributes

refundDetails · string

Ejemplo:

"refund due to operational failure"

refundRejectionReason · enum<string>

Opciones disponibles: NO_BALANCE, ACCOUNT_CLOSURE, INVALID_REQUEST, OTHER, PARTICIPANT_EXCLUSION

refundTransactionId · string

settleReason · string

settleType · enum<string>

Opciones disponibles: REFUND, MANUAL

surplusAmount · string