Skip to main content
GET
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Refund internal ID (UUID format)

Exemplo:

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

Resposta

OK

contestedParticipant
string
obrigatório
Exemplo:

"87654321"

creationTime
string<date-time>
obrigatório
Exemplo:

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

id
string
obrigatório
Exemplo:

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

lastModified
string<date-time>
obrigatório
Exemplo:

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

monitorAccount
boolean
obrigatório
Exemplo:

false

refundAmount
string
obrigatório
Exemplo:

"1000.00"

refundReason
enum<string>
obrigatório
Opções disponíveis:
FRAUD,
OPERATIONAL_FLAW,
PIX_AUTOMATICO,
REFUND_CANCELLED
Exemplo:

"OPERATIONAL_FLAW"

requestingParticipant
string
obrigatório
Exemplo:

"12345678"

status
enum<string>
obrigatório
Opções disponíveis:
OPEN,
CLOSED,
CANCELLED
Exemplo:

"OPEN"

transactionId
string
obrigatório
Exemplo:

"E12345678202601011200abcdef01234"

alreadySettledAmount
string
analysisDetails
string
analysisResult
enum<string>
Opções disponíveis:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
bacenRefundId
string
Exemplo:

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

correlationId
string
Exemplo:

"9f3a8b7e2c1d4e5a8b6f1a2b3c4d5e6f"

effectiveRefundedAmount
string
fundsRecoveryId
string
infractionReportId
string
refundAccount
object
refundDetails
string
Exemplo:

"refund due to operational failure"

refundRejectionReason
enum<string>
Opções disponíveis:
NO_BALANCE,
ACCOUNT_CLOSURE,
INVALID_REQUEST,
OTHER,
PARTICIPANT_EXCLUSION
refundTransactionId
string
settleReason
string
settleType
enum<string>
Opções disponíveis:
REFUND,
MANUAL
surplusAmount
string