Skip to main content
POST
/
payment
/
register
/
intents-create-order
curl --request POST \
  --url https://api.starkfi.io/payment/register/intents-create-order \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "tenant_data": {
      "public_client_id": "cmngy66mw0000e6y0uowcbxgf",
      "webhook_url": "https://webhook.site/97b5142a-1cb7-4142-8306-3d98a93e9a79"
    },
    "payment_method_allowed": {
      "pixcrypto": true,
      "cardcrypto": true,
      "cardfiat": true,
      "cryptopix": true,
      "crypto": true
    },
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "gateway_method": "direct",
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "to_currency_symbol": "USDT",
    "to_chain": "arbitrum",
    "on_ramp": false
  }'

{
  "statusCode": 201,
  "success": true,
  "status": "payment_registered",
  "message": "Payment has been registered",
  "data": {
    "payment_id": "cmodpory6000001nyoe3d12m1"
  }
}
​
x-api-key
string
required
Your StarkFi API key. You can find it in your dashboard.
​
executor_id
string
required
Transaction executor type. Use api_transaction when the request comes via API.
​
tenant_data
object
required
Tenant configuration object.
​
payment_method_allowed
object
required
Object defining which payment methods are enabled for this order.
​
split_payment_config
array
required
List of receivers for payment splitting. Percentages must add up to 100.
​
gateway_method
enum<string>
required
Gateway processing method. Available options: direct, subs
  • direct — one-time direct payment processing
  • subs — subscription-based recurring payments
​
from_currency_symbol
string
required
Source currency code (e.g. BRL).
​
amount_from
string
required
Amount to be converted from the source currency (e.g. "30").
​
to_currency_symbol
string
required
Target currency code (e.g. USDT).
​
to_chain
string
required
Destination blockchain network where you wish to receive the selected currency (e.g. arbitrum, solana).
​
on_ramp
boolean
required
Set true for on-ramp flow, false for off-ramp.
The on-ramp feature is not available for receiving payments via PIX. It can only be used for user-initiated payments. All requests related to incoming payments must set on_ramp: false.
curl --request POST \
  --url https://api.starkfi.io/payment/register/intents-create-order \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api_key>' \
  --data '{
    "executor_id": "api_transaction",
    "tenant_data": {
      "public_client_id": "cmngy66mw0000e6y0uowcbxgf",
      "webhook_url": "https://webhook.site/97b5142a-1cb7-4142-8306-3d98a93e9a79"
    },
    "payment_method_allowed": {
      "pixcrypto": true,
      "cardcrypto": true,
      "cardfiat": true,
      "cryptopix": true,
      "crypto": true
    },
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "gateway_method": "direct",
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "to_currency_symbol": "USDT",
    "to_chain": "arbitrum",
    "on_ramp": false
  }'

{
  "statusCode": 201,
  "success": true,
  "status": "payment_registered",
  "message": "Payment has been registered",
  "data": {
    "payment_id": "cmodpory6000001nyoe3d12m1"
  }
}

​
Response

​
statusCode
number
required
HTTP status code. Returns 201 on successful registration.
​
success
boolean
required
Whether the request succeeded.
​
status
string
required
Status label for the response (e.g. payment_registered).
​
message
string
required
Human-readable response message.
​
data
object
required
Response payload.