Skip to main content
POST
Simulate On-Ramp Transaction
Endpoint: POST https://api.rebelfi.io/v1/ramp/org/simulate-transaction
This endpoint is only available in the sandbox environment. It will return an error in production.
Simulate an on-ramp transaction lifecycle to test your integration. The simulation progresses the transaction through the specified scenario’s status sequence.

Request Body

FieldTypeRequiredDescription
scenariostringNoSimulation scenario (default: "success" — options: success, failed, rejected, reversed)
usd_amountnumberNoSimulated USD amount (default: 50000)
onramp_account_idnumberNoOn-ramp account ID to simulate against

Scenarios

ScenarioStatus Progression
successpending -> processing -> in_progress -> broadcasted -> completed
failedpending -> processing -> failed
rejectedpending -> rejected
reversedpending -> processing -> in_progress -> broadcasted -> completed -> reversed

Example Request

Example Response

Response Fields

FieldTypeDescription
successbooleanWhether the simulation was accepted
data.simulation_idstringUnique identifier for the simulation
data.statestringSimulation state (accepted)