Retrieve a Refund Request

Use this endpoint to retrieve the details of a specific refund request.

GET /v1/dict/refund-requests/{refund_id}

Retrieve a Refund Request

cURL

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

200

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "bacenRefundRequestId": "3d48532f-a1b2-4422-81c3-b7dc852e262b",
  "contestedParticipant": "12345678",
  "createdAt": "2024-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-44665544r001",
  "refundAmount": "100.50",
  "refundReason": "FRAUD",
  "requestingParticipant": "30306294",
  "status": "OPEN",
  "transactionId": "E12345678202411241430ABCDEFGHIJK",
  "updatedAt": "2024-01-15T10:30:00Z",
  "analysisDetails": "Analysis confirms fraud. Refund approved.",
  "analysisResult": "TOTALLY_ACCEPTED",
  "bacenFundsRecoveryId": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
  "effectiveRefundedAmount": "100.00",
  "infractionReportId": "550e8400-e29b-41d4-a716-44665544f001",
  "monitorAccount": true,
  "refundAccount": {
    "accountNumber": "123456",
    "accountType": "CACC",
    "branch": "0001",
    "document": "12345678909",
    "participant": "99999011"
  },
  "refundDetails": "Customer reports unauthorized transaction",
  "refundRejectionReason": "NO_BALANCE",
  "refundTransactionId": "E98765432202411241500REFUNDTRANS"
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

refund_id · string<uuid> · obrigatório

Refund Request ID (UUID format)

Resposta

200

application/json

OK

accountId · string · obrigatório

Account ID (UUID) of the contested Pix transfer when the request arrived through BTG; empty when it was opened through this API or the plugin could not resolve the contested transfer

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

bacenRefundRequestId · string · obrigatório

BACEN/BTG refund request external identifier

Exemplo:

"3d48532f-a1b2-4422-81c3-b7dc852e262b"

contestedParticipant · string · obrigatório

ISPB of the contested participant (8 uppercase alphanumeric characters)

Exemplo:

"12345678"

createdAt · string<date-time> · obrigatório

Creation timestamp (ISO 8601 UTC)

Exemplo:

"2024-01-15T10:30:00Z"

id · string · obrigatório

Unique identifier of the refund request (UUID)

Exemplo:

"550e8400-e29b-41d4-a716-44665544r001"

refundAmount · string · obrigatório

Refund amount in BRL (format: 0.00)

Exemplo:

"100.50"

refundReason · enum<string> · obrigatório

Reason for the refund

Opções disponíveis: FRAUD, OPERATIONAL_FLAW, REFUND_CANCELLED

Exemplo:

"FRAUD"

requestingParticipant · string · obrigatório

ISPB of the requesting participant (8 uppercase alphanumeric characters)

Exemplo:

"30306294"

status · enum<string> · obrigatório

Current status of the refund request

Opções disponíveis: OPEN, CLOSED, CANCELLED

Exemplo:

"OPEN"

transactionId · string · obrigatório

Pix End-to-End transaction ID (32 characters)

Exemplo:

"E12345678202411241430ABCDEFGHIJK"

updatedAt · string<date-time> · obrigatório

Last update timestamp (ISO 8601 UTC)

Exemplo:

"2024-01-15T10:30:00Z"

analysisDetails · string

Analysis comments (max 2000 characters)

Exemplo:

"Analysis confirms fraud. Refund approved."

analysisResult · enum<string>

Analysis result (if closed)

Opções disponíveis: TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED

Exemplo:

"TOTALLY_ACCEPTED"

bacenFundsRecoveryId · string

BACEN/BTG funds-recovery identifier resolved via the associated infraction report (read-only, JOIN-derived)

Exemplo:

"91d65e98-97c0-4b0f-b577-73625da1f9fc"

effectiveRefundedAmount · string

Amount effectively refunded in BRL

Exemplo:

"100.00"

infractionReportId · string

Related infraction report ID (UUID)

Exemplo:

"550e8400-e29b-41d4-a716-44665544f001"

monitorAccount · boolean

BACEN flag for account monitoring

Exemplo:

true

refundAccount · object

Refund destination account details

Show child attributes

refundDetails · string

Detailed justification (max 2000 characters)

Exemplo:

"Customer reports unauthorized transaction"

refundRejectionReason · enum<string>

Rejection reason (if rejected)

Opções disponíveis: NO_BALANCE, ACCOUNT_CLOSURE, INVALID_REQUEST, OTHER

Exemplo:

"NO_BALANCE"

refundTransactionId · string

Refund transaction ID (if accepted, 32 characters)

Exemplo:

"E98765432202411241500REFUNDTRANS"