Skip to main content
POST
/
v1
/
ramp
/
org
/
simulate-offramp-transaction
Simulate Off-Ramp Transaction
curl --request POST \
  --url https://api.example.com/v1/ramp/org/simulate-offramp-transaction

Documentation Index

Fetch the complete documentation index at: https://docs.rebelfi.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint: POST https://api.rebelfi.io/v1/ramp/org/simulate-offramp-transaction
This endpoint is only available in the sandbox environment. It will return an error in production.
Simulate an off-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)
usd_amountnumberNoSimulated USD amount (default: 50000)
offramp_account_idnumberNoOff-ramp account ID to simulate against

​
Example Request

curl -X POST "https://api.rebelfi.io/v1/ramp/org/simulate-offramp-transaction" \
  -H "x-api-key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario": "success",
    "usd_amount": 25000,
    "offramp_account_id": 1
  }'

​
Example Response

{
  "success": true,
  "data": {
    "simulation_id": "sim_x1y2z3",
    "state": "accepted"
  }
}

​
Response Fields

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