Close a Refund Request
Use this endpoint to provide the closure decision and outcome for a refund request.
Notes:
- This operation is typically triggered by BACEN’s analysis completion.
- Closing a request sets its status to CLOSED and records the analysis result.
- For accepted refunds, a refund transaction ID is recorded.
- Once closed, the request cannot be modified.
Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de caminho
Refund Request ID (UUID format)
Corpo
Amount effectively refunded in BRL (format: 0.00 to 9999999999.99). May differ from the requested amount for PARTIALLY_ACCEPTED
1"50.25"
Analysis result
TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED 1"TOTALLY_ACCEPTED"
Analysis comments. Max 2000 characters. Required if result is REJECTED and rejection reason is INVALID_REQUEST
2000"Analysis confirms fraud. Refund approved."
Rejection reason. Required if result is REJECTED
NO_BALANCE, ACCOUNT_CLOSURE, INVALID_REQUEST, OTHER, "NO_BALANCE"
Transaction ID for executing refund. Required if result is TOTALLY_ACCEPTED or PARTIALLY_ACCEPTED
"E98765432202411241500REFUNDTRANS"
Resposta
OK
Account ID (UUID)
"550e8400-e29b-41d4-a716-446655440000"
BACEN/BTG refund request external identifier
"3d48532f-a1b2-4422-81c3-b7dc852e262b"
ISPB of the contested participant (8 uppercase alphanumeric characters)
"12345678"
Creation timestamp (ISO 8601 UTC)
"2024-01-15T10:30:00Z"
Unique identifier of the refund request (UUID)
"550e8400-e29b-41d4-a716-44665544r001"
Refund amount in BRL (format: 0.00)
"100.50"
Reason for the refund
FRAUD, OPERATIONAL_FLAW, REFUND_CANCELLED "FRAUD"
ISPB of the requesting participant (8 uppercase alphanumeric characters)
"30306294"
Current status of the refund request
OPEN, CLOSED, CANCELLED "OPEN"
Pix End-to-End transaction ID (32 characters)
"E12345678202411241430ABCDEFGHIJK"
Last update timestamp (ISO 8601 UTC)
"2024-01-15T10:30:00Z"
Analysis comments (max 2000 characters)
"Analysis confirms fraud. Refund approved."
Analysis result (if closed)
TOTALLY_ACCEPTED, PARTIALLY_ACCEPTED, REJECTED "TOTALLY_ACCEPTED"
BACEN/BTG funds-recovery identifier resolved via the associated infraction report (read-only, JOIN-derived)
"91d65e98-97c0-4b0f-b577-73625da1f9fc"
Amount effectively refunded in BRL
"100.00"
Related infraction report ID (UUID)
"550e8400-e29b-41d4-a716-44665544f001"
BACEN flag for account monitoring
true
Refund destination account details
Detailed justification (max 2000 characters)
"Customer reports unauthorized transaction"
Rejection reason (if rejected)
NO_BALANCE, ACCOUNT_CLOSURE, INVALID_REQUEST, OTHER "NO_BALANCE"
Refund transaction ID (if accepted, 32 characters)
"E98765432202411241500REFUNDTRANS"

