Skip to main content
POST
string
required
Your StarkFi API key. You can find it in your dashboard.
string
required
Caller identifier for this template (e.g. api_transaction).
string
required
Source fiat symbol enabled for your account (validated server-side), e.g. BRL, USD.
string
required
Amount in the source currency (decimal string), e.g. "100.00".
string
required
Destination crypto symbol, e.g. USDT, USDC.
boolean
required
Whether this order represents an on-ramp flow.
enum<string>
required
Processing mode: direct (one-off) or subs (subscription-capable template).
object
Optional flags; when provided, at least one must be true: crypto, pixcrypto, cardcrypto, cardfiat, cryptofiat.
array
Optional line items.
array
Optional split configuration.
object
Optional subscription defaults.

Response

number
required
HTTP status mirrored in the body (200 on success).
boolean
required
Whether the request succeeded.
string
required
Machine-readable code, e.g. order_created.
string
required
Human-readable message.
object
Present on success.