Skip to main content
POST
/
autoramp-flow
/
offramp
Create an OFFRAMP flow with deposit address
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/autoramp-flow/offramp \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "from": {
    "customerId": "6ac34182-aa2e-4290-ab1b-302a09f451d1",
    "currency": "USDT",
    "network": "ETH"
  },
  "to": "54321"
}
'
{
  "status": "SUCCESS",
  "data": {
    "id": "uuid-12345"
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
from
object
required

OFFRAMP flow "from": deposit address creation parameters (will be created if not exist)

​
to
string
required

OFFRAMP flow "to": bank account ID (funds exit)

Example:

"54321"

Response

Create autoramp flow successful

​
status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

​
data
object
required

Response data