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 key with the sk_test_ prefix. The simulated failure is not available in Production.

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

Path Params

idstringrequired

Test refund identifier returned by Simulate a pending refund.

Up to 100 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request POST \
  --url https://api.raims.com/v1/simulations/refunds/%7Bid%7D/fail \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Simulate refund failure

Path Params

Responses

200OK

400Bad Request

403Forbidden

404Not Found

409Conflict