Simulate payment failure

Test a charge with a failed payment in the Sandbox.

POSThttps://api.raims.com/v1/simulations/charges/{id}/fail_payment

Simulates payment failure for a charge by ID. Use this request to check how your integration handles an unpaid result.

Sandbox only

Use a key with the sk_test_ prefix. The simulated failure does not affect the balance and is not available in Production.

See Simulation to prepare the charge and understand the conditions for repeating the test.

Path Params

idstringrequired

Public identifier of the charge created in your company Sandbox.

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/charges/%7Bid%7D/fail_payment \
  --header 'accept: application/json'

Response

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

application/json