Saltar al contenido principal
GET
Retrieve a Refund Request

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

refund_id
string<uuid>
requerido

Refund Request ID (UUID format)

Respuesta

OK

accountId
string
requerido

Account ID (UUID)

Ejemplo:

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

bacenRefundRequestId
string
requerido

BACEN/BTG refund request external identifier

Ejemplo:

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

contestedParticipant
string
requerido

ISPB of the contested participant (8 uppercase alphanumeric characters)

Ejemplo:

"12345678"

createdAt
string<date-time>
requerido

Creation timestamp (ISO 8601 UTC)

Ejemplo:

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

id
string
requerido

Unique identifier of the refund request (UUID)

Ejemplo:

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

refundAmount
string
requerido

Refund amount in BRL (format: 0.00)

Ejemplo:

"100.50"

refundReason
enum<string>
requerido

Reason for the refund

Opciones disponibles:
FRAUD,
OPERATIONAL_FLAW,
REFUND_CANCELLED
Ejemplo:

"FRAUD"

requestingParticipant
string
requerido

ISPB of the requesting participant (8 uppercase alphanumeric characters)

Ejemplo:

"30306294"

status
enum<string>
requerido

Current status of the refund request

Opciones disponibles:
OPEN,
CLOSED,
CANCELLED
Ejemplo:

"OPEN"

transactionId
string
requerido

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

Ejemplo:

"E12345678202411241430ABCDEFGHIJK"

updatedAt
string<date-time>
requerido

Last update timestamp (ISO 8601 UTC)

Ejemplo:

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

analysisDetails
string

Analysis comments (max 2000 characters)

Ejemplo:

"Analysis confirms fraud. Refund approved."

analysisResult
enum<string>

Analysis result (if closed)

Opciones disponibles:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
Ejemplo:

"TOTALLY_ACCEPTED"

bacenFundsRecoveryId
string

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

Ejemplo:

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

effectiveRefundedAmount
string

Amount effectively refunded in BRL

Ejemplo:

"100.00"

infractionReportId
string

Related infraction report ID (UUID)

Ejemplo:

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

monitorAccount
boolean

BACEN flag for account monitoring

Ejemplo:

true

refundAccount
object

Refund destination account details

refundDetails
string

Detailed justification (max 2000 characters)

Ejemplo:

"Customer reports unauthorized transaction"

refundRejectionReason
enum<string>

Rejection reason (if rejected)

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

"NO_BALANCE"

refundTransactionId
string

Refund transaction ID (if accepted, 32 characters)

Ejemplo:

"E98765432202411241500REFUNDTRANS"