Create order

Create a reusable payment order template for the authenticated tenant (maximum 20 orders).

POST /order/create

cURL

curl --request POST \
  --url https://api.starknode.io/order/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "payment_method_allowed": {
      "crypto": true,
      "pixcrypto": true
    }
  }'

200 - Success

{
  "statusCode": 200,
  "success": true,
  "status": "order_created",
  "message": "Order created successfully.",
  "data": {
    "order_id": "clxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

x-api-key · string · required

Your StarkNode API key. You can find it in your dashboard.

executor_id · string · required

Caller identifier for this template (e.g. api_transaction).

from_currency_symbol · string · required

Source fiat symbol enabled for your account (validated server-side), e.g. BRL, USD.

amount_from · string · required

Amount in the source currency (decimal string), e.g. "100.00".

to_currency_symbol · string · required

Destination crypto symbol, e.g. USDT, USDC.

on_ramp · boolean · required

Whether this order represents an on-ramp flow.

gateway_method · enum<string> · required

Processing mode: direct (one-off) or subs (subscription-capable template).

payment_method_allowed · object

Optional flags; when provided, at least one must be true: crypto, pixcrypto, cardcrypto, cardfiat, cryptofiat.

Show payment_method_allowed

crypto · boolean

Crypto checkout enabled.

pixcrypto · boolean

PIX → crypto enabled.

cardcrypto · boolean

Card → crypto enabled.

cardfiat · boolean

Card → fiat enabled.

cryptofiat · boolean

Crypto → fiat enabled.

order_items · array

Optional line items.

Show order_items[]

name · string · required

Item name.

quantity · number · required

Positive integer quantity.

description · string

Optional description.

image_url · string

Optional image URL.

split_payment_config · array

Optional split configuration.

Show split_payment_config[]

receiver_wallet · string

Wallet receiving a share.

receiver_percent · number

Percentage 0–100.

recipient_id · string

Optional Pagarme recipient id.

liable · boolean

Split liability flag.

charge_processing_fee · boolean

Charge processing fee on this leg.

subscription_payment_config · object

Optional subscription defaults.

Show subscription_payment_config

plan_name · string · required

Plan identifier.

interval · string · required

weekly, monthly, or yearly.

next_payment_at · number

Optional Unix timestamp for next charge.

charge · boolean

Whether to charge immediately (default false).

retry_count · number

Retry count (default 0).

cURL

curl --request POST \
  --url https://api.starknode.io/order/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "from_currency_symbol": "BRL",
    "amount_from": "100.00",
    "to_currency_symbol": "USDT",
    "on_ramp": false,
    "gateway_method": "direct",
    "payment_method_allowed": {
      "crypto": true,
      "pixcrypto": true
    }
  }'

200 - Success

{
  "statusCode": 200,
  "success": true,
  "status": "order_created",
  "message": "Order created successfully.",
  "data": {
    "order_id": "clxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Response

statusCode · number · required

HTTP status mirrored in the body (200 on success).

success · boolean · required

Whether the request succeeded.

status · string · required

Machine-readable code, e.g. order_created.

message · string · required

Human-readable message.

data · object

Present on success.

Show data

order_id · string · required

CUID of the new payment_orders row. A payment_session_link is stored on the order by the server.