Skip to main content
POST
/
autoramp-flow
/
create
Create a new autoramp flow
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/autoramp-flow/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "ONRAMP",
  "from": "67890",
  "to": "54321"
}
'
{
  "status": "SUCCESS",
  "data": {
    "id": "uuid-12345"
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
type
enum<string>
required

Flow type

Available options:
ONRAMP,
OFFRAMP
Example:

"ONRAMP"

​
from
string
required

Deposit address ID for offramp, Virtual account ID for onramp

Example:

"67890"

​
to
string
required

Bank Account ID for offramp, Crypto Address ID for onramp

Example:

"54321"

Response

Create autoramp flow successful

​
status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

​
data
object
required

Response data