Complete a simulated refund

Confirm a pending test Pix refund.

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

Completes a Pix refund started with Simulate a pending refund. Provide the refund ID to check the completed result and its receipt.

Sandbox only

Use a key with the sk_test_ prefix. Completion does not move real money and 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

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/complete \
  --header 'accept: application/json'

Response

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

application/json