Simulate a pending refund
Start a test Pix refund and choose its result later.
POSThttps://api.raims.com/v1/simulations/charges/{id}/refunds
Starts a test Pix refund that awaits confirmation. Use the returned ID to complete the refund or simulate a failure in another request.
Sandbox only
Use a key with the sk_test_ prefix. The refund is simulated and does not
move real money.
Check the conditions and balance effects in Pending and failed Pix refunds.
Path Params
Identifier of the charge that received the Pix payment.
Up to 100 characters
Body Params
Amount requested for a refund, in Brazilian real cents. To refund the full amount, provide the remaining amount shown in the eligibility query.
Minimum 1
Refund request description. You can leave this field empty.
Up to 200 characters
Responses
For common errors, see HTTP response codes.