Pular para o conteúdo principal
POST
Close a Refund Request

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)

Corpo

application/json
effectiveRefundedAmount
string
obrigatório

Amount effectively refunded in BRL (format: 0.00 to 9999999999.99). May differ from the requested amount for PARTIALLY_ACCEPTED

Minimum string length: 1
Exemplo:

"50.25"

refundAnalysisResult
enum<string>
obrigatório

Analysis result

Opções disponíveis:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
Minimum string length: 1
Exemplo:

"TOTALLY_ACCEPTED"

refundAnalysisDetails
string

Analysis comments. Max 2000 characters. Required if result is REJECTED and rejection reason is INVALID_REQUEST

Maximum string length: 2000
Exemplo:

"Analysis confirms fraud. Refund approved."

refundRejectionReason
enum<string>

Rejection reason. Required if result is REJECTED

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

"NO_BALANCE"

refundTransactionId
string

Transaction ID for executing refund. Required if result is TOTALLY_ACCEPTED or PARTIALLY_ACCEPTED

Exemplo:

"E98765432202411241500REFUNDTRANS"

Resposta

OK

accountId
string
obrigatório

Account ID (UUID)

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

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"