Skip to main content
PATCH
/
order
/
{order_id}
curl --request PATCH \
  --url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{"amount_from": "150.00"}'

{
  "statusCode": 200,
  "success": true,
  "status": "order_updated",
  "message": "Order updated successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "amount_from": "150.00"
  }
}
​
x-api-key
string
required
Your StarkFi API key. You can find it in your dashboard.
​
order_id
string
required
Order CUID to update.
​
from_currency_symbol
string
When present, must pass enabled-fiat validation.
​
amount_from
string
​
to_currency_symbol
string
​
on_ramp
boolean
​
gateway_method
enum<string>
direct or subs.
​
executor_id
string
​
payment_method_allowed
object
Same shape as create order; at least one true when the object is sent.
​
order_items
array
Partial items merged by index with existing order_items.
​
split_payment_config
array
Merged by index with existing split config.
​
subscription_payment_config
object
Shallow-merged with the stored subscription object.
curl --request PATCH \
  --url https://api.starkfi.io/order/clxxxxxxxxxxxxxxxxxxxxxxxx \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{"amount_from": "150.00"}'

{
  "statusCode": 200,
  "success": true,
  "status": "order_updated",
  "message": "Order updated successfully.",
  "data": {
    "id": "clxxxxxxxxxxxxxxxxxxxxxxxx",
    "amount_from": "150.00"
  }
}

​
Response

​
data
object
required
Full updated payment_orders row.