Refund
ThePOST /transactions/{transactionId}/refund operation refunds a paid transaction in full. The amount is returned to the payer through the same payment method used, and the account balance is adjusted accordingly.
- the transaction must be in the
paidstatus - the refund always covers the full amount of the transaction
- transactions paid by boleto cannot be refunded by the platform
refund status, and the transaction_refunded event is notified.
Refund request
A request submitted by the payer enters a queue for decision, and therefund_requested event is notified. The GET /refund-requests operation lists the requests, filtered by status, refund channel and period.
Decision
The request is decided through thePOST /refund-requests/{refundRequestId}/approve and POST /refund-requests/{refundRequestId}/reject operations. Only requests in the pending status may be decided. On rejection, recording an objective justification in the reason field is recommended.
Approval on expiry of the deadline
When a deadline is running, theautoApproveAt field states the time at which the platform will approve the request in the absence of a decision. The field is returned as null when no deadline is running.
Refund channel
On approval, therefundChannel field states how the return is executed.