API
Checking Raims account

Simulate refund failure

Test failure of a pending Pix refund in the Sandbox.

POSThttps://api.raims.com/v1/simulations/refunds/{id}/fail

Simulates failure of a pending Pix refund without completing the refund. Use this request to check the failure reason and the release of the amount back to the available balance.

Sandbox only

Use a Sandbox key or an OAuth connection with Sandbox access. The simulated failure is not available in Production.

See Pending and failed Pix refunds to prepare the test and track its results.

Path Params

Test refund identifier returned by Simulate a pending refund.

Up to 100 characters

Headers

Unique key chosen by your system to identify this request. When retrying, send the same key and parameters. Without this header, the request is processed normally. See the idempotency guide for retention and handling pending or uncertain responses.

1 to 255 characters

Responses

For common errors, see HTTP response codes.